mirror of
https://github.com/LukeHagar/plexjava.git
synced 2025-12-06 20:47:45 +00:00
Compare commits
5 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
84fb18428a | ||
|
|
37569715a6 | ||
|
|
c0e915da8b | ||
|
|
0077561a6a | ||
|
|
4b28ca3416 |
2
.gitignore
vendored
2
.gitignore
vendored
@@ -1,3 +1,5 @@
|
|||||||
|
**/.speakeasy/temp/
|
||||||
|
**/.speakeasy/logs/
|
||||||
.speakeasy/reports
|
.speakeasy/reports
|
||||||
# Ignore Gradle project-specific cache directory
|
# Ignore Gradle project-specific cache directory
|
||||||
.gradle
|
.gradle
|
||||||
|
|||||||
File diff suppressed because one or more lines are too long
@@ -4,6 +4,7 @@ generation:
|
|||||||
maintainOpenAPIOrder: true
|
maintainOpenAPIOrder: true
|
||||||
usageSnippets:
|
usageSnippets:
|
||||||
optionalPropertyRendering: withExample
|
optionalPropertyRendering: withExample
|
||||||
|
sdkInitStyle: constructor
|
||||||
useClassNamesForArrayFields: true
|
useClassNamesForArrayFields: true
|
||||||
fixes:
|
fixes:
|
||||||
nameResolutionDec2023: true
|
nameResolutionDec2023: true
|
||||||
@@ -11,11 +12,12 @@ generation:
|
|||||||
parameterOrderingFeb2024: true
|
parameterOrderingFeb2024: true
|
||||||
requestResponseComponentNamesFeb2024: true
|
requestResponseComponentNamesFeb2024: true
|
||||||
securityFeb2025: false
|
securityFeb2025: false
|
||||||
|
sharedErrorComponentsApr2025: false
|
||||||
auth:
|
auth:
|
||||||
oAuth2ClientCredentialsEnabled: true
|
oAuth2ClientCredentialsEnabled: true
|
||||||
oAuth2PasswordEnabled: false
|
oAuth2PasswordEnabled: false
|
||||||
java:
|
java:
|
||||||
version: 0.14.2
|
version: 0.17.0
|
||||||
additionalDependencies: []
|
additionalDependencies: []
|
||||||
additionalPlugins: []
|
additionalPlugins: []
|
||||||
artifactID: plexapi
|
artifactID: plexapi
|
||||||
|
|||||||
@@ -1,4 +1,4 @@
|
|||||||
speakeasyVersion: 1.529.1
|
speakeasyVersion: 1.555.2
|
||||||
sources:
|
sources:
|
||||||
my-source:
|
my-source:
|
||||||
sourceNamespace: my-source
|
sourceNamespace: my-source
|
||||||
@@ -8,19 +8,19 @@ sources:
|
|||||||
- latest
|
- latest
|
||||||
plexapi:
|
plexapi:
|
||||||
sourceNamespace: plexapi
|
sourceNamespace: plexapi
|
||||||
sourceRevisionDigest: sha256:ea508e3da23b283f47aeb4384d6b3ab374a27bdffb8d8d8376cedbad3ad77a06
|
sourceRevisionDigest: sha256:78d07ad78ff60d0e9918696208d8c68a562e170d4e9c431797c02995fb8816d0
|
||||||
sourceBlobDigest: sha256:c210adbd02b0213b9e6f95ffc27f60ec38f8f9040137d55ccf2b650d92ab0ff5
|
sourceBlobDigest: sha256:d38dd2a36c1b2fd73409267f7b30c2d5d45d709616141803ea01db424ec68ae4
|
||||||
tags:
|
tags:
|
||||||
- latest
|
- latest
|
||||||
- speakeasy-sdk-regen-1743899436
|
- speakeasy-sdk-regen-1748997072
|
||||||
targets:
|
targets:
|
||||||
plexjava:
|
plexjava:
|
||||||
source: plexapi
|
source: plexapi
|
||||||
sourceNamespace: plexapi
|
sourceNamespace: plexapi
|
||||||
sourceRevisionDigest: sha256:ea508e3da23b283f47aeb4384d6b3ab374a27bdffb8d8d8376cedbad3ad77a06
|
sourceRevisionDigest: sha256:78d07ad78ff60d0e9918696208d8c68a562e170d4e9c431797c02995fb8816d0
|
||||||
sourceBlobDigest: sha256:c210adbd02b0213b9e6f95ffc27f60ec38f8f9040137d55ccf2b650d92ab0ff5
|
sourceBlobDigest: sha256:d38dd2a36c1b2fd73409267f7b30c2d5d45d709616141803ea01db424ec68ae4
|
||||||
codeSamplesNamespace: code-samples-java-plexjava
|
codeSamplesNamespace: code-samples-java-plexjava
|
||||||
codeSamplesRevisionDigest: sha256:c7bc64aee5441f09dae1f6b15a89c94f6b6065f2e25f5528e849e5ddf2f50d8c
|
codeSamplesRevisionDigest: sha256:2028a8fe95bd6176b8c2ff3a498715a0be7cb00919f7a1e7975778292621dce5
|
||||||
workflow:
|
workflow:
|
||||||
workflowVersion: 1.0.0
|
workflowVersion: 1.0.0
|
||||||
speakeasyVersion: latest
|
speakeasyVersion: latest
|
||||||
|
|||||||
33
README.md
33
README.md
@@ -69,7 +69,7 @@ The samples below show how a published SDK artifact is used:
|
|||||||
|
|
||||||
Gradle:
|
Gradle:
|
||||||
```groovy
|
```groovy
|
||||||
implementation 'dev.plexapi:plexapi:0.14.2'
|
implementation 'dev.plexapi:plexapi:0.17.0'
|
||||||
```
|
```
|
||||||
|
|
||||||
Maven:
|
Maven:
|
||||||
@@ -77,7 +77,7 @@ Maven:
|
|||||||
<dependency>
|
<dependency>
|
||||||
<groupId>dev.plexapi</groupId>
|
<groupId>dev.plexapi</groupId>
|
||||||
<artifactId>plexapi</artifactId>
|
<artifactId>plexapi</artifactId>
|
||||||
<version>0.14.2</version>
|
<version>0.17.0</version>
|
||||||
</dependency>
|
</dependency>
|
||||||
```
|
```
|
||||||
|
|
||||||
@@ -94,6 +94,29 @@ On Windows:
|
|||||||
```bash
|
```bash
|
||||||
gradlew.bat publishToMavenLocal -Pskip.signing
|
gradlew.bat publishToMavenLocal -Pskip.signing
|
||||||
```
|
```
|
||||||
|
|
||||||
|
### Logging
|
||||||
|
A logging framework/facade has not yet been adopted but is under consideration.
|
||||||
|
|
||||||
|
For request and response logging (especially json bodies) use:
|
||||||
|
```java
|
||||||
|
SpeakeasyHTTPClient.setDebugLogging(true); // experimental API only (may change without warning)
|
||||||
|
```
|
||||||
|
Example output:
|
||||||
|
```
|
||||||
|
Sending request: http://localhost:35123/bearer#global GET
|
||||||
|
Request headers: {Accept=[application/json], Authorization=[******], Client-Level-Header=[added by client], Idempotency-Key=[some-key], x-speakeasy-user-agent=[speakeasy-sdk/java 0.0.1 internal 0.1.0 org.openapis.openapi]}
|
||||||
|
Received response: (GET http://localhost:35123/bearer#global) 200
|
||||||
|
Response headers: {access-control-allow-credentials=[true], access-control-allow-origin=[*], connection=[keep-alive], content-length=[50], content-type=[application/json], date=[Wed, 09 Apr 2025 01:43:29 GMT], server=[gunicorn/19.9.0]}
|
||||||
|
Response body:
|
||||||
|
{
|
||||||
|
"authenticated": true,
|
||||||
|
"token": "global"
|
||||||
|
}
|
||||||
|
```
|
||||||
|
WARNING: This should only used for temporary debugging purposes. Leaving this option on in a production system could expose credentials/secrets in logs. <i>Authorization</i> headers are redacted by default and there is the ability to specify redacted header names via `SpeakeasyHTTPClient.setRedactedHeaders`.
|
||||||
|
|
||||||
|
Another option is to set the System property `-Djdk.httpclient.HttpClient.log=all`. However, this second option does not log bodies.
|
||||||
<!-- End SDK Installation [installation] -->
|
<!-- End SDK Installation [installation] -->
|
||||||
|
|
||||||
<!-- Start SDK Example Usage [usage] -->
|
<!-- Start SDK Example Usage [usage] -->
|
||||||
@@ -169,7 +192,7 @@ public class Application {
|
|||||||
* [getLibraryDetails](docs/sdks/library/README.md#getlibrarydetails) - Get Library Details
|
* [getLibraryDetails](docs/sdks/library/README.md#getlibrarydetails) - Get Library Details
|
||||||
* [deleteLibrary](docs/sdks/library/README.md#deletelibrary) - Delete Library Section
|
* [deleteLibrary](docs/sdks/library/README.md#deletelibrary) - Delete Library Section
|
||||||
* [getLibraryItems](docs/sdks/library/README.md#getlibraryitems) - Get Library Items
|
* [getLibraryItems](docs/sdks/library/README.md#getlibraryitems) - Get Library Items
|
||||||
* [getAllMediaLibrary](docs/sdks/library/README.md#getallmedialibrary) - Get all media of library
|
* [getLibrarySectionsAll](docs/sdks/library/README.md#getlibrarysectionsall) - Get Library section media by tag ALL
|
||||||
* [getRefreshLibraryMetadata](docs/sdks/library/README.md#getrefreshlibrarymetadata) - Refresh Metadata Of The Library
|
* [getRefreshLibraryMetadata](docs/sdks/library/README.md#getrefreshlibrarymetadata) - Refresh Metadata Of The Library
|
||||||
* [getSearchLibrary](docs/sdks/library/README.md#getsearchlibrary) - Search Library
|
* [getSearchLibrary](docs/sdks/library/README.md#getsearchlibrary) - Search Library
|
||||||
* [getGenresLibrary](docs/sdks/library/README.md#getgenreslibrary) - Get Genres of library media
|
* [getGenresLibrary](docs/sdks/library/README.md#getgenreslibrary) - Get Genres of library media
|
||||||
@@ -348,8 +371,8 @@ public class Application {
|
|||||||
|
|
||||||
PlexAPI sdk = PlexAPI.builder()
|
PlexAPI sdk = PlexAPI.builder()
|
||||||
.protocol(ServerProtocol.HTTPS)
|
.protocol(ServerProtocol.HTTPS)
|
||||||
.ip("e0c3:bcc0:6bac:dccc:c4ec:34b1:ca98:4cb9")
|
.ip("4982:bc2a:b4f8:efb5:2394:5bc3:ab4f:0e6d")
|
||||||
.port("40311")
|
.port("44765")
|
||||||
.accessToken("<YOUR_API_KEY_HERE>")
|
.accessToken("<YOUR_API_KEY_HERE>")
|
||||||
.build();
|
.build();
|
||||||
|
|
||||||
|
|||||||
52
RELEASES.md
52
RELEASES.md
@@ -308,4 +308,54 @@ Based on:
|
|||||||
### Generated
|
### Generated
|
||||||
- [java v0.14.2] .
|
- [java v0.14.2] .
|
||||||
### Releases
|
### Releases
|
||||||
- [Maven Central v0.14.2] https://central.sonatype.com/artifact/dev.plexapi/plexapi/0.14.2 - .
|
- [Maven Central v0.14.2] https://central.sonatype.com/artifact/dev.plexapi/plexapi/0.14.2 - .
|
||||||
|
|
||||||
|
## 2025-04-14 00:30:37
|
||||||
|
### Changes
|
||||||
|
Based on:
|
||||||
|
- OpenAPI Doc
|
||||||
|
- Speakeasy CLI 1.531.4 (2.570.4) https://github.com/speakeasy-api/speakeasy
|
||||||
|
### Generated
|
||||||
|
- [java v0.15.0] .
|
||||||
|
### Releases
|
||||||
|
- [Maven Central v0.15.0] https://central.sonatype.com/artifact/dev.plexapi/plexapi/0.15.0 - .
|
||||||
|
|
||||||
|
## 2025-04-19 00:27:27
|
||||||
|
### Changes
|
||||||
|
Based on:
|
||||||
|
- OpenAPI Doc
|
||||||
|
- Speakeasy CLI 1.535.1 (2.585.2) https://github.com/speakeasy-api/speakeasy
|
||||||
|
### Generated
|
||||||
|
- [java v0.16.0] .
|
||||||
|
### Releases
|
||||||
|
- [Maven Central v0.16.0] https://central.sonatype.com/artifact/dev.plexapi/plexapi/0.16.0 - .
|
||||||
|
|
||||||
|
## 2025-05-01 00:32:51
|
||||||
|
### Changes
|
||||||
|
Based on:
|
||||||
|
- OpenAPI Doc
|
||||||
|
- Speakeasy CLI 1.541.2 (2.595.4) https://github.com/speakeasy-api/speakeasy
|
||||||
|
### Generated
|
||||||
|
- [java v0.16.1] .
|
||||||
|
### Releases
|
||||||
|
- [Maven Central v0.16.1] https://central.sonatype.com/artifact/dev.plexapi/plexapi/0.16.1 - .
|
||||||
|
|
||||||
|
## 2025-05-05 00:31:37
|
||||||
|
### Changes
|
||||||
|
Based on:
|
||||||
|
- OpenAPI Doc
|
||||||
|
- Speakeasy CLI 1.542.1 (2.597.9) https://github.com/speakeasy-api/speakeasy
|
||||||
|
### Generated
|
||||||
|
- [java v0.16.2] .
|
||||||
|
### Releases
|
||||||
|
- [Maven Central v0.16.2] https://central.sonatype.com/artifact/dev.plexapi/plexapi/0.16.2 - .
|
||||||
|
|
||||||
|
## 2025-06-04 00:30:54
|
||||||
|
### Changes
|
||||||
|
Based on:
|
||||||
|
- OpenAPI Doc
|
||||||
|
- Speakeasy CLI 1.555.2 (2.620.2) https://github.com/speakeasy-api/speakeasy
|
||||||
|
### Generated
|
||||||
|
- [java v0.17.0] .
|
||||||
|
### Releases
|
||||||
|
- [Maven Central v0.17.0] https://central.sonatype.com/artifact/dev.plexapi/plexapi/0.17.0 - .
|
||||||
@@ -103,7 +103,7 @@ publishing {
|
|||||||
// https://github.com/gradle/gradle/issues/18619
|
// https://github.com/gradle/gradle/issues/18619
|
||||||
groupId = "dev.plexapi"
|
groupId = "dev.plexapi"
|
||||||
artifactId = "plexapi"
|
artifactId = "plexapi"
|
||||||
version = "0.14.2"
|
version = "0.17.0"
|
||||||
|
|
||||||
from components.java
|
from components.java
|
||||||
|
|
||||||
|
|||||||
@@ -363,7 +363,7 @@ actions:
|
|||||||
.build();
|
.build();
|
||||||
|
|
||||||
StopTaskResponse res = sdk.butler().stopTask()
|
StopTaskResponse res = sdk.butler().stopTask()
|
||||||
.taskName(PathParamTaskName.BACKUP_DATABASE)
|
.taskName(PathParamTaskName.CLEAN_OLD_CACHE_FILES)
|
||||||
.call();
|
.call();
|
||||||
|
|
||||||
// handle response
|
// handle response
|
||||||
@@ -393,7 +393,7 @@ actions:
|
|||||||
.build();
|
.build();
|
||||||
|
|
||||||
StartTaskResponse res = sdk.butler().startTask()
|
StartTaskResponse res = sdk.butler().startTask()
|
||||||
.taskName(TaskName.CLEAN_OLD_BUNDLES)
|
.taskName(TaskName.REFRESH_PERIODIC_METADATA)
|
||||||
.call();
|
.call();
|
||||||
|
|
||||||
// handle response
|
// handle response
|
||||||
@@ -629,9 +629,10 @@ actions:
|
|||||||
.build();
|
.build();
|
||||||
|
|
||||||
GetRecentlyAddedRequest req = GetRecentlyAddedRequest.builder()
|
GetRecentlyAddedRequest req = GetRecentlyAddedRequest.builder()
|
||||||
.contentDirectoryID(470161L)
|
.contentDirectoryID(39486L)
|
||||||
.type(Type.TvShow)
|
.type(Type.TvShow)
|
||||||
.sectionID(2L)
|
.sectionID(2L)
|
||||||
|
.includeMeta(IncludeMeta.Enable)
|
||||||
.build();
|
.build();
|
||||||
|
|
||||||
GetRecentlyAddedResponse res = sdk.hubs().getRecentlyAdded()
|
GetRecentlyAddedResponse res = sdk.hubs().getRecentlyAdded()
|
||||||
@@ -666,7 +667,8 @@ actions:
|
|||||||
.build();
|
.build();
|
||||||
|
|
||||||
PerformSearchResponse res = sdk.search().performSearch()
|
PerformSearchResponse res = sdk.search().performSearch()
|
||||||
.query("dylan")
|
.query("arnold")
|
||||||
|
.limit(5)
|
||||||
.call();
|
.call();
|
||||||
|
|
||||||
// handle response
|
// handle response
|
||||||
@@ -696,6 +698,7 @@ actions:
|
|||||||
|
|
||||||
PerformVoiceSearchResponse res = sdk.search().performVoiceSearch()
|
PerformVoiceSearchResponse res = sdk.search().performVoiceSearch()
|
||||||
.query("dead+poop")
|
.query("dead+poop")
|
||||||
|
.limit(5)
|
||||||
.call();
|
.call();
|
||||||
|
|
||||||
// handle response
|
// handle response
|
||||||
@@ -724,7 +727,7 @@ actions:
|
|||||||
.build();
|
.build();
|
||||||
|
|
||||||
GetLibraryHubsResponse res = sdk.hubs().getLibraryHubs()
|
GetLibraryHubsResponse res = sdk.hubs().getLibraryHubs()
|
||||||
.sectionId(6728.76)
|
.sectionId(492.74)
|
||||||
.call();
|
.call();
|
||||||
|
|
||||||
if (res.object().isPresent()) {
|
if (res.object().isPresent()) {
|
||||||
@@ -771,8 +774,7 @@ actions:
|
|||||||
import dev.plexapi.sdk.PlexAPI;
|
import dev.plexapi.sdk.PlexAPI;
|
||||||
import dev.plexapi.sdk.models.errors.GetTopWatchedContentBadRequest;
|
import dev.plexapi.sdk.models.errors.GetTopWatchedContentBadRequest;
|
||||||
import dev.plexapi.sdk.models.errors.GetTopWatchedContentUnauthorized;
|
import dev.plexapi.sdk.models.errors.GetTopWatchedContentUnauthorized;
|
||||||
import dev.plexapi.sdk.models.operations.GetTopWatchedContentQueryParamType;
|
import dev.plexapi.sdk.models.operations.*;
|
||||||
import dev.plexapi.sdk.models.operations.GetTopWatchedContentResponse;
|
|
||||||
import java.lang.Exception;
|
import java.lang.Exception;
|
||||||
|
|
||||||
public class Application {
|
public class Application {
|
||||||
@@ -784,8 +786,8 @@ actions:
|
|||||||
.build();
|
.build();
|
||||||
|
|
||||||
GetTopWatchedContentResponse res = sdk.library().getTopWatchedContent()
|
GetTopWatchedContentResponse res = sdk.library().getTopWatchedContent()
|
||||||
.includeGuids(1L)
|
|
||||||
.type(GetTopWatchedContentQueryParamType.TvShow)
|
.type(GetTopWatchedContentQueryParamType.TvShow)
|
||||||
|
.includeGuids(GetTopWatchedContentQueryParamIncludeGuids.Enable)
|
||||||
.call();
|
.call();
|
||||||
|
|
||||||
if (res.object().isPresent()) {
|
if (res.object().isPresent()) {
|
||||||
@@ -846,7 +848,7 @@ actions:
|
|||||||
.build();
|
.build();
|
||||||
|
|
||||||
GetMediaMetaDataRequest req = GetMediaMetaDataRequest.builder()
|
GetMediaMetaDataRequest req = GetMediaMetaDataRequest.builder()
|
||||||
.ratingKey(9518L)
|
.ratingKey("21119,21617")
|
||||||
.includeConcerts(true)
|
.includeConcerts(true)
|
||||||
.includeExtras(true)
|
.includeExtras(true)
|
||||||
.includeOnDeck(true)
|
.includeOnDeck(true)
|
||||||
@@ -992,7 +994,7 @@ actions:
|
|||||||
.build();
|
.build();
|
||||||
|
|
||||||
GetMetadataChildrenResponse res = sdk.library().getMetadataChildren()
|
GetMetadataChildrenResponse res = sdk.library().getMetadataChildren()
|
||||||
.ratingKey(1539.14)
|
.ratingKey(2403.67)
|
||||||
.includeElements("Stream")
|
.includeElements("Stream")
|
||||||
.call();
|
.call();
|
||||||
|
|
||||||
@@ -1139,6 +1141,7 @@ actions:
|
|||||||
16L,
|
16L,
|
||||||
17L))
|
17L))
|
||||||
.sectionID(2L)
|
.sectionID(2L)
|
||||||
|
.includeMeta(QueryParamIncludeMeta.Enable)
|
||||||
.build();
|
.build();
|
||||||
|
|
||||||
GetRecentlyAddedLibraryResponse res = sdk.library().getRecentlyAddedLibrary()
|
GetRecentlyAddedLibraryResponse res = sdk.library().getRecentlyAddedLibrary()
|
||||||
@@ -1178,6 +1181,8 @@ actions:
|
|||||||
.clientID("3381b62b-9ab7-4e37-827b-203e9809eb58")
|
.clientID("3381b62b-9ab7-4e37-827b-203e9809eb58")
|
||||||
.searchTypes(List.of(
|
.searchTypes(List.of(
|
||||||
SearchTypes.PEOPLE))
|
SearchTypes.PEOPLE))
|
||||||
|
.includeCollections(GetSearchAllLibrariesQueryParamIncludeCollections.Enable)
|
||||||
|
.includeExternalMedia(GetSearchAllLibrariesQueryParamIncludeExternalMedia.Enable)
|
||||||
.build();
|
.build();
|
||||||
|
|
||||||
GetSearchAllLibrariesResponse res = sdk.library().getSearchAllLibraries()
|
GetSearchAllLibrariesResponse res = sdk.library().getSearchAllLibraries()
|
||||||
@@ -1242,7 +1247,7 @@ actions:
|
|||||||
.build();
|
.build();
|
||||||
|
|
||||||
GetWatchListRequest req = GetWatchListRequest.builder()
|
GetWatchListRequest req = GetWatchListRequest.builder()
|
||||||
.filter(Filter.AVAILABLE)
|
.filter(Filter.RELEASED)
|
||||||
.xPlexToken("CV5xoxjTpFKUzBTShsaf")
|
.xPlexToken("CV5xoxjTpFKUzBTShsaf")
|
||||||
.build();
|
.build();
|
||||||
|
|
||||||
@@ -1296,6 +1301,7 @@ actions:
|
|||||||
import dev.plexapi.sdk.models.errors.GetLibraryDetailsBadRequest;
|
import dev.plexapi.sdk.models.errors.GetLibraryDetailsBadRequest;
|
||||||
import dev.plexapi.sdk.models.errors.GetLibraryDetailsUnauthorized;
|
import dev.plexapi.sdk.models.errors.GetLibraryDetailsUnauthorized;
|
||||||
import dev.plexapi.sdk.models.operations.GetLibraryDetailsResponse;
|
import dev.plexapi.sdk.models.operations.GetLibraryDetailsResponse;
|
||||||
|
import dev.plexapi.sdk.models.operations.IncludeDetails;
|
||||||
import java.lang.Exception;
|
import java.lang.Exception;
|
||||||
|
|
||||||
public class Application {
|
public class Application {
|
||||||
@@ -1307,6 +1313,7 @@ actions:
|
|||||||
.build();
|
.build();
|
||||||
|
|
||||||
GetLibraryDetailsResponse res = sdk.library().getLibraryDetails()
|
GetLibraryDetailsResponse res = sdk.library().getLibraryDetails()
|
||||||
|
.includeDetails(IncludeDetails.ZERO)
|
||||||
.sectionKey(9518)
|
.sectionKey(9518)
|
||||||
.call();
|
.call();
|
||||||
|
|
||||||
@@ -1357,25 +1364,30 @@ actions:
|
|||||||
package hello.world;
|
package hello.world;
|
||||||
|
|
||||||
import dev.plexapi.sdk.PlexAPI;
|
import dev.plexapi.sdk.PlexAPI;
|
||||||
import dev.plexapi.sdk.models.errors.GetAllMediaLibraryBadRequest;
|
import dev.plexapi.sdk.models.errors.GetLibrarySectionsAllBadRequest;
|
||||||
import dev.plexapi.sdk.models.errors.GetAllMediaLibraryUnauthorized;
|
import dev.plexapi.sdk.models.errors.GetLibrarySectionsAllUnauthorized;
|
||||||
import dev.plexapi.sdk.models.operations.*;
|
import dev.plexapi.sdk.models.operations.*;
|
||||||
import java.lang.Exception;
|
import java.lang.Exception;
|
||||||
|
|
||||||
public class Application {
|
public class Application {
|
||||||
|
|
||||||
public static void main(String[] args) throws GetAllMediaLibraryBadRequest, GetAllMediaLibraryUnauthorized, Exception {
|
public static void main(String[] args) throws GetLibrarySectionsAllBadRequest, GetLibrarySectionsAllUnauthorized, Exception {
|
||||||
|
|
||||||
PlexAPI sdk = PlexAPI.builder()
|
PlexAPI sdk = PlexAPI.builder()
|
||||||
.accessToken("<YOUR_API_KEY_HERE>")
|
.accessToken("<YOUR_API_KEY_HERE>")
|
||||||
.build();
|
.build();
|
||||||
|
|
||||||
GetAllMediaLibraryRequest req = GetAllMediaLibraryRequest.builder()
|
GetLibrarySectionsAllRequest req = GetLibrarySectionsAllRequest.builder()
|
||||||
.sectionKey(9518)
|
.sectionKey(9518)
|
||||||
.type(GetAllMediaLibraryQueryParamType.TvShow)
|
.type(GetLibrarySectionsAllQueryParamType.TvShow)
|
||||||
|
.includeMeta(GetLibrarySectionsAllQueryParamIncludeMeta.Enable)
|
||||||
|
.includeGuids(QueryParamIncludeGuids.Enable)
|
||||||
|
.includeAdvanced(IncludeAdvanced.Enable)
|
||||||
|
.includeCollections(QueryParamIncludeCollections.Enable)
|
||||||
|
.includeExternalMedia(QueryParamIncludeExternalMedia.Enable)
|
||||||
.build();
|
.build();
|
||||||
|
|
||||||
GetAllMediaLibraryResponse res = sdk.library().getAllMediaLibrary()
|
GetLibrarySectionsAllResponse res = sdk.library().getLibrarySectionsAll()
|
||||||
.request(req)
|
.request(req)
|
||||||
.call();
|
.call();
|
||||||
|
|
||||||
@@ -1474,7 +1486,7 @@ actions:
|
|||||||
.build();
|
.build();
|
||||||
|
|
||||||
GetRefreshLibraryMetadataResponse res = sdk.library().getRefreshLibraryMetadata()
|
GetRefreshLibraryMetadataResponse res = sdk.library().getRefreshLibraryMetadata()
|
||||||
.force(Force.ONE)
|
.force(Force.ZERO)
|
||||||
.sectionKey(9518)
|
.sectionKey(9518)
|
||||||
.call();
|
.call();
|
||||||
|
|
||||||
@@ -1537,9 +1549,11 @@ actions:
|
|||||||
.build();
|
.build();
|
||||||
|
|
||||||
GetLibraryItemsRequest req = GetLibraryItemsRequest.builder()
|
GetLibraryItemsRequest req = GetLibraryItemsRequest.builder()
|
||||||
.tag(Tag.EDITION)
|
.tag(Tag.NEWEST)
|
||||||
.type(GetLibraryItemsQueryParamType.TvShow)
|
.type(GetLibraryItemsQueryParamType.TvShow)
|
||||||
.sectionKey(9518)
|
.sectionKey(9518)
|
||||||
|
.includeGuids(IncludeGuids.Enable)
|
||||||
|
.includeMeta(GetLibraryItemsQueryParamIncludeMeta.Enable)
|
||||||
.build();
|
.build();
|
||||||
|
|
||||||
GetLibraryItemsResponse res = sdk.library().getLibraryItems()
|
GetLibraryItemsResponse res = sdk.library().getLibraryItems()
|
||||||
@@ -1731,8 +1745,8 @@ actions:
|
|||||||
.height(165)
|
.height(165)
|
||||||
.opacity(100L)
|
.opacity(100L)
|
||||||
.blur(0)
|
.blur(0)
|
||||||
.minSize(MinSize.ONE)
|
.minSize(MinSize.ZERO)
|
||||||
.upscale(Upscale.ONE)
|
.upscale(Upscale.ZERO)
|
||||||
.url("/library/metadata/49564/thumb/1654258204")
|
.url("/library/metadata/49564/thumb/1654258204")
|
||||||
.build();
|
.build();
|
||||||
|
|
||||||
@@ -1804,7 +1818,7 @@ actions:
|
|||||||
.build();
|
.build();
|
||||||
|
|
||||||
GetTokenByPinIdRequest req = GetTokenByPinIdRequest.builder()
|
GetTokenByPinIdRequest req = GetTokenByPinIdRequest.builder()
|
||||||
.pinID(408895L)
|
.pinID(232248L)
|
||||||
.clientID("3381b62b-9ab7-4e37-827b-203e9809eb58")
|
.clientID("3381b62b-9ab7-4e37-827b-203e9809eb58")
|
||||||
.clientName("Plex for Roku")
|
.clientName("Plex for Roku")
|
||||||
.deviceNickname("Roku 3")
|
.deviceNickname("Roku 3")
|
||||||
@@ -1875,9 +1889,9 @@ actions:
|
|||||||
|
|
||||||
CreatePlaylistRequest req = CreatePlaylistRequest.builder()
|
CreatePlaylistRequest req = CreatePlaylistRequest.builder()
|
||||||
.title("<value>")
|
.title("<value>")
|
||||||
.type(CreatePlaylistQueryParamType.PHOTO)
|
.type(CreatePlaylistQueryParamType.AUDIO)
|
||||||
.smart(Smart.ONE)
|
.smart(Smart.ONE)
|
||||||
.uri("https://hoarse-testing.info/")
|
.uri("https://short-term-disconnection.name/")
|
||||||
.build();
|
.build();
|
||||||
|
|
||||||
CreatePlaylistResponse res = sdk.playlists().createPlaylist()
|
CreatePlaylistResponse res = sdk.playlists().createPlaylist()
|
||||||
@@ -1914,7 +1928,7 @@ actions:
|
|||||||
|
|
||||||
UploadPlaylistResponse res = sdk.playlists().uploadPlaylist()
|
UploadPlaylistResponse res = sdk.playlists().uploadPlaylist()
|
||||||
.path("/home/barkley/playlist.m3u")
|
.path("/home/barkley/playlist.m3u")
|
||||||
.force(QueryParamForce.ZERO)
|
.force(QueryParamForce.ONE)
|
||||||
.sectionID(1L)
|
.sectionID(1L)
|
||||||
.call();
|
.call();
|
||||||
|
|
||||||
@@ -1944,7 +1958,7 @@ actions:
|
|||||||
.build();
|
.build();
|
||||||
|
|
||||||
DeletePlaylistResponse res = sdk.playlists().deletePlaylist()
|
DeletePlaylistResponse res = sdk.playlists().deletePlaylist()
|
||||||
.playlistID(216.22)
|
.playlistID(3432.93)
|
||||||
.call();
|
.call();
|
||||||
|
|
||||||
// handle response
|
// handle response
|
||||||
@@ -1973,7 +1987,7 @@ actions:
|
|||||||
.build();
|
.build();
|
||||||
|
|
||||||
GetPlaylistResponse res = sdk.playlists().getPlaylist()
|
GetPlaylistResponse res = sdk.playlists().getPlaylist()
|
||||||
.playlistID(4109.48)
|
.playlistID(8419.53)
|
||||||
.call();
|
.call();
|
||||||
|
|
||||||
if (res.object().isPresent()) {
|
if (res.object().isPresent()) {
|
||||||
@@ -2004,7 +2018,7 @@ actions:
|
|||||||
.build();
|
.build();
|
||||||
|
|
||||||
UpdatePlaylistResponse res = sdk.playlists().updatePlaylist()
|
UpdatePlaylistResponse res = sdk.playlists().updatePlaylist()
|
||||||
.playlistID(3915)
|
.playlistID(1579.66)
|
||||||
.call();
|
.call();
|
||||||
|
|
||||||
// handle response
|
// handle response
|
||||||
@@ -2033,7 +2047,7 @@ actions:
|
|||||||
.build();
|
.build();
|
||||||
|
|
||||||
ClearPlaylistContentsResponse res = sdk.playlists().clearPlaylistContents()
|
ClearPlaylistContentsResponse res = sdk.playlists().clearPlaylistContents()
|
||||||
.playlistID(1893.18)
|
.playlistID(4137.37)
|
||||||
.call();
|
.call();
|
||||||
|
|
||||||
// handle response
|
// handle response
|
||||||
@@ -2063,7 +2077,7 @@ actions:
|
|||||||
.build();
|
.build();
|
||||||
|
|
||||||
GetPlaylistContentsResponse res = sdk.playlists().getPlaylistContents()
|
GetPlaylistContentsResponse res = sdk.playlists().getPlaylistContents()
|
||||||
.playlistID(5004.46)
|
.playlistID(5535.42)
|
||||||
.type(GetPlaylistContentsQueryParamType.TvShow)
|
.type(GetPlaylistContentsQueryParamType.TvShow)
|
||||||
.call();
|
.call();
|
||||||
|
|
||||||
@@ -2095,7 +2109,7 @@ actions:
|
|||||||
.build();
|
.build();
|
||||||
|
|
||||||
AddPlaylistContentsResponse res = sdk.playlists().addPlaylistContents()
|
AddPlaylistContentsResponse res = sdk.playlists().addPlaylistContents()
|
||||||
.playlistID(8502.01)
|
.playlistID(7013.44)
|
||||||
.uri("server://12345/com.plexapp.plugins.library/library/metadata/1")
|
.uri("server://12345/com.plexapp.plugins.library/library/metadata/1")
|
||||||
.playQueueID(123)
|
.playQueueID(123)
|
||||||
.call();
|
.call();
|
||||||
@@ -2116,7 +2130,7 @@ actions:
|
|||||||
import dev.plexapi.sdk.PlexAPI;
|
import dev.plexapi.sdk.PlexAPI;
|
||||||
import dev.plexapi.sdk.models.errors.GetServerResourcesBadRequest;
|
import dev.plexapi.sdk.models.errors.GetServerResourcesBadRequest;
|
||||||
import dev.plexapi.sdk.models.errors.GetServerResourcesUnauthorized;
|
import dev.plexapi.sdk.models.errors.GetServerResourcesUnauthorized;
|
||||||
import dev.plexapi.sdk.models.operations.GetServerResourcesResponse;
|
import dev.plexapi.sdk.models.operations.*;
|
||||||
import java.lang.Exception;
|
import java.lang.Exception;
|
||||||
|
|
||||||
public class Application {
|
public class Application {
|
||||||
@@ -2128,6 +2142,9 @@ actions:
|
|||||||
.build();
|
.build();
|
||||||
|
|
||||||
GetServerResourcesResponse res = sdk.plex().getServerResources()
|
GetServerResourcesResponse res = sdk.plex().getServerResources()
|
||||||
|
.includeHttps(IncludeHttps.Enable)
|
||||||
|
.includeRelay(IncludeRelay.Enable)
|
||||||
|
.includeIPv6(IncludeIPv6.Enable)
|
||||||
.clientID("3381b62b-9ab7-4e37-827b-203e9809eb58")
|
.clientID("3381b62b-9ab7-4e37-827b-203e9809eb58")
|
||||||
.call();
|
.call();
|
||||||
|
|
||||||
@@ -2190,7 +2207,7 @@ actions:
|
|||||||
.build();
|
.build();
|
||||||
|
|
||||||
GetSourceConnectionInformationResponse res = sdk.authentication().getSourceConnectionInformation()
|
GetSourceConnectionInformationResponse res = sdk.authentication().getSourceConnectionInformation()
|
||||||
.source("provider://provider-identifier")
|
.source("server://client-identifier")
|
||||||
.call();
|
.call();
|
||||||
|
|
||||||
// handle response
|
// handle response
|
||||||
|
|||||||
@@ -1,4 +1,4 @@
|
|||||||
# GetAllMediaLibraryBadRequest
|
# GetLibrarySectionsAllBadRequest
|
||||||
|
|
||||||
Bad Request - A parameter was not specified, or was specified incorrectly.
|
Bad Request - A parameter was not specified, or was specified incorrectly.
|
||||||
|
|
||||||
@@ -7,5 +7,5 @@ Bad Request - A parameter was not specified, or was specified incorrectly.
|
|||||||
|
|
||||||
| Field | Type | Required | Description |
|
| Field | Type | Required | Description |
|
||||||
| ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ |
|
| ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ |
|
||||||
| `errors` | List\<[GetAllMediaLibraryErrors](../../models/errors/GetAllMediaLibraryErrors.md)> | :heavy_minus_sign: | N/A |
|
| `errors` | List\<[GetLibrarySectionsAllErrors](../../models/errors/GetLibrarySectionsAllErrors.md)> | :heavy_minus_sign: | N/A |
|
||||||
| `rawResponse` | [HttpResponse\<InputStream>](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
| `rawResponse` | [HttpResponse\<InputStream>](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
||||||
@@ -1,4 +1,4 @@
|
|||||||
# GetAllMediaLibraryErrors
|
# GetLibrarySectionsAllErrors
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
@@ -1,4 +1,4 @@
|
|||||||
# GetAllMediaLibraryLibraryErrors
|
# GetLibrarySectionsAllLibraryErrors
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
@@ -1,4 +1,4 @@
|
|||||||
# GetAllMediaLibraryUnauthorized
|
# GetLibrarySectionsAllUnauthorized
|
||||||
|
|
||||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||||
|
|
||||||
@@ -7,5 +7,5 @@ Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
|||||||
|
|
||||||
| Field | Type | Required | Description |
|
| Field | Type | Required | Description |
|
||||||
| ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ |
|
| ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ |
|
||||||
| `errors` | List\<[GetAllMediaLibraryLibraryErrors](../../models/errors/GetAllMediaLibraryLibraryErrors.md)> | :heavy_minus_sign: | N/A |
|
| `errors` | List\<[GetLibrarySectionsAllLibraryErrors](../../models/errors/GetLibrarySectionsAllLibraryErrors.md)> | :heavy_minus_sign: | N/A |
|
||||||
| `rawResponse` | [HttpResponse\<InputStream>](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
| `rawResponse` | [HttpResponse\<InputStream>](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
||||||
11
docs/models/operations/Attributes.md
Normal file
11
docs/models/operations/Attributes.md
Normal file
@@ -0,0 +1,11 @@
|
|||||||
|
# Attributes
|
||||||
|
|
||||||
|
Attributes associated with the marker.
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| -------------------------------------------- | -------------------------------------------- | -------------------------------------------- | -------------------------------------------- | -------------------------------------------- |
|
||||||
|
| `id` | *long* | :heavy_check_mark: | The identifier for the attributes. | 306970 |
|
||||||
|
| `version` | *Optional\<Long>* | :heavy_minus_sign: | The version number of the marker attributes. | 4 |
|
||||||
15
docs/models/operations/Chapter.md
Normal file
15
docs/models/operations/Chapter.md
Normal file
@@ -0,0 +1,15 @@
|
|||||||
|
# Chapter
|
||||||
|
|
||||||
|
The thumbnail for the chapter
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ |
|
||||||
|
| `id` | *long* | :heavy_check_mark: | N/A | 4 |
|
||||||
|
| `filter` | *String* | :heavy_check_mark: | N/A | thumb=4 |
|
||||||
|
| `index` | *long* | :heavy_check_mark: | N/A | 1 |
|
||||||
|
| `startTimeOffset` | *long* | :heavy_check_mark: | N/A | 0 |
|
||||||
|
| `endTimeOffset` | *long* | :heavy_check_mark: | N/A | 100100 |
|
||||||
|
| `thumb` | *String* | :heavy_check_mark: | N/A | /library/media/46883/chapterImages/1 |
|
||||||
@@ -5,8 +5,8 @@ The filter query string for country media items.
|
|||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
| Field | Type | Required | Description | Example |
|
||||||
| ---------------------------------------- | ---------------------------------------- | ---------------------------------------- | ---------------------------------------- | ---------------------------------------- |
|
| ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- |
|
||||||
| `id` | *long* | :heavy_check_mark: | N/A | 259 |
|
| `id` | *int* | :heavy_check_mark: | The unique identifier for the country.<br/>NOTE: This is different for each Plex server and is not globally unique.<br/> | 259 |
|
||||||
| `tag` | *String* | :heavy_check_mark: | The country of origin of this media item | United States of America |
|
| `tag` | *String* | :heavy_check_mark: | The country of origin of this media item | United States of America |
|
||||||
| `filter` | *Optional\<String>* | :heavy_minus_sign: | N/A | country=19 |
|
| `filter` | *String* | :heavy_check_mark: | N/A | country=19 |
|
||||||
@@ -3,6 +3,10 @@
|
|||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
| Field | Type | Required | Description | Example |
|
||||||
| -------------------- | -------------------- | -------------------- | -------------------- | -------------------- |
|
| ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- |
|
||||||
| `tag` | *String* | :heavy_check_mark: | The role of Director | Danny Boyle |
|
| `id` | *int* | :heavy_check_mark: | Unique identifier for the director. | 126522 |
|
||||||
|
| `filter` | *String* | :heavy_check_mark: | The filter string used to query this director. | director=235876 |
|
||||||
|
| `tag` | *String* | :heavy_check_mark: | The role of Director | Danny Boyle |
|
||||||
|
| `tagKey` | *String* | :heavy_check_mark: | A unique 24-character hexadecimal key associated with the director's tag, used for internal identification. | 5d776831151a60001f24d031 |
|
||||||
|
| `thumb` | *Optional\<String>* | :heavy_minus_sign: | The absolute URL of the thumbnail image for the director. | https://metadata-static.plex.tv/8/people/8d65fa96804802e08f2de09fe014408e.jpg |
|
||||||
8
docs/models/operations/Extras.md
Normal file
8
docs/models/operations/Extras.md
Normal file
@@ -0,0 +1,8 @@
|
|||||||
|
# Extras
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ----------------------- | ----------------------- | ----------------------- | ----------------------- | ----------------------- |
|
||||||
|
| `size` | *Optional\<Long>* | :heavy_minus_sign: | The size of the extras. | 1 |
|
||||||
@@ -5,8 +5,8 @@ The filter query string for similar items.
|
|||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
| Field | Type | Required | Description | Example |
|
||||||
| ---------------------------------- | ---------------------------------- | ---------------------------------- | ---------------------------------- | ---------------------------------- |
|
| -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- |
|
||||||
| `id` | *long* | :heavy_check_mark: | N/A | 259 |
|
| `id` | *int* | :heavy_check_mark: | The unique identifier for the genre.<br/>NOTE: This is different for each Plex server and is not globally unique.<br/> | 259 |
|
||||||
| `filter` | *String* | :heavy_check_mark: | N/A | genre=19 |
|
| `filter` | *String* | :heavy_check_mark: | N/A | genre=19 |
|
||||||
| `tag` | *String* | :heavy_check_mark: | The genre name of this media-item<br/> | Crime |
|
| `tag` | *String* | :heavy_check_mark: | The genre name of this media-item<br/> | Crime |
|
||||||
@@ -11,12 +11,14 @@ E.g. A movie library will not return anything with type 3 as there are no season
|
|||||||
|
|
||||||
## Values
|
## Values
|
||||||
|
|
||||||
| Name | Value |
|
| Name | Value |
|
||||||
| --------- | --------- |
|
| ------------ | ------------ |
|
||||||
| `Movie` | 1 |
|
| `Movie` | 1 |
|
||||||
| `TvShow` | 2 |
|
| `TvShow` | 2 |
|
||||||
| `Season` | 3 |
|
| `Season` | 3 |
|
||||||
| `Episode` | 4 |
|
| `Episode` | 4 |
|
||||||
| `Audio` | 8 |
|
| `Artist` | 5 |
|
||||||
| `Album` | 9 |
|
| `Album` | 6 |
|
||||||
| `Track` | 10 |
|
| `Track` | 7 |
|
||||||
|
| `PhotoAlbum` | 8 |
|
||||||
|
| `Photo` | 9 |
|
||||||
@@ -3,26 +3,26 @@
|
|||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
| Field | Type | Required | Description | Example |
|
||||||
| ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ |
|
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
||||||
| `allowSync` | *boolean* | :heavy_check_mark: | Indicates whether syncing is allowed. | false |
|
| `allowSync` | *boolean* | :heavy_check_mark: | Indicates whether syncing is allowed. | false |
|
||||||
| `art` | *String* | :heavy_check_mark: | URL for the background artwork of the media container. | /:/resources/show-fanart.jpg |
|
| `art` | *String* | :heavy_check_mark: | URL for the background artwork of the media container. | /:/resources/show-fanart.jpg |
|
||||||
| `composite` | *String* | :heavy_check_mark: | The relative path to the composite media item. | /library/sections/1/composite/1743824484 |
|
| `composite` | *String* | :heavy_check_mark: | The relative path to the composite media item. | /library/sections/1/composite/1743824484 |
|
||||||
| `filters` | *boolean* | :heavy_check_mark: | UNKNOWN | true |
|
| `filters` | *boolean* | :heavy_check_mark: | UNKNOWN | true |
|
||||||
| `refreshing` | *boolean* | :heavy_check_mark: | Indicates whether the library is currently being refreshed or updated | true |
|
| `refreshing` | *boolean* | :heavy_check_mark: | Indicates whether the library is currently being refreshed or updated | true |
|
||||||
| `thumb` | *String* | :heavy_check_mark: | URL for the thumbnail image of the media container. | /:/resources/show.png |
|
| `thumb` | *String* | :heavy_check_mark: | URL for the thumbnail image of the media container. | /:/resources/show.png |
|
||||||
| `key` | *String* | :heavy_check_mark: | The library key representing the unique identifier | 1 |
|
| `key` | *String* | :heavy_check_mark: | The library key representing the unique identifier | 1 |
|
||||||
| `type` | [GetAllLibrariesType](../../models/operations/GetAllLibrariesType.md) | :heavy_check_mark: | N/A | movie |
|
| `type` | [GetAllLibrariesType](../../models/operations/GetAllLibrariesType.md) | :heavy_check_mark: | N/A | movie |
|
||||||
| `title` | *String* | :heavy_check_mark: | The title of the library | Movies |
|
| `title` | *String* | :heavy_check_mark: | The title of the library | Movies |
|
||||||
| `agent` | *String* | :heavy_check_mark: | The Plex agent used to match and retrieve media metadata. | tv.plex.agents.movie |
|
| `agent` | *String* | :heavy_check_mark: | The Plex agent used to match and retrieve media metadata. | tv.plex.agents.movie |
|
||||||
| `scanner` | *String* | :heavy_check_mark: | UNKNOWN | Plex Movie |
|
| `scanner` | *String* | :heavy_check_mark: | UNKNOWN | Plex Movie |
|
||||||
| `language` | *String* | :heavy_check_mark: | The Plex library language that has been set | en-US |
|
| `language` | *String* | :heavy_check_mark: | The Plex library language that has been set | en-US |
|
||||||
| `uuid` | *String* | :heavy_check_mark: | The universally unique identifier for the library. | e69655a2-ef48-4aba-bb19-01e7d3cc34d6 |
|
| `uuid` | *String* | :heavy_check_mark: | The universally unique identifier for the library. | e69655a2-ef48-4aba-bb19-01e7d3cc34d6 |
|
||||||
| `updatedAt` | *long* | :heavy_check_mark: | Unix epoch datetime in seconds | 1556281940 |
|
| `updatedAt` | *long* | :heavy_check_mark: | Unix epoch datetime in seconds | 1556281940 |
|
||||||
| `createdAt` | *Optional\<Long>* | :heavy_minus_sign: | N/A | 1556281940 |
|
| `createdAt` | *Optional\<Long>* | :heavy_minus_sign: | N/A | 1556281940 |
|
||||||
| `scannedAt` | *long* | :heavy_check_mark: | Unix epoch datetime in seconds | 1556281940 |
|
| `scannedAt` | *long* | :heavy_check_mark: | Unix epoch datetime in seconds | 1556281940 |
|
||||||
| `content` | *boolean* | :heavy_check_mark: | UNKNOWN | true |
|
| `content` | *boolean* | :heavy_check_mark: | UNKNOWN | true |
|
||||||
| `directory` | *boolean* | :heavy_check_mark: | UNKNOWN | true |
|
| `directory` | *boolean* | :heavy_check_mark: | UNKNOWN | true |
|
||||||
| `contentChangedAt` | *int* | :heavy_check_mark: | The number of seconds since the content was last changed relative to now. | 9173960 |
|
| `contentChangedAt` | *long* | :heavy_check_mark: | Timestamp (in seconds) representing the last time the content was modified.<br/>NOTE: Some Plex server have some absurd values for this field, like 8457612157633039800 so it should be int64<br/> | 9173960 |
|
||||||
| `hidden` | [Optional\<Hidden>](../../models/operations/Hidden.md) | :heavy_minus_sign: | N/A | 1 |
|
| `hidden` | [Optional\<Hidden>](../../models/operations/Hidden.md) | :heavy_minus_sign: | The Plex library visibility setting | 1 |
|
||||||
| `location` | List\<[GetAllLibrariesLocation](../../models/operations/GetAllLibrariesLocation.md)> | :heavy_check_mark: | N/A | |
|
| `location` | List\<[GetAllLibrariesLocation](../../models/operations/GetAllLibrariesLocation.md)> | :heavy_check_mark: | N/A | |
|
||||||
@@ -5,11 +5,15 @@ The library type
|
|||||||
|
|
||||||
## Values
|
## Values
|
||||||
|
|
||||||
| Name | Value |
|
| Name | Value |
|
||||||
| --------- | --------- |
|
| ------------ | ------------ |
|
||||||
| `Movie` | movie |
|
| `Movie` | movie |
|
||||||
| `TvShow` | show |
|
| `TvShow` | show |
|
||||||
| `Season` | season |
|
| `Season` | season |
|
||||||
| `Episode` | episode |
|
| `Episode` | episode |
|
||||||
| `Artist` | artist |
|
| `Artist` | artist |
|
||||||
| `Album` | album |
|
| `Album` | album |
|
||||||
|
| `Track` | track |
|
||||||
|
| `PhotoAlbum` | photoalbum |
|
||||||
|
| `Photo` | photo |
|
||||||
|
| `Collection` | collection |
|
||||||
@@ -1,9 +0,0 @@
|
|||||||
# GetAllMediaLibraryFieldType
|
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
|
||||||
| ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ |
|
|
||||||
| `type` | *String* | :heavy_check_mark: | N/A | tag |
|
|
||||||
| `operator` | List\<[GetAllMediaLibraryOperator](../../models/operations/GetAllMediaLibraryOperator.md)> | :heavy_check_mark: | N/A | |
|
|
||||||
@@ -1,8 +0,0 @@
|
|||||||
# GetAllMediaLibraryGuids
|
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
|
||||||
| -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- |
|
|
||||||
| `id` | *Optional\<String>* | :heavy_minus_sign: | The unique identifier for the Guid. Can be imdb://tt0286347, tmdb://1763, tvdb://2337<br/> | tvdb://2337 |
|
|
||||||
@@ -1,10 +0,0 @@
|
|||||||
# GetAllMediaLibraryImage
|
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
|
||||||
| --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- |
|
|
||||||
| `alt` | *String* | :heavy_check_mark: | N/A | Episode 1 |
|
|
||||||
| `type` | [GetAllMediaLibraryLibraryResponseType](../../models/operations/GetAllMediaLibraryLibraryResponseType.md) | :heavy_check_mark: | N/A | background |
|
|
||||||
| `url` | *String* | :heavy_check_mark: | N/A | /library/metadata/45521/thumb/1644710589 |
|
|
||||||
@@ -1,16 +0,0 @@
|
|||||||
# GetAllMediaLibraryLibraryType
|
|
||||||
|
|
||||||
The type of media content
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## Values
|
|
||||||
|
|
||||||
| Name | Value |
|
|
||||||
| --------- | --------- |
|
|
||||||
| `Movie` | movie |
|
|
||||||
| `TvShow` | show |
|
|
||||||
| `Season` | season |
|
|
||||||
| `Episode` | episode |
|
|
||||||
| `Artist` | artist |
|
|
||||||
| `Album` | album |
|
|
||||||
@@ -1,26 +0,0 @@
|
|||||||
# GetAllMediaLibraryMedia
|
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
|
||||||
| ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ |
|
|
||||||
| `id` | *long* | :heavy_check_mark: | Unique media identifier. | 387322 |
|
|
||||||
| `duration` | *Optional\<Integer>* | :heavy_minus_sign: | Duration of the media in milliseconds. | 9610350 |
|
|
||||||
| `bitrate` | *Optional\<Integer>* | :heavy_minus_sign: | Bitrate in bits per second. | 25512 |
|
|
||||||
| `width` | *Optional\<Integer>* | :heavy_minus_sign: | Video width in pixels. | 3840 |
|
|
||||||
| `height` | *Optional\<Integer>* | :heavy_minus_sign: | Video height in pixels. | 1602 |
|
|
||||||
| `aspectRatio` | *Optional\<Float>* | :heavy_minus_sign: | Aspect ratio of the video. | 2.35 |
|
|
||||||
| `audioChannels` | *Optional\<Integer>* | :heavy_minus_sign: | Number of audio channels. | 6 |
|
|
||||||
| `displayOffset` | *Optional\<Integer>* | :heavy_minus_sign: | N/A | 50 |
|
|
||||||
| `audioCodec` | *Optional\<String>* | :heavy_minus_sign: | Audio codec used. | eac3 |
|
|
||||||
| `videoCodec` | *Optional\<String>* | :heavy_minus_sign: | Video codec used. | hevc |
|
|
||||||
| `videoResolution` | *Optional\<String>* | :heavy_minus_sign: | Video resolution (e.g., 4k). | 4k |
|
|
||||||
| `container` | *Optional\<String>* | :heavy_minus_sign: | File container type. | mkv |
|
|
||||||
| `videoFrameRate` | *Optional\<String>* | :heavy_minus_sign: | Frame rate of the video. Values found include NTSC, PAL, 24p<br/> | 24p |
|
|
||||||
| `videoProfile` | *Optional\<String>* | :heavy_minus_sign: | Video profile (e.g., main 10). | main 10 |
|
|
||||||
| `hasVoiceActivity` | *Optional\<Boolean>* | :heavy_minus_sign: | Indicates whether voice activity is detected. | false |
|
|
||||||
| `audioProfile` | *Optional\<String>* | :heavy_minus_sign: | The audio profile used for the media (e.g., DTS, Dolby Digital, etc.). | dts |
|
|
||||||
| `optimizedForStreaming` | [Optional\<GetAllMediaLibraryOptimizedForStreaming>](../../models/operations/GetAllMediaLibraryOptimizedForStreaming.md) | :heavy_minus_sign: | Has this media been optimized for streaming. NOTE: This can be 0, 1, false or true | |
|
|
||||||
| `has64bitOffsets` | *Optional\<Boolean>* | :heavy_minus_sign: | N/A | false |
|
|
||||||
| `part` | List\<[GetAllMediaLibraryPart](../../models/operations/GetAllMediaLibraryPart.md)> | :heavy_minus_sign: | An array of parts for this media item. | |
|
|
||||||
@@ -1,26 +0,0 @@
|
|||||||
# GetAllMediaLibraryMediaContainer
|
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
|
||||||
| ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- |
|
|
||||||
| `size` | *int* | :heavy_check_mark: | Number of media items returned in this response. | 50 |
|
|
||||||
| `totalSize` | *int* | :heavy_check_mark: | Total number of media items in the library. | 50 |
|
|
||||||
| `offset` | *long* | :heavy_check_mark: | Offset value for pagination. | 0 |
|
|
||||||
| `allowSync` | *boolean* | :heavy_check_mark: | Indicates whether syncing is allowed. | false |
|
|
||||||
| `art` | *String* | :heavy_check_mark: | URL for the background artwork of the media container. | /:/resources/show-fanart.jpg |
|
|
||||||
| `content` | *String* | :heavy_check_mark: | The content type or mode. | secondary |
|
|
||||||
| `identifier` | *String* | :heavy_check_mark: | An plugin identifier for the media container. | com.plexapp.plugins.library |
|
|
||||||
| `librarySectionID` | *long* | :heavy_check_mark: | The unique identifier for the library section. | 2 |
|
|
||||||
| `librarySectionTitle` | *String* | :heavy_check_mark: | The title of the library section. | TV Series |
|
|
||||||
| `librarySectionUUID` | *Optional\<String>* | :heavy_minus_sign: | The universally unique identifier for the library section. | e69655a2-ef48-4aba-bb19-0cc34d1e7d36 |
|
|
||||||
| `mediaTagPrefix` | *String* | :heavy_check_mark: | The prefix used for media tag resource paths. | /system/bundle/media/flags/ |
|
|
||||||
| `mediaTagVersion` | *long* | :heavy_check_mark: | The version number for media tags. | 1734362201 |
|
|
||||||
| `thumb` | *String* | :heavy_check_mark: | URL for the thumbnail image of the media container. | /:/resources/show.png |
|
|
||||||
| `nocache` | *boolean* | :heavy_check_mark: | Specifies whether caching is disabled. | true |
|
|
||||||
| `title1` | *String* | :heavy_check_mark: | The primary title of the media container. | TV Series |
|
|
||||||
| `title2` | *String* | :heavy_check_mark: | The secondary title of the media container. | By Starring Actor |
|
|
||||||
| `viewGroup` | *String* | :heavy_check_mark: | Identifier for the view group layout. | secondary |
|
|
||||||
| `meta` | [Optional\<GetAllMediaLibraryMeta>](../../models/operations/GetAllMediaLibraryMeta.md) | :heavy_minus_sign: | The Meta object is only included in the response if the `includeMeta` parameter is set to `1`.<br/> | |
|
|
||||||
| `metadata` | List\<[GetAllMediaLibraryMetadata](../../models/operations/GetAllMediaLibraryMetadata.md)> | :heavy_minus_sign: | An array of metadata items. | |
|
|
||||||
@@ -1,12 +0,0 @@
|
|||||||
# GetAllMediaLibraryMeta
|
|
||||||
|
|
||||||
The Meta object is only included in the response if the `includeMeta` parameter is set to `1`.
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description |
|
|
||||||
| -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- |
|
|
||||||
| `type` | List\<[GetAllMediaLibraryType](../../models/operations/GetAllMediaLibraryType.md)> | :heavy_minus_sign: | N/A |
|
|
||||||
| `fieldType` | List\<[GetAllMediaLibraryFieldType](../../models/operations/GetAllMediaLibraryFieldType.md)> | :heavy_minus_sign: | N/A |
|
|
||||||
@@ -1,23 +0,0 @@
|
|||||||
# GetAllMediaLibraryPart
|
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
|
||||||
| -------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- |
|
|
||||||
| `accessible` | *Optional\<Boolean>* | :heavy_minus_sign: | Indicates if the part is accessible. | true |
|
|
||||||
| `exists` | *Optional\<Boolean>* | :heavy_minus_sign: | Indicates if the part exists. | true |
|
|
||||||
| `id` | *long* | :heavy_check_mark: | Unique part identifier. | 418385 |
|
|
||||||
| `key` | *String* | :heavy_check_mark: | Key to access this part. | /library/parts/418385/1735864239/file.mkv |
|
|
||||||
| `indexes` | *Optional\<String>* | :heavy_minus_sign: | N/A | sd |
|
|
||||||
| `duration` | *Optional\<Integer>* | :heavy_minus_sign: | Duration of the part in milliseconds. | 9610350 |
|
|
||||||
| `file` | *String* | :heavy_check_mark: | File path for the part. | /mnt/Movies_1/W/Wicked (2024).mkv |
|
|
||||||
| `size` | *long* | :heavy_check_mark: | File size in bytes. | 30649952104 |
|
|
||||||
| `packetLength` | *Optional\<Integer>* | :heavy_minus_sign: | N/A | 188 |
|
|
||||||
| `container` | *Optional\<String>* | :heavy_minus_sign: | Container format of the part. | mkv |
|
|
||||||
| `videoProfile` | *Optional\<String>* | :heavy_minus_sign: | Video profile for the part. | main 10 |
|
|
||||||
| `audioProfile` | *Optional\<String>* | :heavy_minus_sign: | The audio profile used for the media (e.g., DTS, Dolby Digital, etc.). | dts |
|
|
||||||
| `has64bitOffsets` | *Optional\<Boolean>* | :heavy_minus_sign: | N/A | false |
|
|
||||||
| `optimizedForStreaming` | [Optional\<GetAllMediaLibraryLibraryOptimizedForStreaming>](../../models/operations/GetAllMediaLibraryLibraryOptimizedForStreaming.md) | :heavy_minus_sign: | Has this media been optimized for streaming. NOTE: This can be 0, 1, false or true | |
|
|
||||||
| `hasThumbnail` | [Optional\<GetAllMediaLibraryHasThumbnail>](../../models/operations/GetAllMediaLibraryHasThumbnail.md) | :heavy_minus_sign: | N/A | 1 |
|
|
||||||
| `stream` | List\<[GetAllMediaLibraryStream](../../models/operations/GetAllMediaLibraryStream.md)> | :heavy_minus_sign: | An array of streams for this part. | |
|
|
||||||
@@ -1,22 +0,0 @@
|
|||||||
# GetAllMediaLibraryQueryParamType
|
|
||||||
|
|
||||||
The type of media to retrieve or filter by.
|
|
||||||
1 = movie
|
|
||||||
2 = show
|
|
||||||
3 = season
|
|
||||||
4 = episode
|
|
||||||
E.g. A movie library will not return anything with type 3 as there are no seasons for movie libraries
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## Values
|
|
||||||
|
|
||||||
| Name | Value |
|
|
||||||
| --------- | --------- |
|
|
||||||
| `Movie` | 1 |
|
|
||||||
| `TvShow` | 2 |
|
|
||||||
| `Season` | 3 |
|
|
||||||
| `Episode` | 4 |
|
|
||||||
| `Audio` | 8 |
|
|
||||||
| `Album` | 9 |
|
|
||||||
| `Track` | 10 |
|
|
||||||
@@ -1,10 +0,0 @@
|
|||||||
# GetAllMediaLibraryResponseBody
|
|
||||||
|
|
||||||
Successful response containing media container data.
|
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description |
|
|
||||||
| ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- |
|
|
||||||
| `mediaContainer` | [Optional\<GetAllMediaLibraryMediaContainer>](../../models/operations/GetAllMediaLibraryMediaContainer.md) | :heavy_minus_sign: | N/A |
|
|
||||||
@@ -1,15 +0,0 @@
|
|||||||
# GetAllMediaLibrarySort
|
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
|
||||||
| -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- |
|
|
||||||
| `default_` | *Optional\<String>* | :heavy_minus_sign: | N/A | asc |
|
|
||||||
| `active` | *Optional\<Boolean>* | :heavy_minus_sign: | N/A | false |
|
|
||||||
| `activeDirection` | [Optional\<GetAllMediaLibraryActiveDirection>](../../models/operations/GetAllMediaLibraryActiveDirection.md) | :heavy_minus_sign: | The direction of the sort. Can be either `asc` or `desc`.<br/> | asc |
|
|
||||||
| `defaultDirection` | [Optional\<GetAllMediaLibraryDefaultDirection>](../../models/operations/GetAllMediaLibraryDefaultDirection.md) | :heavy_minus_sign: | The direction of the sort. Can be either `asc` or `desc`.<br/> | asc |
|
|
||||||
| `descKey` | *Optional\<String>* | :heavy_minus_sign: | N/A | titleSort:desc |
|
|
||||||
| `firstCharacterKey` | *Optional\<String>* | :heavy_minus_sign: | N/A | /library/sections/2/firstCharacter |
|
|
||||||
| `key` | *String* | :heavy_check_mark: | N/A | titleSort |
|
|
||||||
| `title` | *String* | :heavy_check_mark: | N/A | Title |
|
|
||||||
@@ -1,56 +0,0 @@
|
|||||||
# GetAllMediaLibraryStream
|
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
|
||||||
| -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- |
|
|
||||||
| `id` | *long* | :heavy_check_mark: | Unique stream identifier. | 1002625 |
|
|
||||||
| `streamType` | *int* | :heavy_check_mark: | Stream type (1=video, 2=audio, 3=subtitle). | 1 |
|
|
||||||
| `default_` | *Optional\<Boolean>* | :heavy_minus_sign: | Indicates if this stream is default. | true |
|
|
||||||
| `codec` | *String* | :heavy_check_mark: | Codec used by the stream. | hevc |
|
|
||||||
| `index` | *int* | :heavy_check_mark: | Index of the stream. | 0 |
|
|
||||||
| `bitrate` | *Optional\<Integer>* | :heavy_minus_sign: | Bitrate of the stream. | 24743 |
|
|
||||||
| `language` | *Optional\<String>* | :heavy_minus_sign: | Language of the stream. | English |
|
|
||||||
| `languageTag` | *Optional\<String>* | :heavy_minus_sign: | Language tag (e.g., en). | en |
|
|
||||||
| `languageCode` | *Optional\<String>* | :heavy_minus_sign: | ISO language code. | eng |
|
|
||||||
| `headerCompression` | *Optional\<Boolean>* | :heavy_minus_sign: | Indicates whether header compression is enabled. | true |
|
|
||||||
| `doviblCompatID` | *Optional\<Integer>* | :heavy_minus_sign: | Dolby Vision BL compatibility ID. | 1 |
|
|
||||||
| `doviblPresent` | *Optional\<Boolean>* | :heavy_minus_sign: | Indicates if Dolby Vision BL is present. | true |
|
|
||||||
| `dovielPresent` | *Optional\<Boolean>* | :heavy_minus_sign: | Indicates if Dolby Vision EL is present. | false |
|
|
||||||
| `doviLevel` | *Optional\<Integer>* | :heavy_minus_sign: | Dolby Vision level. | 6 |
|
|
||||||
| `doviPresent` | *Optional\<Boolean>* | :heavy_minus_sign: | Indicates if Dolby Vision is present. | true |
|
|
||||||
| `doviProfile` | *Optional\<Integer>* | :heavy_minus_sign: | Dolby Vision profile. | 8 |
|
|
||||||
| `dovirpuPresent` | *Optional\<Boolean>* | :heavy_minus_sign: | Indicates if Dolby Vision RPU is present. | true |
|
|
||||||
| `doviVersion` | *Optional\<String>* | :heavy_minus_sign: | Dolby Vision version. | 1.0 |
|
|
||||||
| `bitDepth` | *Optional\<Integer>* | :heavy_minus_sign: | Bit depth of the video stream. | 10 |
|
|
||||||
| `chromaLocation` | *Optional\<String>* | :heavy_minus_sign: | Chroma sample location. | topleft |
|
|
||||||
| `chromaSubsampling` | *Optional\<String>* | :heavy_minus_sign: | Chroma subsampling format. | 4:2:0 |
|
|
||||||
| `codedHeight` | *Optional\<Integer>* | :heavy_minus_sign: | Coded video height. | 1608 |
|
|
||||||
| `codedWidth` | *Optional\<Integer>* | :heavy_minus_sign: | Coded video width. | 3840 |
|
|
||||||
| `closedCaptions` | *Optional\<Boolean>* | :heavy_minus_sign: | N/A | true |
|
|
||||||
| `colorPrimaries` | *Optional\<String>* | :heavy_minus_sign: | Color primaries used. | bt2020 |
|
|
||||||
| `colorRange` | *Optional\<String>* | :heavy_minus_sign: | Color range (e.g., tv). | tv |
|
|
||||||
| `colorSpace` | *Optional\<String>* | :heavy_minus_sign: | Color space. | bt2020nc |
|
|
||||||
| `colorTrc` | *Optional\<String>* | :heavy_minus_sign: | Color transfer characteristics. | smpte2084 |
|
|
||||||
| `frameRate` | *Optional\<Float>* | :heavy_minus_sign: | Frame rate of the stream. | 23.976 |
|
|
||||||
| `height` | *Optional\<Integer>* | :heavy_minus_sign: | Height of the video stream. | 1602 |
|
|
||||||
| `level` | *Optional\<Integer>* | :heavy_minus_sign: | Video level. | 150 |
|
|
||||||
| `original` | *Optional\<Boolean>* | :heavy_minus_sign: | Indicates if this is the original stream. | true |
|
|
||||||
| `hasScalingMatrix` | *Optional\<Boolean>* | :heavy_minus_sign: | N/A | false |
|
|
||||||
| `profile` | *Optional\<String>* | :heavy_minus_sign: | Video profile. | main 10 |
|
|
||||||
| `scanType` | *Optional\<String>* | :heavy_minus_sign: | N/A | progressive |
|
|
||||||
| `embeddedInVideo` | *Optional\<String>* | :heavy_minus_sign: | N/A | progressive |
|
|
||||||
| `refFrames` | *Optional\<Integer>* | :heavy_minus_sign: | Number of reference frames. | 1 |
|
|
||||||
| `width` | *Optional\<Integer>* | :heavy_minus_sign: | Width of the video stream. | 3840 |
|
|
||||||
| `displayTitle` | *String* | :heavy_check_mark: | Display title for the stream. | 4K DoVi/HDR10 (HEVC Main 10) |
|
|
||||||
| `extendedDisplayTitle` | *String* | :heavy_check_mark: | Extended display title for the stream. | 4K DoVi/HDR10 (HEVC Main 10) |
|
|
||||||
| `selected` | *Optional\<Boolean>* | :heavy_minus_sign: | Indicates if this stream is selected (applicable for audio streams). | true |
|
|
||||||
| `forced` | *Optional\<Boolean>* | :heavy_minus_sign: | N/A | true |
|
|
||||||
| `channels` | *Optional\<Integer>* | :heavy_minus_sign: | Number of audio channels (for audio streams). | 6 |
|
|
||||||
| `audioChannelLayout` | *Optional\<String>* | :heavy_minus_sign: | Audio channel layout. | 5.1(side) |
|
|
||||||
| `samplingRate` | *Optional\<Integer>* | :heavy_minus_sign: | Sampling rate for the audio stream. | 48000 |
|
|
||||||
| `canAutoSync` | *Optional\<Boolean>* | :heavy_minus_sign: | Indicates if the stream can auto-sync. | false |
|
|
||||||
| `hearingImpaired` | *Optional\<Boolean>* | :heavy_minus_sign: | Indicates if the stream is for the hearing impaired. | true |
|
|
||||||
| `dub` | *Optional\<Boolean>* | :heavy_minus_sign: | Indicates if the stream is a dub. | true |
|
|
||||||
| `title` | *Optional\<String>* | :heavy_minus_sign: | Optional title for the stream (e.g., language variant). | SDH |
|
|
||||||
@@ -1,15 +0,0 @@
|
|||||||
# GetAllMediaLibraryType
|
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
|
||||||
| -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- |
|
|
||||||
| `key` | *String* | :heavy_check_mark: | N/A | /library/sections/2/all?type=2 |
|
|
||||||
| `type` | *String* | :heavy_check_mark: | N/A | filter |
|
|
||||||
| `subtype` | *Optional\<String>* | :heavy_minus_sign: | N/A | clip |
|
|
||||||
| `title` | *String* | :heavy_check_mark: | N/A | TV Shows |
|
|
||||||
| `active` | *boolean* | :heavy_check_mark: | N/A | false |
|
|
||||||
| `filter` | List\<[GetAllMediaLibraryFilter](../../models/operations/GetAllMediaLibraryFilter.md)> | :heavy_minus_sign: | N/A | |
|
|
||||||
| `sort` | List\<[GetAllMediaLibrarySort](../../models/operations/GetAllMediaLibrarySort.md)> | :heavy_minus_sign: | N/A | |
|
|
||||||
| `field` | List\<[GetAllMediaLibraryField](../../models/operations/GetAllMediaLibraryField.md)> | :heavy_minus_sign: | N/A | |
|
|
||||||
@@ -11,12 +11,14 @@ E.g. A movie library will not return anything with type 3 as there are no season
|
|||||||
|
|
||||||
## Values
|
## Values
|
||||||
|
|
||||||
| Name | Value |
|
| Name | Value |
|
||||||
| --------- | --------- |
|
| ------------ | ------------ |
|
||||||
| `Movie` | 1 |
|
| `Movie` | 1 |
|
||||||
| `TvShow` | 2 |
|
| `TvShow` | 2 |
|
||||||
| `Season` | 3 |
|
| `Season` | 3 |
|
||||||
| `Episode` | 4 |
|
| `Episode` | 4 |
|
||||||
| `Audio` | 8 |
|
| `Artist` | 5 |
|
||||||
| `Album` | 9 |
|
| `Album` | 6 |
|
||||||
| `Track` | 10 |
|
| `Track` | 7 |
|
||||||
|
| `PhotoAlbum` | 8 |
|
||||||
|
| `Photo` | 9 |
|
||||||
@@ -11,12 +11,14 @@ E.g. A movie library will not return anything with type 3 as there are no season
|
|||||||
|
|
||||||
## Values
|
## Values
|
||||||
|
|
||||||
| Name | Value |
|
| Name | Value |
|
||||||
| --------- | --------- |
|
| ------------ | ------------ |
|
||||||
| `Movie` | 1 |
|
| `Movie` | 1 |
|
||||||
| `TvShow` | 2 |
|
| `TvShow` | 2 |
|
||||||
| `Season` | 3 |
|
| `Season` | 3 |
|
||||||
| `Episode` | 4 |
|
| `Episode` | 4 |
|
||||||
| `Audio` | 8 |
|
| `Artist` | 5 |
|
||||||
| `Album` | 9 |
|
| `Album` | 6 |
|
||||||
| `Track` | 10 |
|
| `Track` | 7 |
|
||||||
|
| `PhotoAlbum` | 8 |
|
||||||
|
| `Photo` | 9 |
|
||||||
@@ -3,7 +3,7 @@
|
|||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
| Field | Type | Required | Description | Example |
|
||||||
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||||
| `includeDetails` | [Optional\<IncludeDetails>](../../models/operations/IncludeDetails.md) | :heavy_minus_sign: | Whether or not to include details for a section (types, filters, and sorts). <br/>Only exists for backwards compatibility, media providers other than the server libraries have it on always.<br/> | |
|
| `includeDetails` | [Optional\<IncludeDetails>](../../models/operations/IncludeDetails.md) | :heavy_minus_sign: | Whether or not to include details for a section (types, filters, and sorts).<br/>Only exists for backwards compatibility, media providers other than the server libraries have it on always.<br/> | |
|
||||||
| `sectionKey` | *int* | :heavy_check_mark: | The unique key of the Plex library. <br/>Note: This is unique in the context of the Plex server.<br/> | 9518 |
|
| `sectionKey` | *int* | :heavy_check_mark: | The unique key of the Plex library. <br/>Note: This is unique in the context of the Plex server.<br/> | 9518 |
|
||||||
@@ -1,16 +1,20 @@
|
|||||||
# GetLibraryItemsLibraryType
|
# GetLibraryItemsLibraryType
|
||||||
|
|
||||||
The type of media content
|
The type of media content in the Plex library. This can represent videos, music, or photos.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## Values
|
## Values
|
||||||
|
|
||||||
| Name | Value |
|
| Name | Value |
|
||||||
| --------- | --------- |
|
| ------------ | ------------ |
|
||||||
| `Movie` | movie |
|
| `Movie` | movie |
|
||||||
| `TvShow` | show |
|
| `TvShow` | show |
|
||||||
| `Season` | season |
|
| `Season` | season |
|
||||||
| `Episode` | episode |
|
| `Episode` | episode |
|
||||||
| `Artist` | artist |
|
| `Artist` | artist |
|
||||||
| `Album` | album |
|
| `Album` | album |
|
||||||
|
| `Track` | track |
|
||||||
|
| `PhotoAlbum` | photoalbum |
|
||||||
|
| `Photo` | photo |
|
||||||
|
| `Collection` | collection |
|
||||||
@@ -13,7 +13,7 @@
|
|||||||
| `librarySectionID` | *Optional\<Long>* | :heavy_minus_sign: | N/A | 1 |
|
| `librarySectionID` | *Optional\<Long>* | :heavy_minus_sign: | N/A | 1 |
|
||||||
| `librarySectionTitle` | *Optional\<String>* | :heavy_minus_sign: | N/A | Movies |
|
| `librarySectionTitle` | *Optional\<String>* | :heavy_minus_sign: | N/A | Movies |
|
||||||
| `librarySectionKey` | *Optional\<String>* | :heavy_minus_sign: | N/A | /library/sections/1 |
|
| `librarySectionKey` | *Optional\<String>* | :heavy_minus_sign: | N/A | /library/sections/1 |
|
||||||
| `type` | [GetLibraryItemsLibraryType](../../models/operations/GetLibraryItemsLibraryType.md) | :heavy_check_mark: | The type of media content<br/> | movie |
|
| `type` | [GetLibraryItemsLibraryType](../../models/operations/GetLibraryItemsLibraryType.md) | :heavy_check_mark: | The type of media content in the Plex library. This can represent videos, music, or photos.<br/> | movie |
|
||||||
| `title` | *String* | :heavy_check_mark: | N/A | Avatar: The Way of Water |
|
| `title` | *String* | :heavy_check_mark: | N/A | Avatar: The Way of Water |
|
||||||
| `slug` | *Optional\<String>* | :heavy_minus_sign: | N/A | 4-for-texas |
|
| `slug` | *Optional\<String>* | :heavy_minus_sign: | N/A | 4-for-texas |
|
||||||
| `contentRating` | *Optional\<String>* | :heavy_minus_sign: | N/A | PG-13 |
|
| `contentRating` | *Optional\<String>* | :heavy_minus_sign: | N/A | PG-13 |
|
||||||
|
|||||||
@@ -11,12 +11,14 @@ E.g. A movie library will not return anything with type 3 as there are no season
|
|||||||
|
|
||||||
## Values
|
## Values
|
||||||
|
|
||||||
| Name | Value |
|
| Name | Value |
|
||||||
| --------- | --------- |
|
| ------------ | ------------ |
|
||||||
| `Movie` | 1 |
|
| `Movie` | 1 |
|
||||||
| `TvShow` | 2 |
|
| `TvShow` | 2 |
|
||||||
| `Season` | 3 |
|
| `Season` | 3 |
|
||||||
| `Episode` | 4 |
|
| `Episode` | 4 |
|
||||||
| `Audio` | 8 |
|
| `Artist` | 5 |
|
||||||
| `Album` | 9 |
|
| `Album` | 6 |
|
||||||
| `Track` | 10 |
|
| `Track` | 7 |
|
||||||
|
| `PhotoAlbum` | 8 |
|
||||||
|
| `Photo` | 9 |
|
||||||
@@ -1,4 +1,4 @@
|
|||||||
# GetAllMediaLibraryActiveDirection
|
# GetLibrarySectionsAllActiveDirection
|
||||||
|
|
||||||
The direction of the sort. Can be either `asc` or `desc`.
|
The direction of the sort. Can be either `asc` or `desc`.
|
||||||
|
|
||||||
@@ -1,4 +1,4 @@
|
|||||||
# GetAllMediaLibraryCollection
|
# GetLibrarySectionsAllCollection
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
@@ -1,4 +1,4 @@
|
|||||||
# GetAllMediaLibraryCountry
|
# GetLibrarySectionsAllCountry
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
@@ -1,4 +1,4 @@
|
|||||||
# GetAllMediaLibraryDefaultDirection
|
# GetLibrarySectionsAllDefaultDirection
|
||||||
|
|
||||||
The direction of the sort. Can be either `asc` or `desc`.
|
The direction of the sort. Can be either `asc` or `desc`.
|
||||||
|
|
||||||
@@ -1,4 +1,4 @@
|
|||||||
# GetAllMediaLibraryDirector
|
# GetLibrarySectionsAllDirector
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
@@ -1,4 +1,4 @@
|
|||||||
# GetAllMediaLibraryField
|
# GetLibrarySectionsAllField
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
9
docs/models/operations/GetLibrarySectionsAllFieldType.md
Normal file
9
docs/models/operations/GetLibrarySectionsAllFieldType.md
Normal file
@@ -0,0 +1,9 @@
|
|||||||
|
# GetLibrarySectionsAllFieldType
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ |
|
||||||
|
| `type` | *String* | :heavy_check_mark: | N/A | tag |
|
||||||
|
| `operator` | List\<[GetLibrarySectionsAllOperator](../../models/operations/GetLibrarySectionsAllOperator.md)> | :heavy_check_mark: | N/A | |
|
||||||
@@ -1,4 +1,4 @@
|
|||||||
# GetAllMediaLibraryFilter
|
# GetLibrarySectionsAllFilter
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
@@ -1,4 +1,4 @@
|
|||||||
# GetAllMediaLibraryGenre
|
# GetLibrarySectionsAllGenre
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
8
docs/models/operations/GetLibrarySectionsAllGuids.md
Normal file
8
docs/models/operations/GetLibrarySectionsAllGuids.md
Normal file
@@ -0,0 +1,8 @@
|
|||||||
|
# GetLibrarySectionsAllGuids
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||||
|
| `id` | *String* | :heavy_check_mark: | The unique identifier for the Guid. Can be prefixed with imdb://, tmdb://, tvdb://<br/> | {<br/>"imdbExample": {<br/>"summary": "IMDB example",<br/>"value": "imdb://tt13015952"<br/>},<br/>"tmdbExample": {<br/>"summary": "TMDB example",<br/>"value": "tmdb://2434012"<br/>},<br/>"tvdbExample": {<br/>"summary": "TVDB example",<br/>"value": "tvdb://7945991"<br/>}<br/>} |
|
||||||
@@ -1,4 +1,4 @@
|
|||||||
# GetAllMediaLibraryHasThumbnail
|
# GetLibrarySectionsAllHasThumbnail
|
||||||
|
|
||||||
Indicates if the part has a thumbnail.
|
Indicates if the part has a thumbnail.
|
||||||
|
|
||||||
10
docs/models/operations/GetLibrarySectionsAllImage.md
Normal file
10
docs/models/operations/GetLibrarySectionsAllImage.md
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
# GetLibrarySectionsAllImage
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| --------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- |
|
||||||
|
| `alt` | *String* | :heavy_check_mark: | N/A | Episode 1 |
|
||||||
|
| `type` | [GetLibrarySectionsAllLibraryResponseType](../../models/operations/GetLibrarySectionsAllLibraryResponseType.md) | :heavy_check_mark: | N/A | background |
|
||||||
|
| `url` | *String* | :heavy_check_mark: | N/A | /library/metadata/45521/thumb/1644710589 |
|
||||||
@@ -1,4 +1,4 @@
|
|||||||
# GetAllMediaLibraryLibraryOptimizedForStreaming
|
# GetLibrarySectionsAllLibraryOptimizedForStreaming
|
||||||
|
|
||||||
Has this media been optimized for streaming. NOTE: This can be 0, 1, false or true
|
Has this media been optimized for streaming. NOTE: This can be 0, 1, false or true
|
||||||
|
|
||||||
@@ -0,0 +1,11 @@
|
|||||||
|
# GetLibrarySectionsAllLibraryResponseType
|
||||||
|
|
||||||
|
|
||||||
|
## Values
|
||||||
|
|
||||||
|
| Name | Value |
|
||||||
|
| -------------- | -------------- |
|
||||||
|
| `COVER_POSTER` | coverPoster |
|
||||||
|
| `BACKGROUND` | background |
|
||||||
|
| `SNAPSHOT` | snapshot |
|
||||||
|
| `CLEAR_LOGO` | clearLogo |
|
||||||
20
docs/models/operations/GetLibrarySectionsAllLibraryType.md
Normal file
20
docs/models/operations/GetLibrarySectionsAllLibraryType.md
Normal file
@@ -0,0 +1,20 @@
|
|||||||
|
# GetLibrarySectionsAllLibraryType
|
||||||
|
|
||||||
|
The type of media content in the Plex library. This can represent videos, music, or photos.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
## Values
|
||||||
|
|
||||||
|
| Name | Value |
|
||||||
|
| ------------ | ------------ |
|
||||||
|
| `Movie` | movie |
|
||||||
|
| `TvShow` | show |
|
||||||
|
| `Season` | season |
|
||||||
|
| `Episode` | episode |
|
||||||
|
| `Artist` | artist |
|
||||||
|
| `Album` | album |
|
||||||
|
| `Track` | track |
|
||||||
|
| `PhotoAlbum` | photoalbum |
|
||||||
|
| `Photo` | photo |
|
||||||
|
| `Collection` | collection |
|
||||||
26
docs/models/operations/GetLibrarySectionsAllMedia.md
Normal file
26
docs/models/operations/GetLibrarySectionsAllMedia.md
Normal file
@@ -0,0 +1,26 @@
|
|||||||
|
# GetLibrarySectionsAllMedia
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ |
|
||||||
|
| `id` | *long* | :heavy_check_mark: | Unique media identifier. | 387322 |
|
||||||
|
| `duration` | *Optional\<Integer>* | :heavy_minus_sign: | Duration of the media in milliseconds. | 9610350 |
|
||||||
|
| `bitrate` | *Optional\<Integer>* | :heavy_minus_sign: | Bitrate in bits per second. | 25512 |
|
||||||
|
| `width` | *Optional\<Integer>* | :heavy_minus_sign: | Video width in pixels. | 3840 |
|
||||||
|
| `height` | *Optional\<Integer>* | :heavy_minus_sign: | Video height in pixels. | 1602 |
|
||||||
|
| `aspectRatio` | *Optional\<Float>* | :heavy_minus_sign: | Aspect ratio of the video. | 2.35 |
|
||||||
|
| `audioChannels` | *Optional\<Integer>* | :heavy_minus_sign: | Number of audio channels. | 6 |
|
||||||
|
| `displayOffset` | *Optional\<Integer>* | :heavy_minus_sign: | N/A | 50 |
|
||||||
|
| `audioCodec` | *Optional\<String>* | :heavy_minus_sign: | Audio codec used. | eac3 |
|
||||||
|
| `videoCodec` | *Optional\<String>* | :heavy_minus_sign: | Video codec used. | hevc |
|
||||||
|
| `videoResolution` | *Optional\<String>* | :heavy_minus_sign: | Video resolution (e.g., 4k). | 4k |
|
||||||
|
| `container` | *Optional\<String>* | :heavy_minus_sign: | File container type. | mkv |
|
||||||
|
| `videoFrameRate` | *Optional\<String>* | :heavy_minus_sign: | Frame rate of the video. Values found include NTSC, PAL, 24p<br/> | 24p |
|
||||||
|
| `videoProfile` | *Optional\<String>* | :heavy_minus_sign: | Video profile (e.g., main 10). | main 10 |
|
||||||
|
| `hasVoiceActivity` | *Optional\<Boolean>* | :heavy_minus_sign: | Indicates whether voice activity is detected. | false |
|
||||||
|
| `audioProfile` | *Optional\<String>* | :heavy_minus_sign: | The audio profile used for the media (e.g., DTS, Dolby Digital, etc.). | dts |
|
||||||
|
| `optimizedForStreaming` | [Optional\<GetLibrarySectionsAllOptimizedForStreaming>](../../models/operations/GetLibrarySectionsAllOptimizedForStreaming.md) | :heavy_minus_sign: | Has this media been optimized for streaming. NOTE: This can be 0, 1, false or true | |
|
||||||
|
| `has64bitOffsets` | *Optional\<Boolean>* | :heavy_minus_sign: | N/A | false |
|
||||||
|
| `part` | List\<[GetLibrarySectionsAllPart](../../models/operations/GetLibrarySectionsAllPart.md)> | :heavy_minus_sign: | An array of parts for this media item. | |
|
||||||
@@ -0,0 +1,26 @@
|
|||||||
|
# GetLibrarySectionsAllMediaContainer
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ |
|
||||||
|
| `size` | *int* | :heavy_check_mark: | Number of media items returned in this response. | 50 |
|
||||||
|
| `totalSize` | *int* | :heavy_check_mark: | Total number of media items in the library. | 50 |
|
||||||
|
| `offset` | *long* | :heavy_check_mark: | Offset value for pagination. | 0 |
|
||||||
|
| `allowSync` | *boolean* | :heavy_check_mark: | Indicates whether syncing is allowed. | false |
|
||||||
|
| `art` | *String* | :heavy_check_mark: | URL for the background artwork of the media container. | /:/resources/show-fanart.jpg |
|
||||||
|
| `content` | *String* | :heavy_check_mark: | The content type or mode. | secondary |
|
||||||
|
| `identifier` | *String* | :heavy_check_mark: | An plugin identifier for the media container. | com.plexapp.plugins.library |
|
||||||
|
| `librarySectionID` | *long* | :heavy_check_mark: | The unique identifier for the library section. | 2 |
|
||||||
|
| `librarySectionTitle` | *String* | :heavy_check_mark: | The title of the library section. | TV Series |
|
||||||
|
| `librarySectionUUID` | *Optional\<String>* | :heavy_minus_sign: | The universally unique identifier for the library section. | e69655a2-ef48-4aba-bb19-0cc34d1e7d36 |
|
||||||
|
| `mediaTagPrefix` | *String* | :heavy_check_mark: | The prefix used for media tag resource paths. | /system/bundle/media/flags/ |
|
||||||
|
| `mediaTagVersion` | *long* | :heavy_check_mark: | The version number for media tags. | 1734362201 |
|
||||||
|
| `thumb` | *String* | :heavy_check_mark: | URL for the thumbnail image of the media container. | /:/resources/show.png |
|
||||||
|
| `nocache` | *boolean* | :heavy_check_mark: | Specifies whether caching is disabled. | true |
|
||||||
|
| `title1` | *String* | :heavy_check_mark: | The primary title of the media container. | TV Series |
|
||||||
|
| `title2` | *String* | :heavy_check_mark: | The secondary title of the media container. | By Starring Actor |
|
||||||
|
| `viewGroup` | *String* | :heavy_check_mark: | Identifier for the view group layout. | secondary |
|
||||||
|
| `meta` | [Optional\<GetLibrarySectionsAllMeta>](../../models/operations/GetLibrarySectionsAllMeta.md) | :heavy_minus_sign: | The Meta object is only included in the response if the `includeMeta` parameter is set to `1`.<br/> | |
|
||||||
|
| `metadata` | List\<[GetLibrarySectionsAllMetadata](../../models/operations/GetLibrarySectionsAllMetadata.md)> | :heavy_minus_sign: | An array of metadata items. | |
|
||||||
12
docs/models/operations/GetLibrarySectionsAllMeta.md
Normal file
12
docs/models/operations/GetLibrarySectionsAllMeta.md
Normal file
@@ -0,0 +1,12 @@
|
|||||||
|
# GetLibrarySectionsAllMeta
|
||||||
|
|
||||||
|
The Meta object is only included in the response if the `includeMeta` parameter is set to `1`.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- |
|
||||||
|
| `type` | List\<[GetLibrarySectionsAllType](../../models/operations/GetLibrarySectionsAllType.md)> | :heavy_minus_sign: | N/A |
|
||||||
|
| `fieldType` | List\<[GetLibrarySectionsAllFieldType](../../models/operations/GetLibrarySectionsAllFieldType.md)> | :heavy_minus_sign: | N/A |
|
||||||
@@ -1,4 +1,4 @@
|
|||||||
# GetAllMediaLibraryMetadata
|
# GetLibrarySectionsAllMetadata
|
||||||
|
|
||||||
Unknown
|
Unknown
|
||||||
|
|
||||||
@@ -13,7 +13,7 @@ Unknown
|
|||||||
| `guid` | *String* | :heavy_check_mark: | The globally unique identifier for the media item. | plex://movie/5d7768ba96b655001fdc0408 |
|
| `guid` | *String* | :heavy_check_mark: | The globally unique identifier for the media item. | plex://movie/5d7768ba96b655001fdc0408 |
|
||||||
| `slug` | *String* | :heavy_check_mark: | A URL‐friendly version of the media title. | 4-for-texas |
|
| `slug` | *String* | :heavy_check_mark: | A URL‐friendly version of the media title. | 4-for-texas |
|
||||||
| `studio` | *Optional\<String>* | :heavy_minus_sign: | The studio that produced the media item. | 20th Century Studios |
|
| `studio` | *Optional\<String>* | :heavy_minus_sign: | The studio that produced the media item. | 20th Century Studios |
|
||||||
| `type` | [GetAllMediaLibraryLibraryType](../../models/operations/GetAllMediaLibraryLibraryType.md) | :heavy_check_mark: | N/A | movie |
|
| `type` | [GetLibrarySectionsAllLibraryType](../../models/operations/GetLibrarySectionsAllLibraryType.md) | :heavy_check_mark: | N/A | movie |
|
||||||
| `title` | *String* | :heavy_check_mark: | The title of the media item. | Avatar: The Way of Water |
|
| `title` | *String* | :heavy_check_mark: | The title of the media item. | Avatar: The Way of Water |
|
||||||
| `titleSort` | *String* | :heavy_check_mark: | The sort title used for ordering media items. | Whale |
|
| `titleSort` | *String* | :heavy_check_mark: | The sort title used for ordering media items. | Whale |
|
||||||
| `contentRating` | *Optional\<String>* | :heavy_minus_sign: | The content rating for the media item. | PG-13 |
|
| `contentRating` | *Optional\<String>* | :heavy_minus_sign: | The content rating for the media item. | PG-13 |
|
||||||
@@ -62,13 +62,13 @@ Unknown
|
|||||||
| `createdAtTZOffset` | *Optional\<String>* | :heavy_minus_sign: | The time zone offset for the creation timestamp, represented as a string. This offset indicates the difference from UTC. | 0 |
|
| `createdAtTZOffset` | *Optional\<String>* | :heavy_minus_sign: | The time zone offset for the creation timestamp, represented as a string. This offset indicates the difference from UTC. | 0 |
|
||||||
| `lastViewedAt` | *Optional\<Integer>* | :heavy_minus_sign: | Unix timestamp for when the media item was last viewed. | 1682752242 |
|
| `lastViewedAt` | *Optional\<Integer>* | :heavy_minus_sign: | Unix timestamp for when the media item was last viewed. | 1682752242 |
|
||||||
| `userRating` | *Optional\<Float>* | :heavy_minus_sign: | The rating provided by a user for the item. This value is expressed as a decimal number. | 10 |
|
| `userRating` | *Optional\<Float>* | :heavy_minus_sign: | The rating provided by a user for the item. This value is expressed as a decimal number. | 10 |
|
||||||
| `image` | List\<[GetAllMediaLibraryImage](../../models/operations/GetAllMediaLibraryImage.md)> | :heavy_minus_sign: | N/A | |
|
| `image` | List\<[GetLibrarySectionsAllImage](../../models/operations/GetLibrarySectionsAllImage.md)> | :heavy_minus_sign: | N/A | |
|
||||||
| `ultraBlurColors` | [Optional\<GetAllMediaLibraryUltraBlurColors>](../../models/operations/GetAllMediaLibraryUltraBlurColors.md) | :heavy_minus_sign: | N/A | |
|
| `ultraBlurColors` | [Optional\<GetLibrarySectionsAllUltraBlurColors>](../../models/operations/GetLibrarySectionsAllUltraBlurColors.md) | :heavy_minus_sign: | N/A | |
|
||||||
| `media` | List\<[GetAllMediaLibraryMedia](../../models/operations/GetAllMediaLibraryMedia.md)> | :heavy_minus_sign: | N/A | |
|
| `guids` | List\<[GetLibrarySectionsAllGuids](../../models/operations/GetLibrarySectionsAllGuids.md)> | :heavy_minus_sign: | N/A | |
|
||||||
| `genre` | List\<[GetAllMediaLibraryGenre](../../models/operations/GetAllMediaLibraryGenre.md)> | :heavy_minus_sign: | N/A | |
|
| `media` | List\<[GetLibrarySectionsAllMedia](../../models/operations/GetLibrarySectionsAllMedia.md)> | :heavy_minus_sign: | N/A | |
|
||||||
| `country` | List\<[GetAllMediaLibraryCountry](../../models/operations/GetAllMediaLibraryCountry.md)> | :heavy_minus_sign: | N/A | |
|
| `genre` | List\<[GetLibrarySectionsAllGenre](../../models/operations/GetLibrarySectionsAllGenre.md)> | :heavy_minus_sign: | N/A | |
|
||||||
| `director` | List\<[GetAllMediaLibraryDirector](../../models/operations/GetAllMediaLibraryDirector.md)> | :heavy_minus_sign: | N/A | |
|
| `country` | List\<[GetLibrarySectionsAllCountry](../../models/operations/GetLibrarySectionsAllCountry.md)> | :heavy_minus_sign: | N/A | |
|
||||||
| `writer` | List\<[GetAllMediaLibraryWriter](../../models/operations/GetAllMediaLibraryWriter.md)> | :heavy_minus_sign: | N/A | |
|
| `director` | List\<[GetLibrarySectionsAllDirector](../../models/operations/GetLibrarySectionsAllDirector.md)> | :heavy_minus_sign: | N/A | |
|
||||||
| `role` | List\<[GetAllMediaLibraryRole](../../models/operations/GetAllMediaLibraryRole.md)> | :heavy_minus_sign: | N/A | |
|
| `writer` | List\<[GetLibrarySectionsAllWriter](../../models/operations/GetLibrarySectionsAllWriter.md)> | :heavy_minus_sign: | N/A | |
|
||||||
| `guids` | List\<[GetAllMediaLibraryGuids](../../models/operations/GetAllMediaLibraryGuids.md)> | :heavy_minus_sign: | N/A | |
|
| `role` | List\<[GetLibrarySectionsAllRole](../../models/operations/GetLibrarySectionsAllRole.md)> | :heavy_minus_sign: | N/A | |
|
||||||
| `collection` | List\<[GetAllMediaLibraryCollection](../../models/operations/GetAllMediaLibraryCollection.md)> | :heavy_minus_sign: | N/A | |
|
| `collection` | List\<[GetLibrarySectionsAllCollection](../../models/operations/GetLibrarySectionsAllCollection.md)> | :heavy_minus_sign: | N/A | |
|
||||||
@@ -1,4 +1,4 @@
|
|||||||
# GetAllMediaLibraryOperator
|
# GetLibrarySectionsAllOperator
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
@@ -1,4 +1,4 @@
|
|||||||
# GetAllMediaLibraryOptimizedForStreaming
|
# GetLibrarySectionsAllOptimizedForStreaming
|
||||||
|
|
||||||
Has this media been optimized for streaming. NOTE: This can be 0, 1, false or true
|
Has this media been optimized for streaming. NOTE: This can be 0, 1, false or true
|
||||||
|
|
||||||
@@ -1,4 +1,4 @@
|
|||||||
# GetAllMediaLibraryOptimizedForStreaming1
|
# GetLibrarySectionsAllOptimizedForStreaming1
|
||||||
|
|
||||||
|
|
||||||
## Values
|
## Values
|
||||||
23
docs/models/operations/GetLibrarySectionsAllPart.md
Normal file
23
docs/models/operations/GetLibrarySectionsAllPart.md
Normal file
@@ -0,0 +1,23 @@
|
|||||||
|
# GetLibrarySectionsAllPart
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| -------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||||
|
| `accessible` | *Optional\<Boolean>* | :heavy_minus_sign: | Indicates if the part is accessible. | true |
|
||||||
|
| `exists` | *Optional\<Boolean>* | :heavy_minus_sign: | Indicates if the part exists. | true |
|
||||||
|
| `id` | *long* | :heavy_check_mark: | Unique part identifier. | 418385 |
|
||||||
|
| `key` | *String* | :heavy_check_mark: | Key to access this part. | /library/parts/418385/1735864239/file.mkv |
|
||||||
|
| `indexes` | *Optional\<String>* | :heavy_minus_sign: | N/A | sd |
|
||||||
|
| `duration` | *Optional\<Integer>* | :heavy_minus_sign: | Duration of the part in milliseconds. | 9610350 |
|
||||||
|
| `file` | *String* | :heavy_check_mark: | File path for the part. | /mnt/Movies_1/W/Wicked (2024).mkv |
|
||||||
|
| `size` | *long* | :heavy_check_mark: | File size in bytes. | 30649952104 |
|
||||||
|
| `packetLength` | *Optional\<Integer>* | :heavy_minus_sign: | N/A | 188 |
|
||||||
|
| `container` | *Optional\<String>* | :heavy_minus_sign: | Container format of the part. | mkv |
|
||||||
|
| `videoProfile` | *Optional\<String>* | :heavy_minus_sign: | Video profile for the part. | main 10 |
|
||||||
|
| `audioProfile` | *Optional\<String>* | :heavy_minus_sign: | The audio profile used for the media (e.g., DTS, Dolby Digital, etc.). | dts |
|
||||||
|
| `has64bitOffsets` | *Optional\<Boolean>* | :heavy_minus_sign: | N/A | false |
|
||||||
|
| `optimizedForStreaming` | [Optional\<GetLibrarySectionsAllLibraryOptimizedForStreaming>](../../models/operations/GetLibrarySectionsAllLibraryOptimizedForStreaming.md) | :heavy_minus_sign: | Has this media been optimized for streaming. NOTE: This can be 0, 1, false or true | |
|
||||||
|
| `hasThumbnail` | [Optional\<GetLibrarySectionsAllHasThumbnail>](../../models/operations/GetLibrarySectionsAllHasThumbnail.md) | :heavy_minus_sign: | N/A | 1 |
|
||||||
|
| `stream` | List\<[GetLibrarySectionsAllStream](../../models/operations/GetLibrarySectionsAllStream.md)> | :heavy_minus_sign: | An array of streams for this part. | |
|
||||||
@@ -1,4 +1,4 @@
|
|||||||
# GetAllMediaLibraryQueryParamIncludeMeta
|
# GetLibrarySectionsAllQueryParamIncludeMeta
|
||||||
|
|
||||||
Adds the Meta object to the response
|
Adds the Meta object to the response
|
||||||
|
|
||||||
@@ -0,0 +1,24 @@
|
|||||||
|
# GetLibrarySectionsAllQueryParamType
|
||||||
|
|
||||||
|
The type of media to retrieve or filter by.
|
||||||
|
1 = movie
|
||||||
|
2 = show
|
||||||
|
3 = season
|
||||||
|
4 = episode
|
||||||
|
E.g. A movie library will not return anything with type 3 as there are no seasons for movie libraries
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
## Values
|
||||||
|
|
||||||
|
| Name | Value |
|
||||||
|
| ------------ | ------------ |
|
||||||
|
| `Movie` | 1 |
|
||||||
|
| `TvShow` | 2 |
|
||||||
|
| `Season` | 3 |
|
||||||
|
| `Episode` | 4 |
|
||||||
|
| `Artist` | 5 |
|
||||||
|
| `Album` | 6 |
|
||||||
|
| `Track` | 7 |
|
||||||
|
| `PhotoAlbum` | 8 |
|
||||||
|
| `Photo` | 9 |
|
||||||
@@ -1,4 +1,4 @@
|
|||||||
# GetAllMediaLibraryRequest
|
# GetLibrarySectionsAllRequest
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
@@ -6,8 +6,8 @@
|
|||||||
| Field | Type | Required | Description | Example |
|
| Field | Type | Required | Description | Example |
|
||||||
| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||||
| `sectionKey` | *int* | :heavy_check_mark: | The unique key of the Plex library. <br/>Note: This is unique in the context of the Plex server.<br/> | 9518 |
|
| `sectionKey` | *int* | :heavy_check_mark: | The unique key of the Plex library. <br/>Note: This is unique in the context of the Plex server.<br/> | 9518 |
|
||||||
| `type` | [GetAllMediaLibraryQueryParamType](../../models/operations/GetAllMediaLibraryQueryParamType.md) | :heavy_check_mark: | The type of media to retrieve or filter by.<br/>1 = movie<br/>2 = show<br/>3 = season<br/>4 = episode<br/>E.g. A movie library will not return anything with type 3 as there are no seasons for movie libraries<br/> | 2 |
|
| `type` | [GetLibrarySectionsAllQueryParamType](../../models/operations/GetLibrarySectionsAllQueryParamType.md) | :heavy_check_mark: | The type of media to retrieve or filter by.<br/>1 = movie<br/>2 = show<br/>3 = season<br/>4 = episode<br/>E.g. A movie library will not return anything with type 3 as there are no seasons for movie libraries<br/> | 2 |
|
||||||
| `includeMeta` | [Optional\<GetAllMediaLibraryQueryParamIncludeMeta>](../../models/operations/GetAllMediaLibraryQueryParamIncludeMeta.md) | :heavy_minus_sign: | Adds the Meta object to the response<br/> | 1 |
|
| `includeMeta` | [Optional\<GetLibrarySectionsAllQueryParamIncludeMeta>](../../models/operations/GetLibrarySectionsAllQueryParamIncludeMeta.md) | :heavy_minus_sign: | Adds the Meta object to the response<br/> | 1 |
|
||||||
| `includeGuids` | [Optional\<QueryParamIncludeGuids>](../../models/operations/QueryParamIncludeGuids.md) | :heavy_minus_sign: | Adds the Guid object to the response<br/> | 1 |
|
| `includeGuids` | [Optional\<QueryParamIncludeGuids>](../../models/operations/QueryParamIncludeGuids.md) | :heavy_minus_sign: | Adds the Guid object to the response<br/> | 1 |
|
||||||
| `includeAdvanced` | [Optional\<IncludeAdvanced>](../../models/operations/IncludeAdvanced.md) | :heavy_minus_sign: | N/A | 1 |
|
| `includeAdvanced` | [Optional\<IncludeAdvanced>](../../models/operations/IncludeAdvanced.md) | :heavy_minus_sign: | N/A | 1 |
|
||||||
| `includeCollections` | [Optional\<QueryParamIncludeCollections>](../../models/operations/QueryParamIncludeCollections.md) | :heavy_minus_sign: | N/A | 1 |
|
| `includeCollections` | [Optional\<QueryParamIncludeCollections>](../../models/operations/QueryParamIncludeCollections.md) | :heavy_minus_sign: | N/A | 1 |
|
||||||
@@ -1,4 +1,4 @@
|
|||||||
# GetAllMediaLibraryResponse
|
# GetLibrarySectionsAllResponse
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
@@ -8,4 +8,4 @@
|
|||||||
| `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation |
|
| `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation |
|
||||||
| `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation |
|
| `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation |
|
||||||
| `rawResponse` | [HttpResponse\<InputStream>](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
|
| `rawResponse` | [HttpResponse\<InputStream>](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
|
||||||
| `object` | [Optional\<GetAllMediaLibraryResponseBody>](../../models/operations/GetAllMediaLibraryResponseBody.md) | :heavy_minus_sign: | Successful response containing media container data. |
|
| `object` | [Optional\<GetLibrarySectionsAllResponseBody>](../../models/operations/GetLibrarySectionsAllResponseBody.md) | :heavy_minus_sign: | Successful response containing media container data. |
|
||||||
10
docs/models/operations/GetLibrarySectionsAllResponseBody.md
Normal file
10
docs/models/operations/GetLibrarySectionsAllResponseBody.md
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
# GetLibrarySectionsAllResponseBody
|
||||||
|
|
||||||
|
Successful response containing media container data.
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- |
|
||||||
|
| `mediaContainer` | [Optional\<GetLibrarySectionsAllMediaContainer>](../../models/operations/GetLibrarySectionsAllMediaContainer.md) | :heavy_minus_sign: | N/A |
|
||||||
@@ -1,4 +1,4 @@
|
|||||||
# GetAllMediaLibraryRole
|
# GetLibrarySectionsAllRole
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
15
docs/models/operations/GetLibrarySectionsAllSort.md
Normal file
15
docs/models/operations/GetLibrarySectionsAllSort.md
Normal file
@@ -0,0 +1,15 @@
|
|||||||
|
# GetLibrarySectionsAllSort
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- |
|
||||||
|
| `default_` | *Optional\<String>* | :heavy_minus_sign: | N/A | asc |
|
||||||
|
| `active` | *Optional\<Boolean>* | :heavy_minus_sign: | N/A | false |
|
||||||
|
| `activeDirection` | [Optional\<GetLibrarySectionsAllActiveDirection>](../../models/operations/GetLibrarySectionsAllActiveDirection.md) | :heavy_minus_sign: | The direction of the sort. Can be either `asc` or `desc`.<br/> | asc |
|
||||||
|
| `defaultDirection` | [Optional\<GetLibrarySectionsAllDefaultDirection>](../../models/operations/GetLibrarySectionsAllDefaultDirection.md) | :heavy_minus_sign: | The direction of the sort. Can be either `asc` or `desc`.<br/> | asc |
|
||||||
|
| `descKey` | *Optional\<String>* | :heavy_minus_sign: | N/A | titleSort:desc |
|
||||||
|
| `firstCharacterKey` | *Optional\<String>* | :heavy_minus_sign: | N/A | /library/sections/2/firstCharacter |
|
||||||
|
| `key` | *String* | :heavy_check_mark: | N/A | titleSort |
|
||||||
|
| `title` | *String* | :heavy_check_mark: | N/A | Title |
|
||||||
58
docs/models/operations/GetLibrarySectionsAllStream.md
Normal file
58
docs/models/operations/GetLibrarySectionsAllStream.md
Normal file
@@ -0,0 +1,58 @@
|
|||||||
|
# GetLibrarySectionsAllStream
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
|
||||||
|
| `id` | *long* | :heavy_check_mark: | Unique stream identifier. | 1002625 |
|
||||||
|
| `streamType` | [GetLibrarySectionsAllStreamType](../../models/operations/GetLibrarySectionsAllStreamType.md) | :heavy_check_mark: | Stream type:<br/> - 1 = video<br/> - 2 = audio<br/> - 3 = subtitle<br/> | 1 |
|
||||||
|
| `format` | *Optional\<String>* | :heavy_minus_sign: | Format of the stream (e.g., srt). | srt |
|
||||||
|
| `default_` | *Optional\<Boolean>* | :heavy_minus_sign: | Indicates if this stream is default. | true |
|
||||||
|
| `codec` | *String* | :heavy_check_mark: | Codec used by the stream. | hevc |
|
||||||
|
| `index` | *Optional\<Integer>* | :heavy_minus_sign: | Index of the stream. | 0 |
|
||||||
|
| `bitrate` | *Optional\<Integer>* | :heavy_minus_sign: | Bitrate of the stream. | 24743 |
|
||||||
|
| `language` | *Optional\<String>* | :heavy_minus_sign: | Language of the stream. | English |
|
||||||
|
| `languageTag` | *Optional\<String>* | :heavy_minus_sign: | Language tag (e.g., en). | en |
|
||||||
|
| `languageCode` | *Optional\<String>* | :heavy_minus_sign: | ISO language code. | eng |
|
||||||
|
| `headerCompression` | *Optional\<Boolean>* | :heavy_minus_sign: | Indicates whether header compression is enabled. | true |
|
||||||
|
| `doviblCompatID` | *Optional\<Integer>* | :heavy_minus_sign: | Dolby Vision BL compatibility ID. | 1 |
|
||||||
|
| `doviblPresent` | *Optional\<Boolean>* | :heavy_minus_sign: | Indicates if Dolby Vision BL is present. | true |
|
||||||
|
| `dovielPresent` | *Optional\<Boolean>* | :heavy_minus_sign: | Indicates if Dolby Vision EL is present. | false |
|
||||||
|
| `doviLevel` | *Optional\<Integer>* | :heavy_minus_sign: | Dolby Vision level. | 6 |
|
||||||
|
| `doviPresent` | *Optional\<Boolean>* | :heavy_minus_sign: | Indicates if Dolby Vision is present. | true |
|
||||||
|
| `doviProfile` | *Optional\<Integer>* | :heavy_minus_sign: | Dolby Vision profile. | 8 |
|
||||||
|
| `dovirpuPresent` | *Optional\<Boolean>* | :heavy_minus_sign: | Indicates if Dolby Vision RPU is present. | true |
|
||||||
|
| `doviVersion` | *Optional\<String>* | :heavy_minus_sign: | Dolby Vision version. | 1.0 |
|
||||||
|
| `bitDepth` | *Optional\<Integer>* | :heavy_minus_sign: | Bit depth of the video stream. | 10 |
|
||||||
|
| `chromaLocation` | *Optional\<String>* | :heavy_minus_sign: | Chroma sample location. | topleft |
|
||||||
|
| `chromaSubsampling` | *Optional\<String>* | :heavy_minus_sign: | Chroma subsampling format. | 4:2:0 |
|
||||||
|
| `codedHeight` | *Optional\<Integer>* | :heavy_minus_sign: | Coded video height. | 1608 |
|
||||||
|
| `codedWidth` | *Optional\<Integer>* | :heavy_minus_sign: | Coded video width. | 3840 |
|
||||||
|
| `closedCaptions` | *Optional\<Boolean>* | :heavy_minus_sign: | N/A | true |
|
||||||
|
| `colorPrimaries` | *Optional\<String>* | :heavy_minus_sign: | Color primaries used. | bt2020 |
|
||||||
|
| `colorRange` | *Optional\<String>* | :heavy_minus_sign: | Color range (e.g., tv). | tv |
|
||||||
|
| `colorSpace` | *Optional\<String>* | :heavy_minus_sign: | Color space. | bt2020nc |
|
||||||
|
| `colorTrc` | *Optional\<String>* | :heavy_minus_sign: | Color transfer characteristics. | smpte2084 |
|
||||||
|
| `frameRate` | *Optional\<Float>* | :heavy_minus_sign: | Frame rate of the stream. | 23.976 |
|
||||||
|
| `key` | *Optional\<String>* | :heavy_minus_sign: | Key to access this stream part. | /library/streams/216389 |
|
||||||
|
| `height` | *Optional\<Integer>* | :heavy_minus_sign: | Height of the video stream. | 1602 |
|
||||||
|
| `level` | *Optional\<Integer>* | :heavy_minus_sign: | Video level. | 150 |
|
||||||
|
| `original` | *Optional\<Boolean>* | :heavy_minus_sign: | Indicates if this is the original stream. | true |
|
||||||
|
| `hasScalingMatrix` | *Optional\<Boolean>* | :heavy_minus_sign: | N/A | false |
|
||||||
|
| `profile` | *Optional\<String>* | :heavy_minus_sign: | Video profile. | main 10 |
|
||||||
|
| `scanType` | *Optional\<String>* | :heavy_minus_sign: | N/A | progressive |
|
||||||
|
| `embeddedInVideo` | *Optional\<String>* | :heavy_minus_sign: | N/A | progressive |
|
||||||
|
| `refFrames` | *Optional\<Integer>* | :heavy_minus_sign: | Number of reference frames. | 1 |
|
||||||
|
| `width` | *Optional\<Integer>* | :heavy_minus_sign: | Width of the video stream. | 3840 |
|
||||||
|
| `displayTitle` | *String* | :heavy_check_mark: | Display title for the stream. | 4K DoVi/HDR10 (HEVC Main 10) |
|
||||||
|
| `extendedDisplayTitle` | *String* | :heavy_check_mark: | Extended display title for the stream. | 4K DoVi/HDR10 (HEVC Main 10) |
|
||||||
|
| `selected` | *Optional\<Boolean>* | :heavy_minus_sign: | Indicates if this stream is selected (applicable for audio streams). | true |
|
||||||
|
| `forced` | *Optional\<Boolean>* | :heavy_minus_sign: | N/A | true |
|
||||||
|
| `channels` | *Optional\<Integer>* | :heavy_minus_sign: | Number of audio channels (for audio streams). | 6 |
|
||||||
|
| `audioChannelLayout` | *Optional\<String>* | :heavy_minus_sign: | Audio channel layout. | 5.1(side) |
|
||||||
|
| `samplingRate` | *Optional\<Integer>* | :heavy_minus_sign: | Sampling rate for the audio stream. | 48000 |
|
||||||
|
| `canAutoSync` | *Optional\<Boolean>* | :heavy_minus_sign: | Indicates if the stream can auto-sync. | false |
|
||||||
|
| `hearingImpaired` | *Optional\<Boolean>* | :heavy_minus_sign: | Indicates if the stream is for the hearing impaired. | true |
|
||||||
|
| `dub` | *Optional\<Boolean>* | :heavy_minus_sign: | Indicates if the stream is a dub. | true |
|
||||||
|
| `title` | *Optional\<String>* | :heavy_minus_sign: | Optional title for the stream (e.g., language variant). | SDH |
|
||||||
16
docs/models/operations/GetLibrarySectionsAllStreamType.md
Normal file
16
docs/models/operations/GetLibrarySectionsAllStreamType.md
Normal file
@@ -0,0 +1,16 @@
|
|||||||
|
# GetLibrarySectionsAllStreamType
|
||||||
|
|
||||||
|
Stream type:
|
||||||
|
- 1 = video
|
||||||
|
- 2 = audio
|
||||||
|
- 3 = subtitle
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
## Values
|
||||||
|
|
||||||
|
| Name | Value |
|
||||||
|
| ---------- | ---------- |
|
||||||
|
| `Video` | 1 |
|
||||||
|
| `Audio` | 2 |
|
||||||
|
| `Subtitle` | 3 |
|
||||||
15
docs/models/operations/GetLibrarySectionsAllType.md
Normal file
15
docs/models/operations/GetLibrarySectionsAllType.md
Normal file
@@ -0,0 +1,15 @@
|
|||||||
|
# GetLibrarySectionsAllType
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- |
|
||||||
|
| `key` | *String* | :heavy_check_mark: | N/A | /library/sections/2/all?type=2 |
|
||||||
|
| `type` | *String* | :heavy_check_mark: | N/A | filter |
|
||||||
|
| `subtype` | *Optional\<String>* | :heavy_minus_sign: | N/A | clip |
|
||||||
|
| `title` | *String* | :heavy_check_mark: | N/A | TV Shows |
|
||||||
|
| `active` | *boolean* | :heavy_check_mark: | N/A | false |
|
||||||
|
| `filter` | List\<[GetLibrarySectionsAllFilter](../../models/operations/GetLibrarySectionsAllFilter.md)> | :heavy_minus_sign: | N/A | |
|
||||||
|
| `sort` | List\<[GetLibrarySectionsAllSort](../../models/operations/GetLibrarySectionsAllSort.md)> | :heavy_minus_sign: | N/A | |
|
||||||
|
| `field` | List\<[GetLibrarySectionsAllField](../../models/operations/GetLibrarySectionsAllField.md)> | :heavy_minus_sign: | N/A | |
|
||||||
@@ -1,4 +1,4 @@
|
|||||||
# GetAllMediaLibraryUltraBlurColors
|
# GetLibrarySectionsAllUltraBlurColors
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
@@ -1,4 +1,4 @@
|
|||||||
# GetAllMediaLibraryWriter
|
# GetLibrarySectionsAllWriter
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
@@ -1,10 +1,12 @@
|
|||||||
# GetMediaMetaDataCountry
|
# GetMediaMetaDataCountry
|
||||||
|
|
||||||
|
The filter query string for country media items.
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
| Field | Type | Required | Description | Example |
|
||||||
| ---------------------------------- | ---------------------------------- | ---------------------------------- | ---------------------------------- | ---------------------------------- |
|
| ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- |
|
||||||
| `id` | *int* | :heavy_check_mark: | The unique country identifier. | 58591 |
|
| `id` | *int* | :heavy_check_mark: | The unique identifier for the country.<br/>NOTE: This is different for each Plex server and is not globally unique.<br/> | 259 |
|
||||||
| `filter` | *String* | :heavy_check_mark: | The filter string for the country. | country=58591 |
|
| `tag` | *String* | :heavy_check_mark: | The country of origin of this media item | United States of America |
|
||||||
| `tag` | *String* | :heavy_check_mark: | The country name. | United States of America |
|
| `filter` | *String* | :heavy_check_mark: | N/A | country=19 |
|
||||||
@@ -3,11 +3,10 @@
|
|||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
| Field | Type | Required | Description | Example |
|
||||||
| ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- |
|
| ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- |
|
||||||
| `id` | *long* | :heavy_check_mark: | The unique role identifier. | 109501 |
|
| `id` | *int* | :heavy_check_mark: | Unique identifier for the director. | 126522 |
|
||||||
| `filter` | *String* | :heavy_check_mark: | The filter string for the role. | actor=109501 |
|
| `tag` | *String* | :heavy_check_mark: | The role of Director | Danny Boyle |
|
||||||
| `tag` | *String* | :heavy_check_mark: | The actor's name. | Bob Odenkirk |
|
| `filter` | *String* | :heavy_check_mark: | The filter string used to query this director. | director=235876 |
|
||||||
| `tagKey` | *String* | :heavy_check_mark: | A key associated with the actor tag. | 5d77683254f42c001f8c3f69 |
|
| `tagKey` | *String* | :heavy_check_mark: | A unique 24-character hexadecimal key associated with the director's tag, used for internal identification. | 5d776831151a60001f24d031 |
|
||||||
| `role` | *Optional\<String>* | :heavy_minus_sign: | The character name or role. | Jimmy McGill |
|
| `thumb` | *Optional\<String>* | :heavy_minus_sign: | The absolute URL of the thumbnail image for the director. | https://metadata-static.plex.tv/8/people/8d65fa96804802e08f2de09fe014408e.jpg |
|
||||||
| `thumb` | *Optional\<String>* | :heavy_minus_sign: | URL for the role thumbnail image. | https://metadata-static.plex.tv/f/people/f2ca7b474cc984efbdd5c503a096285a.jpg |
|
|
||||||
@@ -1,10 +1,12 @@
|
|||||||
# GetMediaMetaDataGenre
|
# GetMediaMetaDataGenre
|
||||||
|
|
||||||
|
The filter query string for similar items.
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
| Field | Type | Required | Description | Example |
|
||||||
| -------------------------------- | -------------------------------- | -------------------------------- | -------------------------------- | -------------------------------- |
|
| -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- |
|
||||||
| `id` | *long* | :heavy_check_mark: | The unique genre identifier. | 1057 |
|
| `id` | *int* | :heavy_check_mark: | The unique identifier for the genre.<br/>NOTE: This is different for each Plex server and is not globally unique.<br/> | 259 |
|
||||||
| `filter` | *String* | :heavy_check_mark: | The filter string for the genre. | genre=1057 |
|
| `tag` | *String* | :heavy_check_mark: | The genre name of this media-item<br/> | Crime |
|
||||||
| `tag` | *String* | :heavy_check_mark: | The genre name. | Crime |
|
| `filter` | *String* | :heavy_check_mark: | N/A | genre=19 |
|
||||||
@@ -3,6 +3,6 @@
|
|||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
| Field | Type | Required | Description | Example |
|
||||||
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
|
| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||||
| `id` | *String* | :heavy_check_mark: | The GUID value. | imdb://tt3032476 |
|
| `id` | *String* | :heavy_check_mark: | The unique identifier for the Guid. Can be prefixed with imdb://, tmdb://, tvdb://<br/> | {<br/>"imdbExample": {<br/>"summary": "IMDB example",<br/>"value": "imdb://tt13015952"<br/>},<br/>"tmdbExample": {<br/>"summary": "TMDB example",<br/>"value": "tmdb://2434012"<br/>},<br/>"tvdbExample": {<br/>"summary": "TVDB example",<br/>"value": "tvdb://7945991"<br/>}<br/>} |
|
||||||
@@ -3,8 +3,8 @@
|
|||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
| Field | Type | Required | Description | Example |
|
||||||
| ------------------------------------------------------------- | ------------------------------------------------------------- | ------------------------------------------------------------- | ------------------------------------------------------------- | ------------------------------------------------------------- |
|
| ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- |
|
||||||
| `alt` | *String* | :heavy_check_mark: | Alternate text for the image. | Better Call Saul |
|
| `alt` | *String* | :heavy_check_mark: | N/A | Episode 1 |
|
||||||
| `type` | *String* | :heavy_check_mark: | The type of image (e.g., coverPoster, background, clearLogo). | coverPoster |
|
| `type` | [GetMediaMetaDataLibraryType](../../models/operations/GetMediaMetaDataLibraryType.md) | :heavy_check_mark: | N/A | background |
|
||||||
| `url` | *String* | :heavy_check_mark: | The URL of the image. | /library/metadata/44288/thumb/1736487993 |
|
| `url` | *String* | :heavy_check_mark: | N/A | /library/metadata/45521/thumb/1644710589 |
|
||||||
@@ -1,4 +1,4 @@
|
|||||||
# GetAllMediaLibraryLibraryResponseType
|
# GetMediaMetaDataLibraryType
|
||||||
|
|
||||||
|
|
||||||
## Values
|
## Values
|
||||||
@@ -1,68 +1,83 @@
|
|||||||
# GetMediaMetaDataMetadata
|
# GetMediaMetaDataMetadata
|
||||||
|
|
||||||
|
Unknown
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
| Field | Type | Required | Description | Example |
|
||||||
| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||||
| `ratingKey` | *String* | :heavy_check_mark: | The rating key of the metadata item. | 44288 |
|
| `ratingKey` | *String* | :heavy_check_mark: | The rating key (Media ID) of this media item. Note: Although this is always an integer, it is represented as a string in the API. | 58683 |
|
||||||
| `parentRatingKey` | *Optional\<String>* | :heavy_minus_sign: | The rating key of the parent of this metadata item. | 48047 |
|
| `key` | *String* | :heavy_check_mark: | The unique key for the media item. | /library/metadata/58683 |
|
||||||
| `grandparentRatingKey` | *Optional\<String>* | :heavy_minus_sign: | The rating key of the grandparent of this metadata item. | 45520 |
|
| `guid` | *String* | :heavy_check_mark: | The globally unique identifier for the media item. | plex://movie/5d7768ba96b655001fdc0408 |
|
||||||
| `parentGuid` | *Optional\<String>* | :heavy_minus_sign: | A GUID identifying the parent entity (e.g., season) for the item. | plex://season/618b89208dde18df707ad15c |
|
| `slug` | *String* | :heavy_check_mark: | A URL‐friendly version of the media title. | 4-for-texas |
|
||||||
| `grandparentGuid` | *Optional\<String>* | :heavy_minus_sign: | A GUID identifying the grandparent entity (e.g., show). | plex://show/5e16253691c20300412003a8 |
|
| `studio` | *Optional\<String>* | :heavy_minus_sign: | The studio that produced the media item. | 20th Century Studios |
|
||||||
| `grandparentSlug` | *Optional\<String>* | :heavy_minus_sign: | A URL-friendly identifier (slug) for the grandparent entity. | alice-in-borderland-2020 |
|
| `type` | [GetMediaMetaDataType](../../models/operations/GetMediaMetaDataType.md) | :heavy_check_mark: | N/A | movie |
|
||||||
| `grandparentKey` | *Optional\<String>* | :heavy_minus_sign: | A key identifying the grandparent metadata in the library. | /library/metadata/45520 |
|
| `title` | *String* | :heavy_check_mark: | The title of the media item. | Avatar: The Way of Water |
|
||||||
| `parentKey` | *Optional\<String>* | :heavy_minus_sign: | A key identifying the parent metadata in the library. | /library/metadata/48047 |
|
| `titleSort` | *String* | :heavy_check_mark: | The sort title used for ordering media items. | Whale |
|
||||||
| `key` | *String* | :heavy_check_mark: | The API key to access metadata details. | /library/metadata/44288/children |
|
| `contentRating` | *Optional\<String>* | :heavy_minus_sign: | The content rating for the media item. | PG-13 |
|
||||||
| `guid` | *String* | :heavy_check_mark: | The globally unique identifier for the item. | plex://show/5d9c08254eefaa001f5d6dcb |
|
| `summary` | *String* | :heavy_check_mark: | A synopsis of the media item. | Jake Sully lives with his newfound family formed on the extrasolar moon Pandora.<br/>Once a familiar threat returns to finish what was previously started, Jake must<br/>work with Neytiri and the army of the Na'vi race to protect their home.<br/> |
|
||||||
| `slug` | *Optional\<String>* | :heavy_minus_sign: | A URL-friendly identifier for the item. | better-call-saul |
|
| `rating` | *float* | :heavy_check_mark: | The critic rating for the media item. | 7.6 |
|
||||||
| `studio` | *Optional\<String>* | :heavy_minus_sign: | The studio that produced the content. | Sony Pictures Television |
|
| `audienceRating` | *double* | :heavy_check_mark: | The audience rating for the media item. | 9.2 |
|
||||||
| `type` | *String* | :heavy_check_mark: | The type of content (e.g., show, movie). | show |
|
| `year` | *Optional\<Integer>* | :heavy_minus_sign: | The release year of the media item. | 2022 |
|
||||||
| `title` | *String* | :heavy_check_mark: | The title of the content. | Better Call Saul |
|
| `tagline` | *String* | :heavy_check_mark: | A brief tagline for the media item. | Return to Pandora. |
|
||||||
| `originalTitle` | *Optional\<String>* | :heavy_minus_sign: | The original title of the content. | Wicked: Part I |
|
| `thumb` | *String* | :heavy_check_mark: | The thumbnail image URL for the media item. | /library/metadata/58683/thumb/1703239236 |
|
||||||
| `librarySectionTitle` | *String* | :heavy_check_mark: | The title of the library section. | TV Series |
|
| `art` | *String* | :heavy_check_mark: | The art image URL for the media item. | /library/metadata/58683/art/1703239236 |
|
||||||
| `librarySectionID` | *long* | :heavy_check_mark: | The ID of the library section. | 2 |
|
| `theme` | *String* | :heavy_check_mark: | The theme URL for the media item. | /library/metadata/1/theme/1705636920 |
|
||||||
| `librarySectionKey` | *String* | :heavy_check_mark: | The key of the library section. | /library/sections/2 |
|
| `index` | *int* | :heavy_check_mark: | The index position of the media item. | 1 |
|
||||||
| `contentRating` | *Optional\<String>* | :heavy_minus_sign: | The content rating (e.g., TV-MA). | TV-MA |
|
| `leafCount` | *Optional\<Integer>* | :heavy_minus_sign: | The number of leaf items (end nodes) under this media item. | 14 |
|
||||||
| `summary` | *String* | :heavy_check_mark: | A summary of the content. | Before Saul Goodman, he was Jimmy McGill. And if you're calling Jimmy, you're in real trouble. The prequel to "Breaking Bad" follows small-time attorney, Jimmy McGill, as he transforms into Walter White's morally challenged lawyer, Saul Goodman. |
|
| `viewedLeafCount` | *Optional\<Integer>* | :heavy_minus_sign: | The number of leaf items that have been viewed. | 0 |
|
||||||
| `index` | *Optional\<Long>* | :heavy_minus_sign: | The index or order of the item. | 1 |
|
| `childCount` | *int* | :heavy_check_mark: | The number of child items associated with this media item. | 1 |
|
||||||
| `grandparentTitle` | *Optional\<String>* | :heavy_minus_sign: | The title of the grandparent entity (typically the show's title). | Alice in Borderland |
|
| `seasonCount` | *int* | :heavy_check_mark: | The total number of seasons (for TV shows). | 2022 |
|
||||||
| `parentTitle` | *Optional\<String>* | :heavy_minus_sign: | The title of the parent entity (typically the season's title). | Season 2 |
|
| `duration` | *int* | :heavy_check_mark: | The duration of the media item in milliseconds. | 11558112 |
|
||||||
| `audienceRating` | *Optional\<Float>* | :heavy_minus_sign: | The audience rating for the content. | 8.7 |
|
| `originallyAvailableAt` | [LocalDate](https://docs.oracle.com/javase/8/docs/api/java/time/LocalDate.html) | :heavy_check_mark: | The original release date of the media item. | 2022-12-14 |
|
||||||
| `viewCount` | *Optional\<Long>* | :heavy_minus_sign: | The number of times the item has been viewed. | 4 |
|
| `addedAt` | *long* | :heavy_check_mark: | N/A | 1556281940 |
|
||||||
| `skipCount` | *Optional\<Long>* | :heavy_minus_sign: | The number of times the item has been skipped. | 1 |
|
| `updatedAt` | *Optional\<Long>* | :heavy_minus_sign: | Unix epoch datetime in seconds | 1556281940 |
|
||||||
| `lastViewedAt` | *Optional\<Long>* | :heavy_minus_sign: | Unix timestamp of when the item was last viewed. | 1625764795 |
|
| `audienceRatingImage` | *Optional\<String>* | :heavy_minus_sign: | The URL for the audience rating image. | rottentomatoes://image.rating.upright |
|
||||||
| `year` | *int* | :heavy_check_mark: | The release year. | 2015 |
|
| `chapterSource` | *Optional\<String>* | :heavy_minus_sign: | The source from which chapter data is derived. | media |
|
||||||
| `rating` | *Optional\<Float>* | :heavy_minus_sign: | The general rating | 6 |
|
| `primaryExtraKey` | *Optional\<String>* | :heavy_minus_sign: | The primary extra key associated with this media item. | /library/metadata/58684 |
|
||||||
| `ratingImage` | *Optional\<String>* | :heavy_minus_sign: | The URL or identifier for the rating image (e.g., Rotten Tomatoes rating image). | rottentomatoes://image.rating.ripe |
|
| `originalTitle` | *Optional\<String>* | :heavy_minus_sign: | The original title of the media item (if different). | 映画 ブラッククローバー 魔法帝の剣 |
|
||||||
| `tagline` | *Optional\<String>* | :heavy_minus_sign: | The tagline of the content. | Make the call |
|
| `parentRatingKey` | *Optional\<String>* | :heavy_minus_sign: | The rating key of the parent media item. | 66 |
|
||||||
| `chapterSource` | *Optional\<String>* | :heavy_minus_sign: | N/A | media |
|
| `grandparentRatingKey` | *Optional\<String>* | :heavy_minus_sign: | The rating key of the grandparent media item. | 66 |
|
||||||
| `primaryExtraKey` | *Optional\<String>* | :heavy_minus_sign: | N/A | /library/metadata/134704 |
|
| `parentGuid` | *Optional\<String>* | :heavy_minus_sign: | The GUID of the parent media item. | plex://show/5d9c081b170e24001f2a7be4 |
|
||||||
| `thumb` | *String* | :heavy_check_mark: | URL of the thumbnail image. | /library/metadata/44288/thumb/1736487993 |
|
| `grandparentGuid` | *Optional\<String>* | :heavy_minus_sign: | The GUID of the grandparent media item. | plex://show/5d9c081b170e24001f2a7be4 |
|
||||||
| `art` | *String* | :heavy_check_mark: | URL of the art image. | /library/metadata/44288/art/1736487993 |
|
| `grandparentSlug` | *Optional\<String>* | :heavy_minus_sign: | The slug for the grandparent media item. | alice-in-borderland-2020 |
|
||||||
| `theme` | *Optional\<String>* | :heavy_minus_sign: | URL of the theme image. | /library/metadata/44288/theme/1736487993 |
|
| `grandparentKey` | *Optional\<String>* | :heavy_minus_sign: | The key of the grandparent media item. | /library/metadata/66 |
|
||||||
| `duration` | *int* | :heavy_check_mark: | Duration of the content in milliseconds. | 2700000 |
|
| `parentKey` | *Optional\<String>* | :heavy_minus_sign: | The key of the parent media item. | /library/metadata/66 |
|
||||||
| `originallyAvailableAt` | [LocalDate](https://docs.oracle.com/javase/8/docs/api/java/time/LocalDate.html) | :heavy_minus_sign: | The original release date. | 2015-02-08 |
|
| `grandparentTitle` | *Optional\<String>* | :heavy_minus_sign: | The title of the grandparent media item. | Caprica |
|
||||||
| `leafCount` | *Optional\<Long>* | :heavy_minus_sign: | The total number of episodes (or leaves). | 63 |
|
| `grandparentThumb` | *Optional\<String>* | :heavy_minus_sign: | The thumbnail URL for the grandparent media item. | /library/metadata/66/thumb/1705716261 |
|
||||||
| `viewedLeafCount` | *Optional\<Long>* | :heavy_minus_sign: | The number of episodes that have been viewed. | 4 |
|
| `grandparentTheme` | *Optional\<String>* | :heavy_minus_sign: | The theme URL for the grandparent media item. | /library/metadata/66/theme/1705716261 |
|
||||||
| `childCount` | *Optional\<Integer>* | :heavy_minus_sign: | The number of child items. | 6 |
|
| `grandparentArt` | *Optional\<String>* | :heavy_minus_sign: | The art URL for the grandparent media item. | /library/metadata/66/art/1705716261 |
|
||||||
| `addedAt` | *long* | :heavy_check_mark: | N/A | 1556281940 |
|
| `parentTitle` | *Optional\<String>* | :heavy_minus_sign: | The title of the parent media item. | Caprica |
|
||||||
| `updatedAt` | *long* | :heavy_check_mark: | N/A | 1556281940 |
|
| `parentIndex` | *Optional\<Integer>* | :heavy_minus_sign: | The index position of the parent media item. | 1 |
|
||||||
| `audienceRatingImage` | *Optional\<String>* | :heavy_minus_sign: | The URL for the audience rating image. | themoviedb://image.rating |
|
| `parentThumb` | *Optional\<String>* | :heavy_minus_sign: | The thumbnail URL for the parent media item. | /library/metadata/66/thumb/1705716261 |
|
||||||
| `parentIndex` | *Optional\<Long>* | :heavy_minus_sign: | The index number of the parent entity, which could indicate its order or position. | 2 |
|
| `ratingImage` | *Optional\<String>* | :heavy_minus_sign: | The URL for the rating image. | rottentomatoes://image.rating.ripe |
|
||||||
| `parentThumb` | *Optional\<String>* | :heavy_minus_sign: | The URL of the parent's thumbnail image. | /library/metadata/48047/thumb/1671800243 |
|
| `viewCount` | *Optional\<Integer>* | :heavy_minus_sign: | The number of times this media item has been viewed. | 1 |
|
||||||
| `grandparentThumb` | *Optional\<String>* | :heavy_minus_sign: | The URL of the grandparent's thumbnail image. | /library/metadata/45520/thumb/1736488003 |
|
| `viewOffset` | *Optional\<Integer>* | :heavy_minus_sign: | The current playback offset (in milliseconds). | 5222500 |
|
||||||
| `grandparentArt` | *Optional\<String>* | :heavy_minus_sign: | The URL of the grandparent's art image. | /library/metadata/45520/art/1736488003 |
|
| `skipCount` | *Optional\<Integer>* | :heavy_minus_sign: | The number of times this media item has been skipped. | 1 |
|
||||||
| `media` | List\<[GetMediaMetaDataMedia](../../models/operations/GetMediaMetaDataMedia.md)> | :heavy_minus_sign: | N/A | |
|
| `subtype` | *Optional\<String>* | :heavy_minus_sign: | A classification that further describes the type of media item. For example, 'clip' indicates that the item is a short video clip. | clip |
|
||||||
| `image` | List\<[GetMediaMetaDataImage](../../models/operations/GetMediaMetaDataImage.md)> | :heavy_check_mark: | An array of image objects. | |
|
| `lastRatedAt` | *Optional\<Long>* | :heavy_minus_sign: | The Unix timestamp representing the last time the item was rated. | 1721813113 |
|
||||||
| `ultraBlurColors` | [GetMediaMetaDataUltraBlurColors](../../models/operations/GetMediaMetaDataUltraBlurColors.md) | :heavy_check_mark: | N/A | |
|
| `createdAtAccuracy` | *Optional\<String>* | :heavy_minus_sign: | The accuracy of the creation timestamp. This value indicates the format(s) provided (for example, 'epoch,local' means both epoch and local time formats are available). | epoch,local |
|
||||||
| `genre` | List\<[GetMediaMetaDataGenre](../../models/operations/GetMediaMetaDataGenre.md)> | :heavy_minus_sign: | An array of genre tags. | |
|
| `createdAtTZOffset` | *Optional\<String>* | :heavy_minus_sign: | The time zone offset for the creation timestamp, represented as a string. This offset indicates the difference from UTC. | 0 |
|
||||||
| `country` | List\<[GetMediaMetaDataCountry](../../models/operations/GetMediaMetaDataCountry.md)> | :heavy_minus_sign: | An array of country tags. | |
|
| `lastViewedAt` | *Optional\<Integer>* | :heavy_minus_sign: | Unix timestamp for when the media item was last viewed. | 1682752242 |
|
||||||
| `guids` | List\<[GetMediaMetaDataGuids](../../models/operations/GetMediaMetaDataGuids.md)> | :heavy_minus_sign: | An array of GUID objects. | |
|
| `userRating` | *Optional\<Float>* | :heavy_minus_sign: | The rating provided by a user for the item. This value is expressed as a decimal number. | 10 |
|
||||||
| `ratings` | List\<[Ratings](../../models/operations/Ratings.md)> | :heavy_minus_sign: | An array of rating objects. | |
|
| `image` | List\<[GetMediaMetaDataImage](../../models/operations/GetMediaMetaDataImage.md)> | :heavy_minus_sign: | N/A | |
|
||||||
| `role` | List\<[GetMediaMetaDataRole](../../models/operations/GetMediaMetaDataRole.md)> | :heavy_minus_sign: | An array of Actor roles. | |
|
| `ultraBlurColors` | [Optional\<GetMediaMetaDataUltraBlurColors>](../../models/operations/GetMediaMetaDataUltraBlurColors.md) | :heavy_minus_sign: | N/A | |
|
||||||
| `director` | List\<[GetMediaMetaDataDirector](../../models/operations/GetMediaMetaDataDirector.md)> | :heavy_minus_sign: | An array of Director roles. | |
|
| `librarySectionID` | *long* | :heavy_check_mark: | The identifier for the library section. | 1 |
|
||||||
| `writer` | List\<[GetMediaMetaDataWriter](../../models/operations/GetMediaMetaDataWriter.md)> | :heavy_minus_sign: | An array of Writer roles. | |
|
| `librarySectionTitle` | *String* | :heavy_check_mark: | The title of the library section. | Movies |
|
||||||
| `producer` | List\<[GetMediaMetaDataProducer](../../models/operations/GetMediaMetaDataProducer.md)> | :heavy_minus_sign: | An array of Writer roles. | |
|
| `librarySectionKey` | *String* | :heavy_check_mark: | The key corresponding to the library section. | /library/sections/1 |
|
||||||
| `similar` | List\<[GetMediaMetaDataSimilar](../../models/operations/GetMediaMetaDataSimilar.md)> | :heavy_minus_sign: | An array of similar content objects. | |
|
| `guids` | List\<[GetMediaMetaDataGuids](../../models/operations/GetMediaMetaDataGuids.md)> | :heavy_minus_sign: | N/A | |
|
||||||
| `location` | List\<[GetMediaMetaDataLocation](../../models/operations/GetMediaMetaDataLocation.md)> | :heavy_minus_sign: | An array of location objects. | |
|
| `media` | List\<[GetMediaMetaDataMedia](../../models/operations/GetMediaMetaDataMedia.md)> | :heavy_minus_sign: | N/A | |
|
||||||
|
| `genre` | List\<[GetMediaMetaDataGenre](../../models/operations/GetMediaMetaDataGenre.md)> | :heavy_minus_sign: | N/A | |
|
||||||
|
| `country` | List\<[GetMediaMetaDataCountry](../../models/operations/GetMediaMetaDataCountry.md)> | :heavy_minus_sign: | N/A | |
|
||||||
|
| `director` | List\<[GetMediaMetaDataDirector](../../models/operations/GetMediaMetaDataDirector.md)> | :heavy_minus_sign: | N/A | |
|
||||||
|
| `writer` | List\<[GetMediaMetaDataWriter](../../models/operations/GetMediaMetaDataWriter.md)> | :heavy_minus_sign: | N/A | |
|
||||||
|
| `producer` | List\<[GetMediaMetaDataProducer](../../models/operations/GetMediaMetaDataProducer.md)> | :heavy_minus_sign: | N/A | |
|
||||||
|
| `role` | List\<[GetMediaMetaDataRole](../../models/operations/GetMediaMetaDataRole.md)> | :heavy_minus_sign: | N/A | |
|
||||||
|
| `ratings` | List\<[Ratings](../../models/operations/Ratings.md)> | :heavy_minus_sign: | N/A | |
|
||||||
|
| `similar` | List\<[GetMediaMetaDataSimilar](../../models/operations/GetMediaMetaDataSimilar.md)> | :heavy_minus_sign: | N/A | |
|
||||||
|
| `location` | List\<[GetMediaMetaDataLocation](../../models/operations/GetMediaMetaDataLocation.md)> | :heavy_minus_sign: | N/A | |
|
||||||
|
| `chapter` | List\<[Chapter](../../models/operations/Chapter.md)> | :heavy_minus_sign: | N/A | |
|
||||||
|
| `marker` | List\<[Marker](../../models/operations/Marker.md)> | :heavy_minus_sign: | N/A | |
|
||||||
|
| `extras` | [Optional\<Extras>](../../models/operations/Extras.md) | :heavy_minus_sign: | N/A | |
|
||||||
@@ -3,19 +3,19 @@
|
|||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
| Field | Type | Required | Description | Example |
|
||||||
| ------------------------------------------------------ | ------------------------------------------------------ | ------------------------------------------------------ | ------------------------------------------------------ | ------------------------------------------------------ |
|
| ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- |
|
||||||
| `ratingKey` | *long* | :heavy_check_mark: | the id of the library item to return the children of. | 9518 |
|
| `ratingKey` | *String* | :heavy_check_mark: | The id(s) of the library item(s) to return metadata for. Can be a single ID or comma-separated list of IDs. | 21119,21617 |
|
||||||
| `includeConcerts` | *Optional\<Boolean>* | :heavy_minus_sign: | Include concerts data if set to true. | true |
|
| `includeConcerts` | *Optional\<Boolean>* | :heavy_minus_sign: | Include concerts data if set to true. | true |
|
||||||
| `includeExtras` | *Optional\<Boolean>* | :heavy_minus_sign: | Include extra content (e.g. bonus features). | true |
|
| `includeExtras` | *Optional\<Boolean>* | :heavy_minus_sign: | Include extra content (e.g. bonus features). | true |
|
||||||
| `includeOnDeck` | *Optional\<Boolean>* | :heavy_minus_sign: | Include on-deck items. | true |
|
| `includeOnDeck` | *Optional\<Boolean>* | :heavy_minus_sign: | Include on-deck items. | true |
|
||||||
| `includePopularLeaves` | *Optional\<Boolean>* | :heavy_minus_sign: | Include popular leaves (episodes/chapters). | true |
|
| `includePopularLeaves` | *Optional\<Boolean>* | :heavy_minus_sign: | Include popular leaves (episodes/chapters). | true |
|
||||||
| `includePreferences` | *Optional\<Boolean>* | :heavy_minus_sign: | Include preferences information. | true |
|
| `includePreferences` | *Optional\<Boolean>* | :heavy_minus_sign: | Include preferences information. | true |
|
||||||
| `includeReviews` | *Optional\<Boolean>* | :heavy_minus_sign: | Include reviews for the content. | true |
|
| `includeReviews` | *Optional\<Boolean>* | :heavy_minus_sign: | Include reviews for the content. | true |
|
||||||
| `includeChapters` | *Optional\<Boolean>* | :heavy_minus_sign: | Include chapter details. | true |
|
| `includeChapters` | *Optional\<Boolean>* | :heavy_minus_sign: | Include chapter details. | true |
|
||||||
| `includeStations` | *Optional\<Boolean>* | :heavy_minus_sign: | Include station data. | true |
|
| `includeStations` | *Optional\<Boolean>* | :heavy_minus_sign: | Include station data. | true |
|
||||||
| `includeExternalMedia` | *Optional\<Boolean>* | :heavy_minus_sign: | Include external media data. | true |
|
| `includeExternalMedia` | *Optional\<Boolean>* | :heavy_minus_sign: | Include external media data. | true |
|
||||||
| `asyncAugmentMetadata` | *Optional\<Boolean>* | :heavy_minus_sign: | Trigger asynchronous metadata augmentation. | true |
|
| `asyncAugmentMetadata` | *Optional\<Boolean>* | :heavy_minus_sign: | Trigger asynchronous metadata augmentation. | true |
|
||||||
| `asyncCheckFiles` | *Optional\<Boolean>* | :heavy_minus_sign: | Trigger asynchronous file checking. | true |
|
| `asyncCheckFiles` | *Optional\<Boolean>* | :heavy_minus_sign: | Trigger asynchronous file checking. | true |
|
||||||
| `asyncRefreshAnalysis` | *Optional\<Boolean>* | :heavy_minus_sign: | Trigger asynchronous refresh of analysis. | true |
|
| `asyncRefreshAnalysis` | *Optional\<Boolean>* | :heavy_minus_sign: | Trigger asynchronous refresh of analysis. | true |
|
||||||
| `asyncRefreshLocalMediaAgent` | *Optional\<Boolean>* | :heavy_minus_sign: | Trigger asynchronous refresh of the local media agent. | true |
|
| `asyncRefreshLocalMediaAgent` | *Optional\<Boolean>* | :heavy_minus_sign: | Trigger asynchronous refresh of the local media agent. | true |
|
||||||
@@ -3,11 +3,11 @@
|
|||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
| Field | Type | Required | Description | Example |
|
||||||
| ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- |
|
| ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||||
| `id` | *long* | :heavy_check_mark: | The unique role identifier. | 109501 |
|
| `id` | *int* | :heavy_check_mark: | The unique identifier for the role.<br/>NOTE: This is different for each Plex server and is not globally unique.<br/> | 126522 |
|
||||||
| `filter` | *String* | :heavy_check_mark: | The filter string for the role. | actor=109501 |
|
| `tag` | *String* | :heavy_check_mark: | The display tag for the actor (typically the actor's name). | Teller |
|
||||||
| `tag` | *String* | :heavy_check_mark: | The actor's name. | Bob Odenkirk |
|
| `role` | *Optional\<String>* | :heavy_minus_sign: | The role played by the actor in the media item. | Self - Judge |
|
||||||
| `tagKey` | *String* | :heavy_check_mark: | A key associated with the actor tag. | 5d77683254f42c001f8c3f69 |
|
| `filter` | *String* | :heavy_check_mark: | The filter string used to query this actor. For example, it may indicate that this is an actor with a given key. | actor=126522 |
|
||||||
| `role` | *Optional\<String>* | :heavy_minus_sign: | The character name or role. | Jimmy McGill |
|
| `tagKey` | *String* | :heavy_check_mark: | A 24-character hexadecimal unique key associated with the actor's tag, used for internal identification.<br/>NOTE: This is globally unique across all Plex Servers.<br/> | 5d77683d85719b001f3a535e |
|
||||||
| `thumb` | *Optional\<String>* | :heavy_minus_sign: | URL for the role thumbnail image. | https://metadata-static.plex.tv/f/people/f2ca7b474cc984efbdd5c503a096285a.jpg |
|
| `thumb` | *Optional\<String>* | :heavy_minus_sign: | The absolute URL of the thumbnail image for the actor. | https://metadata-static.plex.tv/7/people/708568fd018d7aa8b1032dcf867747e8.jpg |
|
||||||
@@ -3,54 +3,56 @@
|
|||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
| Field | Type | Required | Description | Example |
|
||||||
| -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- |
|
| ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- |
|
||||||
| `id` | *long* | :heavy_check_mark: | Unique stream identifier. | 1002625 |
|
| `id` | *long* | :heavy_check_mark: | Unique stream identifier. | 1002625 |
|
||||||
| `streamType` | *int* | :heavy_check_mark: | Stream type (1=video, 2=audio, 3=subtitle). | 1 |
|
| `streamType` | [GetMediaMetaDataStreamType](../../models/operations/GetMediaMetaDataStreamType.md) | :heavy_check_mark: | Stream type:<br/> - 1 = video<br/> - 2 = audio<br/> - 3 = subtitle<br/> | 1 |
|
||||||
| `default_` | *Optional\<Boolean>* | :heavy_minus_sign: | Indicates if this stream is default. | true |
|
| `format` | *Optional\<String>* | :heavy_minus_sign: | Format of the stream (e.g., srt). | srt |
|
||||||
| `codec` | *String* | :heavy_check_mark: | Codec used by the stream. | hevc |
|
| `default_` | *Optional\<Boolean>* | :heavy_minus_sign: | Indicates if this stream is default. | true |
|
||||||
| `index` | *int* | :heavy_check_mark: | Index of the stream. | 0 |
|
| `codec` | *String* | :heavy_check_mark: | Codec used by the stream. | hevc |
|
||||||
| `bitrate` | *Optional\<Integer>* | :heavy_minus_sign: | Bitrate of the stream. | 24743 |
|
| `index` | *Optional\<Integer>* | :heavy_minus_sign: | Index of the stream. | 0 |
|
||||||
| `language` | *Optional\<String>* | :heavy_minus_sign: | Language of the stream. | English |
|
| `bitrate` | *Optional\<Integer>* | :heavy_minus_sign: | Bitrate of the stream. | 24743 |
|
||||||
| `languageTag` | *Optional\<String>* | :heavy_minus_sign: | Language tag (e.g., en). | en |
|
| `language` | *Optional\<String>* | :heavy_minus_sign: | Language of the stream. | English |
|
||||||
| `languageCode` | *Optional\<String>* | :heavy_minus_sign: | ISO language code. | eng |
|
| `languageTag` | *Optional\<String>* | :heavy_minus_sign: | Language tag (e.g., en). | en |
|
||||||
| `headerCompression` | *Optional\<Boolean>* | :heavy_minus_sign: | Indicates whether header compression is enabled. | true |
|
| `languageCode` | *Optional\<String>* | :heavy_minus_sign: | ISO language code. | eng |
|
||||||
| `doviblCompatID` | *Optional\<Integer>* | :heavy_minus_sign: | Dolby Vision BL compatibility ID. | 1 |
|
| `headerCompression` | *Optional\<Boolean>* | :heavy_minus_sign: | Indicates whether header compression is enabled. | true |
|
||||||
| `doviblPresent` | *Optional\<Boolean>* | :heavy_minus_sign: | Indicates if Dolby Vision BL is present. | true |
|
| `doviblCompatID` | *Optional\<Integer>* | :heavy_minus_sign: | Dolby Vision BL compatibility ID. | 1 |
|
||||||
| `dovielPresent` | *Optional\<Boolean>* | :heavy_minus_sign: | Indicates if Dolby Vision EL is present. | false |
|
| `doviblPresent` | *Optional\<Boolean>* | :heavy_minus_sign: | Indicates if Dolby Vision BL is present. | true |
|
||||||
| `doviLevel` | *Optional\<Integer>* | :heavy_minus_sign: | Dolby Vision level. | 6 |
|
| `dovielPresent` | *Optional\<Boolean>* | :heavy_minus_sign: | Indicates if Dolby Vision EL is present. | false |
|
||||||
| `doviPresent` | *Optional\<Boolean>* | :heavy_minus_sign: | Indicates if Dolby Vision is present. | true |
|
| `doviLevel` | *Optional\<Integer>* | :heavy_minus_sign: | Dolby Vision level. | 6 |
|
||||||
| `doviProfile` | *Optional\<Integer>* | :heavy_minus_sign: | Dolby Vision profile. | 8 |
|
| `doviPresent` | *Optional\<Boolean>* | :heavy_minus_sign: | Indicates if Dolby Vision is present. | true |
|
||||||
| `dovirpuPresent` | *Optional\<Boolean>* | :heavy_minus_sign: | Indicates if Dolby Vision RPU is present. | true |
|
| `doviProfile` | *Optional\<Integer>* | :heavy_minus_sign: | Dolby Vision profile. | 8 |
|
||||||
| `doviVersion` | *Optional\<String>* | :heavy_minus_sign: | Dolby Vision version. | 1.0 |
|
| `dovirpuPresent` | *Optional\<Boolean>* | :heavy_minus_sign: | Indicates if Dolby Vision RPU is present. | true |
|
||||||
| `bitDepth` | *Optional\<Integer>* | :heavy_minus_sign: | Bit depth of the video stream. | 10 |
|
| `doviVersion` | *Optional\<String>* | :heavy_minus_sign: | Dolby Vision version. | 1.0 |
|
||||||
| `chromaLocation` | *Optional\<String>* | :heavy_minus_sign: | Chroma sample location. | topleft |
|
| `bitDepth` | *Optional\<Integer>* | :heavy_minus_sign: | Bit depth of the video stream. | 10 |
|
||||||
| `chromaSubsampling` | *Optional\<String>* | :heavy_minus_sign: | Chroma subsampling format. | 4:2:0 |
|
| `chromaLocation` | *Optional\<String>* | :heavy_minus_sign: | Chroma sample location. | topleft |
|
||||||
| `codedHeight` | *Optional\<Integer>* | :heavy_minus_sign: | Coded video height. | 1608 |
|
| `chromaSubsampling` | *Optional\<String>* | :heavy_minus_sign: | Chroma subsampling format. | 4:2:0 |
|
||||||
| `codedWidth` | *Optional\<Integer>* | :heavy_minus_sign: | Coded video width. | 3840 |
|
| `codedHeight` | *Optional\<Integer>* | :heavy_minus_sign: | Coded video height. | 1608 |
|
||||||
| `closedCaptions` | *Optional\<Boolean>* | :heavy_minus_sign: | N/A | true |
|
| `codedWidth` | *Optional\<Integer>* | :heavy_minus_sign: | Coded video width. | 3840 |
|
||||||
| `colorPrimaries` | *Optional\<String>* | :heavy_minus_sign: | Color primaries used. | bt2020 |
|
| `closedCaptions` | *Optional\<Boolean>* | :heavy_minus_sign: | N/A | true |
|
||||||
| `colorRange` | *Optional\<String>* | :heavy_minus_sign: | Color range (e.g., tv). | tv |
|
| `colorPrimaries` | *Optional\<String>* | :heavy_minus_sign: | Color primaries used. | bt2020 |
|
||||||
| `colorSpace` | *Optional\<String>* | :heavy_minus_sign: | Color space. | bt2020nc |
|
| `colorRange` | *Optional\<String>* | :heavy_minus_sign: | Color range (e.g., tv). | tv |
|
||||||
| `colorTrc` | *Optional\<String>* | :heavy_minus_sign: | Color transfer characteristics. | smpte2084 |
|
| `colorSpace` | *Optional\<String>* | :heavy_minus_sign: | Color space. | bt2020nc |
|
||||||
| `frameRate` | *Optional\<Float>* | :heavy_minus_sign: | Frame rate of the stream. | 23.976 |
|
| `colorTrc` | *Optional\<String>* | :heavy_minus_sign: | Color transfer characteristics. | smpte2084 |
|
||||||
| `height` | *Optional\<Integer>* | :heavy_minus_sign: | Height of the video stream. | 1602 |
|
| `frameRate` | *Optional\<Float>* | :heavy_minus_sign: | Frame rate of the stream. | 23.976 |
|
||||||
| `level` | *Optional\<Integer>* | :heavy_minus_sign: | Video level. | 150 |
|
| `key` | *Optional\<String>* | :heavy_minus_sign: | Key to access this stream part. | /library/streams/216389 |
|
||||||
| `original` | *Optional\<Boolean>* | :heavy_minus_sign: | Indicates if this is the original stream. | true |
|
| `height` | *Optional\<Integer>* | :heavy_minus_sign: | Height of the video stream. | 1602 |
|
||||||
| `hasScalingMatrix` | *Optional\<Boolean>* | :heavy_minus_sign: | N/A | false |
|
| `level` | *Optional\<Integer>* | :heavy_minus_sign: | Video level. | 150 |
|
||||||
| `profile` | *Optional\<String>* | :heavy_minus_sign: | Video profile. | main 10 |
|
| `original` | *Optional\<Boolean>* | :heavy_minus_sign: | Indicates if this is the original stream. | true |
|
||||||
| `scanType` | *Optional\<String>* | :heavy_minus_sign: | N/A | progressive |
|
| `hasScalingMatrix` | *Optional\<Boolean>* | :heavy_minus_sign: | N/A | false |
|
||||||
| `embeddedInVideo` | *Optional\<String>* | :heavy_minus_sign: | N/A | progressive |
|
| `profile` | *Optional\<String>* | :heavy_minus_sign: | Video profile. | main 10 |
|
||||||
| `refFrames` | *Optional\<Integer>* | :heavy_minus_sign: | Number of reference frames. | 1 |
|
| `scanType` | *Optional\<String>* | :heavy_minus_sign: | N/A | progressive |
|
||||||
| `width` | *Optional\<Integer>* | :heavy_minus_sign: | Width of the video stream. | 3840 |
|
| `embeddedInVideo` | *Optional\<String>* | :heavy_minus_sign: | N/A | progressive |
|
||||||
| `displayTitle` | *String* | :heavy_check_mark: | Display title for the stream. | 4K DoVi/HDR10 (HEVC Main 10) |
|
| `refFrames` | *Optional\<Integer>* | :heavy_minus_sign: | Number of reference frames. | 1 |
|
||||||
| `extendedDisplayTitle` | *String* | :heavy_check_mark: | Extended display title for the stream. | 4K DoVi/HDR10 (HEVC Main 10) |
|
| `width` | *Optional\<Integer>* | :heavy_minus_sign: | Width of the video stream. | 3840 |
|
||||||
| `selected` | *Optional\<Boolean>* | :heavy_minus_sign: | Indicates if this stream is selected (applicable for audio streams). | true |
|
| `displayTitle` | *String* | :heavy_check_mark: | Display title for the stream. | 4K DoVi/HDR10 (HEVC Main 10) |
|
||||||
| `forced` | *Optional\<Boolean>* | :heavy_minus_sign: | N/A | true |
|
| `extendedDisplayTitle` | *String* | :heavy_check_mark: | Extended display title for the stream. | 4K DoVi/HDR10 (HEVC Main 10) |
|
||||||
| `channels` | *Optional\<Integer>* | :heavy_minus_sign: | Number of audio channels (for audio streams). | 6 |
|
| `selected` | *Optional\<Boolean>* | :heavy_minus_sign: | Indicates if this stream is selected (applicable for audio streams). | true |
|
||||||
| `audioChannelLayout` | *Optional\<String>* | :heavy_minus_sign: | Audio channel layout. | 5.1(side) |
|
| `forced` | *Optional\<Boolean>* | :heavy_minus_sign: | N/A | true |
|
||||||
| `samplingRate` | *Optional\<Integer>* | :heavy_minus_sign: | Sampling rate for the audio stream. | 48000 |
|
| `channels` | *Optional\<Integer>* | :heavy_minus_sign: | Number of audio channels (for audio streams). | 6 |
|
||||||
| `canAutoSync` | *Optional\<Boolean>* | :heavy_minus_sign: | Indicates if the stream can auto-sync. | false |
|
| `audioChannelLayout` | *Optional\<String>* | :heavy_minus_sign: | Audio channel layout. | 5.1(side) |
|
||||||
| `hearingImpaired` | *Optional\<Boolean>* | :heavy_minus_sign: | Indicates if the stream is for the hearing impaired. | true |
|
| `samplingRate` | *Optional\<Integer>* | :heavy_minus_sign: | Sampling rate for the audio stream. | 48000 |
|
||||||
| `dub` | *Optional\<Boolean>* | :heavy_minus_sign: | Indicates if the stream is a dub. | true |
|
| `canAutoSync` | *Optional\<Boolean>* | :heavy_minus_sign: | Indicates if the stream can auto-sync. | false |
|
||||||
| `title` | *Optional\<String>* | :heavy_minus_sign: | Optional title for the stream (e.g., language variant). | SDH |
|
| `hearingImpaired` | *Optional\<Boolean>* | :heavy_minus_sign: | Indicates if the stream is for the hearing impaired. | true |
|
||||||
|
| `dub` | *Optional\<Boolean>* | :heavy_minus_sign: | Indicates if the stream is a dub. | true |
|
||||||
|
| `title` | *Optional\<String>* | :heavy_minus_sign: | Optional title for the stream (e.g., language variant). | SDH |
|
||||||
16
docs/models/operations/GetMediaMetaDataStreamType.md
Normal file
16
docs/models/operations/GetMediaMetaDataStreamType.md
Normal file
@@ -0,0 +1,16 @@
|
|||||||
|
# GetMediaMetaDataStreamType
|
||||||
|
|
||||||
|
Stream type:
|
||||||
|
- 1 = video
|
||||||
|
- 2 = audio
|
||||||
|
- 3 = subtitle
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
## Values
|
||||||
|
|
||||||
|
| Name | Value |
|
||||||
|
| ---------- | ---------- |
|
||||||
|
| `Video` | 1 |
|
||||||
|
| `Audio` | 2 |
|
||||||
|
| `Subtitle` | 3 |
|
||||||
20
docs/models/operations/GetMediaMetaDataType.md
Normal file
20
docs/models/operations/GetMediaMetaDataType.md
Normal file
@@ -0,0 +1,20 @@
|
|||||||
|
# GetMediaMetaDataType
|
||||||
|
|
||||||
|
The type of media content in the Plex library. This can represent videos, music, or photos.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
## Values
|
||||||
|
|
||||||
|
| Name | Value |
|
||||||
|
| ------------ | ------------ |
|
||||||
|
| `Movie` | movie |
|
||||||
|
| `TvShow` | show |
|
||||||
|
| `Season` | season |
|
||||||
|
| `Episode` | episode |
|
||||||
|
| `Artist` | artist |
|
||||||
|
| `Album` | album |
|
||||||
|
| `Track` | track |
|
||||||
|
| `PhotoAlbum` | photoalbum |
|
||||||
|
| `Photo` | photo |
|
||||||
|
| `Collection` | collection |
|
||||||
@@ -3,9 +3,9 @@
|
|||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
| Field | Type | Required | Description | Example |
|
||||||
| ----------------------------- | ----------------------------- | ----------------------------- | ----------------------------- | ----------------------------- |
|
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
|
||||||
| `topLeft` | *String* | :heavy_check_mark: | The top-left color value. | 11333a |
|
| `topLeft` | *String* | :heavy_check_mark: | N/A | 11333b |
|
||||||
| `topRight` | *String* | :heavy_check_mark: | The top-right color value. | 1d2721 |
|
| `topRight` | *String* | :heavy_check_mark: | N/A | 0a232d |
|
||||||
| `bottomRight` | *String* | :heavy_check_mark: | The bottom-right color value. | 5c451d |
|
| `bottomRight` | *String* | :heavy_check_mark: | N/A | 73958 |
|
||||||
| `bottomLeft` | *String* | :heavy_check_mark: | The bottom-left color value. | 372c10 |
|
| `bottomLeft` | *String* | :heavy_check_mark: | N/A | 1f5066 |
|
||||||
@@ -3,11 +3,10 @@
|
|||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
| Field | Type | Required | Description | Example |
|
||||||
| ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- |
|
| --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- |
|
||||||
| `id` | *long* | :heavy_check_mark: | The unique role identifier. | 109501 |
|
| `id` | *int* | :heavy_check_mark: | Unique identifier for the writer. | 126522 |
|
||||||
| `filter` | *String* | :heavy_check_mark: | The filter string for the role. | actor=109501 |
|
| `tag` | *String* | :heavy_check_mark: | The role of Writer | Jamie P. Hanson |
|
||||||
| `tag` | *String* | :heavy_check_mark: | The actor's name. | Bob Odenkirk |
|
| `filter` | *String* | :heavy_check_mark: | The filter string used to query this writer. | writer=126522 |
|
||||||
| `tagKey` | *String* | :heavy_check_mark: | A key associated with the actor tag. | 5d77683254f42c001f8c3f69 |
|
| `thumb` | *Optional\<String>* | :heavy_minus_sign: | The absolute URL of the thumbnail image for the writer. | https://metadata-static.plex.tv/8/people/8d65fa96804802e08f2de09fe014408e.jpg |
|
||||||
| `role` | *Optional\<String>* | :heavy_minus_sign: | The character name or role. | Jimmy McGill |
|
| `tagKey` | *Optional\<String>* | :heavy_minus_sign: | A 24-character hexadecimal unique key associated with the writer’s tag, used for internal identification. | 5d77683d85719b001f3a535e |
|
||||||
| `thumb` | *Optional\<String>* | :heavy_minus_sign: | URL for the role thumbnail image. | https://metadata-static.plex.tv/f/people/f2ca7b474cc984efbdd5c503a096285a.jpg |
|
|
||||||
@@ -11,12 +11,14 @@ E.g. A movie library will not return anything with type 3 as there are no season
|
|||||||
|
|
||||||
## Values
|
## Values
|
||||||
|
|
||||||
| Name | Value |
|
| Name | Value |
|
||||||
| --------- | --------- |
|
| ------------ | ------------ |
|
||||||
| `Movie` | 1 |
|
| `Movie` | 1 |
|
||||||
| `TvShow` | 2 |
|
| `TvShow` | 2 |
|
||||||
| `Season` | 3 |
|
| `Season` | 3 |
|
||||||
| `Episode` | 4 |
|
| `Episode` | 4 |
|
||||||
| `Audio` | 8 |
|
| `Artist` | 5 |
|
||||||
| `Album` | 9 |
|
| `Album` | 6 |
|
||||||
| `Track` | 10 |
|
| `Track` | 7 |
|
||||||
|
| `PhotoAlbum` | 8 |
|
||||||
|
| `Photo` | 9 |
|
||||||
@@ -1,16 +1,20 @@
|
|||||||
# GetRecentlyAddedHubsType
|
# GetRecentlyAddedHubsType
|
||||||
|
|
||||||
The type of media content
|
The type of media content in the Plex library. This can represent videos, music, or photos.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## Values
|
## Values
|
||||||
|
|
||||||
| Name | Value |
|
| Name | Value |
|
||||||
| --------- | --------- |
|
| ------------ | ------------ |
|
||||||
| `Movie` | movie |
|
| `Movie` | movie |
|
||||||
| `TvShow` | show |
|
| `TvShow` | show |
|
||||||
| `Season` | season |
|
| `Season` | season |
|
||||||
| `Episode` | episode |
|
| `Episode` | episode |
|
||||||
| `Artist` | artist |
|
| `Artist` | artist |
|
||||||
| `Album` | album |
|
| `Album` | album |
|
||||||
|
| `Track` | track |
|
||||||
|
| `PhotoAlbum` | photoalbum |
|
||||||
|
| `Photo` | photo |
|
||||||
|
| `Collection` | collection |
|
||||||
@@ -71,6 +71,7 @@ Unknown
|
|||||||
| `year` | *Optional\<Integer>* | :heavy_minus_sign: | The release year of the media item. | 2022 |
|
| `year` | *Optional\<Integer>* | :heavy_minus_sign: | The release year of the media item. | 2022 |
|
||||||
| `image` | List\<[GetRecentlyAddedImage](../../models/operations/GetRecentlyAddedImage.md)> | :heavy_minus_sign: | N/A | |
|
| `image` | List\<[GetRecentlyAddedImage](../../models/operations/GetRecentlyAddedImage.md)> | :heavy_minus_sign: | N/A | |
|
||||||
| `ultraBlurColors` | [Optional\<UltraBlurColors>](../../models/operations/UltraBlurColors.md) | :heavy_minus_sign: | N/A | |
|
| `ultraBlurColors` | [Optional\<UltraBlurColors>](../../models/operations/UltraBlurColors.md) | :heavy_minus_sign: | N/A | |
|
||||||
|
| `guids` | List\<[Guids](../../models/operations/Guids.md)> | :heavy_minus_sign: | N/A | |
|
||||||
| `media` | List\<[Media](../../models/operations/Media.md)> | :heavy_minus_sign: | N/A | |
|
| `media` | List\<[Media](../../models/operations/Media.md)> | :heavy_minus_sign: | N/A | |
|
||||||
| `genre` | List\<[Genre](../../models/operations/Genre.md)> | :heavy_minus_sign: | N/A | |
|
| `genre` | List\<[Genre](../../models/operations/Genre.md)> | :heavy_minus_sign: | N/A | |
|
||||||
| `country` | List\<[Country](../../models/operations/Country.md)> | :heavy_minus_sign: | N/A | |
|
| `country` | List\<[Country](../../models/operations/Country.md)> | :heavy_minus_sign: | N/A | |
|
||||||
@@ -81,5 +82,4 @@ Unknown
|
|||||||
| `rating1` | List\<[Rating](../../models/operations/Rating.md)> | :heavy_minus_sign: | N/A | |
|
| `rating1` | List\<[Rating](../../models/operations/Rating.md)> | :heavy_minus_sign: | N/A | |
|
||||||
| `similar` | List\<[Similar](../../models/operations/Similar.md)> | :heavy_minus_sign: | N/A | |
|
| `similar` | List\<[Similar](../../models/operations/Similar.md)> | :heavy_minus_sign: | N/A | |
|
||||||
| `location` | List\<[Location](../../models/operations/Location.md)> | :heavy_minus_sign: | N/A | |
|
| `location` | List\<[Location](../../models/operations/Location.md)> | :heavy_minus_sign: | N/A | |
|
||||||
| `guids` | List\<[Guids](../../models/operations/Guids.md)> | :heavy_minus_sign: | N/A | |
|
|
||||||
| `collection` | List\<[Collection](../../models/operations/Collection.md)> | :heavy_minus_sign: | N/A | |
|
| `collection` | List\<[Collection](../../models/operations/Collection.md)> | :heavy_minus_sign: | N/A | |
|
||||||
@@ -13,7 +13,7 @@
|
|||||||
| `librarySectionID` | *Optional\<Long>* | :heavy_minus_sign: | N/A | 1 |
|
| `librarySectionID` | *Optional\<Long>* | :heavy_minus_sign: | N/A | 1 |
|
||||||
| `librarySectionTitle` | *Optional\<String>* | :heavy_minus_sign: | N/A | Movies |
|
| `librarySectionTitle` | *Optional\<String>* | :heavy_minus_sign: | N/A | Movies |
|
||||||
| `librarySectionKey` | *Optional\<String>* | :heavy_minus_sign: | N/A | /library/sections/1 |
|
| `librarySectionKey` | *Optional\<String>* | :heavy_minus_sign: | N/A | /library/sections/1 |
|
||||||
| `type` | [GetSearchAllLibrariesType](../../models/operations/GetSearchAllLibrariesType.md) | :heavy_check_mark: | The type of media content<br/> | movie |
|
| `type` | [GetSearchAllLibrariesType](../../models/operations/GetSearchAllLibrariesType.md) | :heavy_check_mark: | The type of media content in the Plex library. This can represent videos, music, or photos.<br/> | movie |
|
||||||
| `title` | *String* | :heavy_check_mark: | N/A | Avatar: The Way of Water |
|
| `title` | *String* | :heavy_check_mark: | N/A | Avatar: The Way of Water |
|
||||||
| `slug` | *Optional\<String>* | :heavy_minus_sign: | N/A | 4-for-texas |
|
| `slug` | *Optional\<String>* | :heavy_minus_sign: | N/A | 4-for-texas |
|
||||||
| `contentRating` | *Optional\<String>* | :heavy_minus_sign: | N/A | PG-13 |
|
| `contentRating` | *Optional\<String>* | :heavy_minus_sign: | N/A | PG-13 |
|
||||||
|
|||||||
@@ -1,16 +1,20 @@
|
|||||||
# GetSearchAllLibrariesType
|
# GetSearchAllLibrariesType
|
||||||
|
|
||||||
The type of media content
|
The type of media content in the Plex library. This can represent videos, music, or photos.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## Values
|
## Values
|
||||||
|
|
||||||
| Name | Value |
|
| Name | Value |
|
||||||
| --------- | --------- |
|
| ------------ | ------------ |
|
||||||
| `Movie` | movie |
|
| `Movie` | movie |
|
||||||
| `TvShow` | show |
|
| `TvShow` | show |
|
||||||
| `Season` | season |
|
| `Season` | season |
|
||||||
| `Episode` | episode |
|
| `Episode` | episode |
|
||||||
| `Artist` | artist |
|
| `Artist` | artist |
|
||||||
| `Album` | album |
|
| `Album` | album |
|
||||||
|
| `Track` | track |
|
||||||
|
| `PhotoAlbum` | photoalbum |
|
||||||
|
| `Photo` | photo |
|
||||||
|
| `Collection` | collection |
|
||||||
@@ -11,12 +11,14 @@ E.g. A movie library will not return anything with type 3 as there are no season
|
|||||||
|
|
||||||
## Values
|
## Values
|
||||||
|
|
||||||
| Name | Value |
|
| Name | Value |
|
||||||
| --------- | --------- |
|
| ------------ | ------------ |
|
||||||
| `Movie` | 1 |
|
| `Movie` | 1 |
|
||||||
| `TvShow` | 2 |
|
| `TvShow` | 2 |
|
||||||
| `Season` | 3 |
|
| `Season` | 3 |
|
||||||
| `Episode` | 4 |
|
| `Episode` | 4 |
|
||||||
| `Audio` | 8 |
|
| `Artist` | 5 |
|
||||||
| `Album` | 9 |
|
| `Album` | 6 |
|
||||||
| `Track` | 10 |
|
| `Track` | 7 |
|
||||||
|
| `PhotoAlbum` | 8 |
|
||||||
|
| `Photo` | 9 |
|
||||||
@@ -5,9 +5,9 @@
|
|||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
| Field | Type | Required | Description | Example |
|
||||||
| ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- |
|
| ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- |
|
||||||
| `size` | *Optional\<Integer>* | :heavy_minus_sign: | N/A | 1 |
|
| `size` | *int* | :heavy_check_mark: | Number of media items returned in this response. | 50 |
|
||||||
| `allowSync` | *Optional\<Boolean>* | :heavy_minus_sign: | N/A | true |
|
| `allowSync` | *boolean* | :heavy_check_mark: | Indicates whether syncing is allowed. | false |
|
||||||
| `identifier` | *Optional\<String>* | :heavy_minus_sign: | N/A | com.plexapp.plugins.library |
|
| `identifier` | *String* | :heavy_check_mark: | An plugin identifier for the media container. | com.plexapp.plugins.library |
|
||||||
| `mediaTagPrefix` | *Optional\<String>* | :heavy_minus_sign: | N/A | /system/bundle/media/flags/ |
|
| `mediaTagPrefix` | *String* | :heavy_check_mark: | The prefix used for media tag resource paths. | /system/bundle/media/flags/ |
|
||||||
| `mediaTagVersion` | *Optional\<Integer>* | :heavy_minus_sign: | N/A | 1698860922 |
|
| `mediaTagVersion` | *long* | :heavy_check_mark: | The version number for media tags. | 1734362201 |
|
||||||
| `metadata` | List\<[GetTopWatchedContentMetadata](../../models/operations/GetTopWatchedContentMetadata.md)> | :heavy_minus_sign: | N/A | |
|
| `metadata` | List\<[GetTopWatchedContentMetadata](../../models/operations/GetTopWatchedContentMetadata.md)> | :heavy_minus_sign: | N/A | |
|
||||||
@@ -0,0 +1,12 @@
|
|||||||
|
# GetTopWatchedContentQueryParamIncludeGuids
|
||||||
|
|
||||||
|
Adds the Guid object to the response
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
## Values
|
||||||
|
|
||||||
|
| Name | Value |
|
||||||
|
| --------- | --------- |
|
||||||
|
| `Disable` | 0 |
|
||||||
|
| `Enable` | 1 |
|
||||||
@@ -11,12 +11,14 @@ E.g. A movie library will not return anything with type 3 as there are no season
|
|||||||
|
|
||||||
## Values
|
## Values
|
||||||
|
|
||||||
| Name | Value |
|
| Name | Value |
|
||||||
| --------- | --------- |
|
| ------------ | ------------ |
|
||||||
| `Movie` | 1 |
|
| `Movie` | 1 |
|
||||||
| `TvShow` | 2 |
|
| `TvShow` | 2 |
|
||||||
| `Season` | 3 |
|
| `Season` | 3 |
|
||||||
| `Episode` | 4 |
|
| `Episode` | 4 |
|
||||||
| `Audio` | 8 |
|
| `Artist` | 5 |
|
||||||
| `Album` | 9 |
|
| `Album` | 6 |
|
||||||
| `Track` | 10 |
|
| `Track` | 7 |
|
||||||
|
| `PhotoAlbum` | 8 |
|
||||||
|
| `Photo` | 9 |
|
||||||
@@ -5,5 +5,5 @@
|
|||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
| Field | Type | Required | Description | Example |
|
||||||
| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||||
| `includeGuids` | *Optional\<Long>* | :heavy_minus_sign: | Adds the Guids object to the response<br/> | 1 |
|
| `type` | [GetTopWatchedContentQueryParamType](../../models/operations/GetTopWatchedContentQueryParamType.md) | :heavy_check_mark: | The type of media to retrieve or filter by.<br/>1 = movie<br/>2 = show<br/>3 = season<br/>4 = episode<br/>E.g. A movie library will not return anything with type 3 as there are no seasons for movie libraries<br/> | 2 |
|
||||||
| `type` | [GetTopWatchedContentQueryParamType](../../models/operations/GetTopWatchedContentQueryParamType.md) | :heavy_check_mark: | The type of media to retrieve or filter by.<br/>1 = movie<br/>2 = show<br/>3 = season<br/>4 = episode<br/>E.g. A movie library will not return anything with type 3 as there are no seasons for movie libraries<br/> | 2 |
|
| `includeGuids` | [Optional\<GetTopWatchedContentQueryParamIncludeGuids>](../../models/operations/GetTopWatchedContentQueryParamIncludeGuids.md) | :heavy_minus_sign: | Adds the Guid object to the response<br/> | 1 |
|
||||||
@@ -3,6 +3,6 @@
|
|||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
| Field | Type | Required | Description | Example |
|
||||||
| -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- |
|
| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||||
| `id` | *Optional\<String>* | :heavy_minus_sign: | The unique identifier for the Guid. Can be imdb://tt0286347, tmdb://1763, tvdb://2337<br/> | tvdb://2337 |
|
| `id` | *String* | :heavy_check_mark: | The unique identifier for the Guid. Can be prefixed with imdb://, tmdb://, tvdb://<br/> | {<br/>"imdbExample": {<br/>"summary": "IMDB example",<br/>"value": "imdb://tt13015952"<br/>},<br/>"tmdbExample": {<br/>"summary": "TMDB example",<br/>"value": "tmdb://2434012"<br/>},<br/>"tvdbExample": {<br/>"summary": "TVDB example",<br/>"value": "tvdb://7945991"<br/>}<br/>} |
|
||||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user