mirror of
https://github.com/LukeHagar/plexjava.git
synced 2025-12-06 20:47:45 +00:00
Compare commits
4 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
26e1ac258e | ||
|
|
bf77d1e2b9 | ||
|
|
3523b6a0c8 | ||
|
|
a4a2130978 |
File diff suppressed because one or more lines are too long
@@ -7,13 +7,15 @@ generation:
|
|||||||
useClassNamesForArrayFields: true
|
useClassNamesForArrayFields: true
|
||||||
fixes:
|
fixes:
|
||||||
nameResolutionDec2023: true
|
nameResolutionDec2023: true
|
||||||
|
nameResolutionFeb2025: false
|
||||||
parameterOrderingFeb2024: true
|
parameterOrderingFeb2024: true
|
||||||
requestResponseComponentNamesFeb2024: true
|
requestResponseComponentNamesFeb2024: true
|
||||||
|
securityFeb2025: false
|
||||||
auth:
|
auth:
|
||||||
oAuth2ClientCredentialsEnabled: true
|
oAuth2ClientCredentialsEnabled: true
|
||||||
oAuth2PasswordEnabled: false
|
oAuth2PasswordEnabled: false
|
||||||
java:
|
java:
|
||||||
version: 0.11.4
|
version: 0.13.0
|
||||||
additionalDependencies: []
|
additionalDependencies: []
|
||||||
additionalPlugins: []
|
additionalPlugins: []
|
||||||
artifactID: plexapi
|
artifactID: plexapi
|
||||||
|
|||||||
@@ -1,4 +1,4 @@
|
|||||||
speakeasyVersion: 1.484.1
|
speakeasyVersion: 1.513.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:0b88c8bfc41def63e19e91fdd4d51bab07cb947cc3d39d2b44e8523a209cec10
|
sourceRevisionDigest: sha256:bf7001af017ce5072c503bfbaf60793f94549163b517489dc53e4f7b685659c0
|
||||||
sourceBlobDigest: sha256:89d5b8427d4fb61b25751aebbaf71f9613958e9e91073fc084fed2c2ec62ce55
|
sourceBlobDigest: sha256:ed2b29043c84f32d2efa92a126083fd9a81644a7ce9c6ac86d9aeb3493cbd6f8
|
||||||
tags:
|
tags:
|
||||||
- latest
|
- latest
|
||||||
- speakeasy-sdk-regen-1738715170
|
- speakeasy-sdk-regen-1741307253
|
||||||
targets:
|
targets:
|
||||||
plexjava:
|
plexjava:
|
||||||
source: plexapi
|
source: plexapi
|
||||||
sourceNamespace: plexapi
|
sourceNamespace: plexapi
|
||||||
sourceRevisionDigest: sha256:0b88c8bfc41def63e19e91fdd4d51bab07cb947cc3d39d2b44e8523a209cec10
|
sourceRevisionDigest: sha256:bf7001af017ce5072c503bfbaf60793f94549163b517489dc53e4f7b685659c0
|
||||||
sourceBlobDigest: sha256:89d5b8427d4fb61b25751aebbaf71f9613958e9e91073fc084fed2c2ec62ce55
|
sourceBlobDigest: sha256:ed2b29043c84f32d2efa92a126083fd9a81644a7ce9c6ac86d9aeb3493cbd6f8
|
||||||
codeSamplesNamespace: code-samples-java-plexjava
|
codeSamplesNamespace: code-samples-java-plexjava
|
||||||
codeSamplesRevisionDigest: sha256:2aa7538a82c8a44f72d94eb4f26788f861508b856440d207b35e5160b54e9420
|
codeSamplesRevisionDigest: sha256:867c2c5221857129302871ef35dc9c448a467474c29768830e2d291749d164c1
|
||||||
workflow:
|
workflow:
|
||||||
workflowVersion: 1.0.0
|
workflowVersion: 1.0.0
|
||||||
speakeasyVersion: latest
|
speakeasyVersion: latest
|
||||||
|
|||||||
55
README.md
55
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.11.4'
|
implementation 'dev.plexapi:plexapi:0.13.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.11.4</version>
|
<version>0.13.0</version>
|
||||||
</dependency>
|
</dependency>
|
||||||
```
|
```
|
||||||
|
|
||||||
@@ -169,12 +169,14 @@ 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
|
||||||
* [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
|
||||||
* [getCountriesLibrary](docs/sdks/library/README.md#getcountrieslibrary) - Get Countries of library media
|
* [getCountriesLibrary](docs/sdks/library/README.md#getcountrieslibrary) - Get Countries of library media
|
||||||
|
* [getActorsLibrary](docs/sdks/library/README.md#getactorslibrary) - Get Actors of library media
|
||||||
* [getSearchAllLibraries](docs/sdks/library/README.md#getsearchalllibraries) - Search All Libraries
|
* [getSearchAllLibraries](docs/sdks/library/README.md#getsearchalllibraries) - Search All Libraries
|
||||||
* [getMetaDataByRatingKey](docs/sdks/library/README.md#getmetadatabyratingkey) - Get Metadata by RatingKey
|
* [getMediaMetaData](docs/sdks/library/README.md#getmediametadata) - Get Media Metadata
|
||||||
* [getMetadataChildren](docs/sdks/library/README.md#getmetadatachildren) - Get Items Children
|
* [getMetadataChildren](docs/sdks/library/README.md#getmetadatachildren) - Get Items Children
|
||||||
* [getTopWatchedContent](docs/sdks/library/README.md#gettopwatchedcontent) - Get Top Watched Content
|
* [getTopWatchedContent](docs/sdks/library/README.md#gettopwatchedcontent) - Get Top Watched Content
|
||||||
* [getOnDeck](docs/sdks/library/README.md#getondeck) - Get On Deck
|
* [getOnDeck](docs/sdks/library/README.md#getondeck) - Get On Deck
|
||||||
@@ -253,6 +255,10 @@ public class Application {
|
|||||||
* [checkForUpdates](docs/sdks/updater/README.md#checkforupdates) - Checking for updates
|
* [checkForUpdates](docs/sdks/updater/README.md#checkforupdates) - Checking for updates
|
||||||
* [applyUpdates](docs/sdks/updater/README.md#applyupdates) - Apply Updates
|
* [applyUpdates](docs/sdks/updater/README.md#applyupdates) - Apply Updates
|
||||||
|
|
||||||
|
### [users()](docs/sdks/users/README.md)
|
||||||
|
|
||||||
|
* [getUsers](docs/sdks/users/README.md#getusers) - Get list of all connected users
|
||||||
|
|
||||||
### [video()](docs/sdks/video/README.md)
|
### [video()](docs/sdks/video/README.md)
|
||||||
|
|
||||||
* [getTimeline](docs/sdks/video/README.md#gettimeline) - Get the timeline for a media item
|
* [getTimeline](docs/sdks/video/README.md#gettimeline) - Get the timeline for a media item
|
||||||
@@ -314,13 +320,48 @@ public class Application {
|
|||||||
### Server Variables
|
### Server Variables
|
||||||
|
|
||||||
The default server `{protocol}://{ip}:{port}` contains variables and is set to `https://10.10.10.47:32400` by default. To override default values, the following builder methods are available when initializing the SDK client instance:
|
The default server `{protocol}://{ip}:{port}` contains variables and is set to `https://10.10.10.47:32400` by default. To override default values, the following builder methods are available when initializing the SDK client instance:
|
||||||
* `protocol(ServerProtocol protocol)`
|
|
||||||
* `ip(String ip)`
|
| Variable | BuilderMethod | Supported Values | Default | Description |
|
||||||
* `port(String port)`
|
| ---------- | ----------------------------------- | -------------------------- | --------------- | ---------------------------------------------- |
|
||||||
|
| `protocol` | `protocol(ServerProtocol protocol)` | - `"http"`<br/>- `"https"` | `"https"` | The protocol to use for the server connection |
|
||||||
|
| `ip` | `ip(String ip)` | java.lang.String | `"10.10.10.47"` | The IP address or hostname of your Plex Server |
|
||||||
|
| `port` | `port(String port)` | java.lang.String | `"32400"` | The port of your Plex Server |
|
||||||
|
|
||||||
|
#### Example
|
||||||
|
|
||||||
|
```java
|
||||||
|
package hello.world;
|
||||||
|
|
||||||
|
import dev.plexapi.sdk.PlexAPI;
|
||||||
|
import dev.plexapi.sdk.models.errors.GetServerCapabilitiesBadRequest;
|
||||||
|
import dev.plexapi.sdk.models.errors.GetServerCapabilitiesUnauthorized;
|
||||||
|
import dev.plexapi.sdk.models.operations.GetServerCapabilitiesResponse;
|
||||||
|
import java.lang.Exception;
|
||||||
|
|
||||||
|
public class Application {
|
||||||
|
|
||||||
|
public static void main(String[] args) throws GetServerCapabilitiesBadRequest, GetServerCapabilitiesUnauthorized, Exception {
|
||||||
|
|
||||||
|
PlexAPI sdk = PlexAPI.builder()
|
||||||
|
.protocol("https")
|
||||||
|
.ip("e0c3:bcc0:6bac:dccc:c4ec:34b1:ca98:4cb9")
|
||||||
|
.port("40311")
|
||||||
|
.accessToken("<YOUR_API_KEY_HERE>")
|
||||||
|
.build();
|
||||||
|
|
||||||
|
GetServerCapabilitiesResponse res = sdk.server().getServerCapabilities()
|
||||||
|
.call();
|
||||||
|
|
||||||
|
if (res.object().isPresent()) {
|
||||||
|
// handle response
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
### Override Server URL Per-Client
|
### Override Server URL Per-Client
|
||||||
|
|
||||||
The default server can also be overridden globally using the `.serverURL(String serverUrl)` builder method when initializing the SDK client instance. For example:
|
The default server can be overridden globally using the `.serverURL(String serverUrl)` builder method when initializing the SDK client instance. For example:
|
||||||
```java
|
```java
|
||||||
package hello.world;
|
package hello.world;
|
||||||
|
|
||||||
|
|||||||
42
RELEASES.md
42
RELEASES.md
@@ -228,4 +228,44 @@ Based on:
|
|||||||
### Generated
|
### Generated
|
||||||
- [java v0.11.4] .
|
- [java v0.11.4] .
|
||||||
### Releases
|
### Releases
|
||||||
- [Maven Central v0.11.4] https://central.sonatype.com/artifact/dev.plexapi/plexapi/0.11.4 - .
|
- [Maven Central v0.11.4] https://central.sonatype.com/artifact/dev.plexapi/plexapi/0.11.4 - .
|
||||||
|
|
||||||
|
## 2025-02-06 00:26:06
|
||||||
|
### Changes
|
||||||
|
Based on:
|
||||||
|
- OpenAPI Doc
|
||||||
|
- Speakeasy CLI 1.484.1 (2.503.2) https://github.com/speakeasy-api/speakeasy
|
||||||
|
### Generated
|
||||||
|
- [java v0.11.5] .
|
||||||
|
### Releases
|
||||||
|
- [Maven Central v0.11.5] https://central.sonatype.com/artifact/dev.plexapi/plexapi/0.11.5 - .
|
||||||
|
|
||||||
|
## 2025-02-07 00:26:07
|
||||||
|
### Changes
|
||||||
|
Based on:
|
||||||
|
- OpenAPI Doc
|
||||||
|
- Speakeasy CLI 1.487.0 (2.506.0) https://github.com/speakeasy-api/speakeasy
|
||||||
|
### Generated
|
||||||
|
- [java v0.11.6] .
|
||||||
|
### Releases
|
||||||
|
- [Maven Central v0.11.6] https://central.sonatype.com/artifact/dev.plexapi/plexapi/0.11.6 - .
|
||||||
|
|
||||||
|
## 2025-02-10 00:27:03
|
||||||
|
### Changes
|
||||||
|
Based on:
|
||||||
|
- OpenAPI Doc
|
||||||
|
- Speakeasy CLI 1.487.1 (2.506.0) https://github.com/speakeasy-api/speakeasy
|
||||||
|
### Generated
|
||||||
|
- [java v0.12.0] .
|
||||||
|
### Releases
|
||||||
|
- [Maven Central v0.12.0] https://central.sonatype.com/artifact/dev.plexapi/plexapi/0.12.0 - .
|
||||||
|
|
||||||
|
## 2025-03-07 00:27:17
|
||||||
|
### Changes
|
||||||
|
Based on:
|
||||||
|
- OpenAPI Doc
|
||||||
|
- Speakeasy CLI 1.513.2 (2.545.2) https://github.com/speakeasy-api/speakeasy
|
||||||
|
### Generated
|
||||||
|
- [java v0.13.0] .
|
||||||
|
### Releases
|
||||||
|
- [Maven Central v0.13.0] https://central.sonatype.com/artifact/dev.plexapi/plexapi/0.13.0 - .
|
||||||
@@ -63,7 +63,7 @@ tasks.withType(Javadoc) {
|
|||||||
}
|
}
|
||||||
|
|
||||||
group = "dev.plexapi"
|
group = "dev.plexapi"
|
||||||
version = "0.11.4"
|
version = "0.13.0"
|
||||||
|
|
||||||
sourcesJar {
|
sourcesJar {
|
||||||
archiveBaseName = "plexapi"
|
archiveBaseName = "plexapi"
|
||||||
@@ -101,7 +101,7 @@ publishing {
|
|||||||
maven(MavenPublication) {
|
maven(MavenPublication) {
|
||||||
groupId = 'dev.plexapi'
|
groupId = 'dev.plexapi'
|
||||||
artifactId = 'plexapi'
|
artifactId = 'plexapi'
|
||||||
version = '0.11.4'
|
version = '0.13.0'
|
||||||
|
|
||||||
from components.java
|
from components.java
|
||||||
|
|
||||||
@@ -152,7 +152,6 @@ dependencies {
|
|||||||
implementation 'com.fasterxml.jackson.datatype:jackson-datatype-jsr310:2.18.2'
|
implementation 'com.fasterxml.jackson.datatype:jackson-datatype-jsr310:2.18.2'
|
||||||
implementation 'com.fasterxml.jackson.datatype:jackson-datatype-jdk8:2.18.2'
|
implementation 'com.fasterxml.jackson.datatype:jackson-datatype-jdk8:2.18.2'
|
||||||
api('org.openapitools:jackson-databind-nullable:0.2.6') {exclude group: 'com.fasterxml.jackson.core', module: 'jackson-databind'}
|
api('org.openapitools:jackson-databind-nullable:0.2.6') {exclude group: 'com.fasterxml.jackson.core', module: 'jackson-databind'}
|
||||||
implementation 'org.apache.httpcomponents.client5:httpclient5:5.4.1'
|
|
||||||
implementation 'commons-io:commons-io:2.18.0'
|
implementation 'commons-io:commons-io:2.18.0'
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
188
codeSamples.yaml
188
codeSamples.yaml
@@ -617,7 +617,7 @@ actions:
|
|||||||
update:
|
update:
|
||||||
x-codeSamples:
|
x-codeSamples:
|
||||||
- lang: java
|
- lang: java
|
||||||
label: added
|
label: get-recently-added
|
||||||
source: |-
|
source: |-
|
||||||
package hello.world;
|
package hello.world;
|
||||||
|
|
||||||
@@ -750,7 +750,7 @@ actions:
|
|||||||
update:
|
update:
|
||||||
x-codeSamples:
|
x-codeSamples:
|
||||||
- lang: java
|
- lang: java
|
||||||
label: identity
|
label: get-server-identity
|
||||||
source: |-
|
source: |-
|
||||||
package hello.world;
|
package hello.world;
|
||||||
|
|
||||||
@@ -841,26 +841,44 @@ actions:
|
|||||||
update:
|
update:
|
||||||
x-codeSamples:
|
x-codeSamples:
|
||||||
- lang: java
|
- lang: java
|
||||||
label: key
|
label: get-media-meta-data
|
||||||
source: |-
|
source: |-
|
||||||
package hello.world;
|
package hello.world;
|
||||||
|
|
||||||
import dev.plexapi.plexapi.PlexAPI;
|
import dev.plexapi.plexapi.PlexAPI;
|
||||||
import dev.plexapi.plexapi.models.errors.GetMetaDataByRatingKeyBadRequest;
|
import dev.plexapi.plexapi.models.errors.GetMediaMetaDataBadRequest;
|
||||||
import dev.plexapi.plexapi.models.errors.GetMetaDataByRatingKeyUnauthorized;
|
import dev.plexapi.plexapi.models.errors.GetMediaMetaDataUnauthorized;
|
||||||
import dev.plexapi.plexapi.models.operations.GetMetaDataByRatingKeyResponse;
|
import dev.plexapi.plexapi.models.operations.GetMediaMetaDataRequest;
|
||||||
|
import dev.plexapi.plexapi.models.operations.GetMediaMetaDataResponse;
|
||||||
import java.lang.Exception;
|
import java.lang.Exception;
|
||||||
|
|
||||||
public class Application {
|
public class Application {
|
||||||
|
|
||||||
public static void main(String[] args) throws GetMetaDataByRatingKeyBadRequest, GetMetaDataByRatingKeyUnauthorized, Exception {
|
public static void main(String[] args) throws GetMediaMetaDataBadRequest, GetMediaMetaDataUnauthorized, Exception {
|
||||||
|
|
||||||
PlexAPI sdk = PlexAPI.builder()
|
PlexAPI sdk = PlexAPI.builder()
|
||||||
.accessToken("<YOUR_API_KEY_HERE>")
|
.accessToken("<YOUR_API_KEY_HERE>")
|
||||||
.build();
|
.build();
|
||||||
|
|
||||||
GetMetaDataByRatingKeyResponse res = sdk.library().getMetaDataByRatingKey()
|
GetMediaMetaDataRequest req = GetMediaMetaDataRequest.builder()
|
||||||
.ratingKey(9518L)
|
.ratingKey(9518L)
|
||||||
|
.includeConcerts(true)
|
||||||
|
.includeExtras(true)
|
||||||
|
.includeOnDeck(true)
|
||||||
|
.includePopularLeaves(true)
|
||||||
|
.includePreferences(true)
|
||||||
|
.includeReviews(true)
|
||||||
|
.includeChapters(true)
|
||||||
|
.includeStations(true)
|
||||||
|
.includeExternalMedia(true)
|
||||||
|
.asyncAugmentMetadata(true)
|
||||||
|
.asyncCheckFiles(true)
|
||||||
|
.asyncRefreshAnalysis(true)
|
||||||
|
.asyncRefreshLocalMediaAgent(true)
|
||||||
|
.build();
|
||||||
|
|
||||||
|
GetMediaMetaDataResponse res = sdk.library().getMediaMetaData()
|
||||||
|
.request(req)
|
||||||
.call();
|
.call();
|
||||||
|
|
||||||
if (res.object().isPresent()) {
|
if (res.object().isPresent()) {
|
||||||
@@ -872,7 +890,7 @@ actions:
|
|||||||
update:
|
update:
|
||||||
x-codeSamples:
|
x-codeSamples:
|
||||||
- lang: java
|
- lang: java
|
||||||
label: image
|
label: get-banner-image
|
||||||
source: |-
|
source: |-
|
||||||
package hello.world;
|
package hello.world;
|
||||||
|
|
||||||
@@ -945,7 +963,7 @@ actions:
|
|||||||
update:
|
update:
|
||||||
x-codeSamples:
|
x-codeSamples:
|
||||||
- lang: java
|
- lang: java
|
||||||
label: image
|
label: get-thumb-image
|
||||||
source: |-
|
source: |-
|
||||||
package hello.world;
|
package hello.world;
|
||||||
|
|
||||||
@@ -1016,7 +1034,7 @@ actions:
|
|||||||
update:
|
update:
|
||||||
x-codeSamples:
|
x-codeSamples:
|
||||||
- lang: java
|
- lang: java
|
||||||
label: library
|
label: get-recently-added-library
|
||||||
source: |-
|
source: |-
|
||||||
package hello.world;
|
package hello.world;
|
||||||
|
|
||||||
@@ -1069,7 +1087,7 @@ actions:
|
|||||||
update:
|
update:
|
||||||
x-codeSamples:
|
x-codeSamples:
|
||||||
- lang: java
|
- lang: java
|
||||||
label: libraries
|
label: get-search-all-libraries
|
||||||
source: |-
|
source: |-
|
||||||
package hello.world;
|
package hello.world;
|
||||||
|
|
||||||
@@ -1110,7 +1128,7 @@ actions:
|
|||||||
update:
|
update:
|
||||||
x-codeSamples:
|
x-codeSamples:
|
||||||
- lang: java
|
- lang: java
|
||||||
label: libraries
|
label: get-all-libraries
|
||||||
source: |-
|
source: |-
|
||||||
package hello.world;
|
package hello.world;
|
||||||
|
|
||||||
@@ -1140,7 +1158,7 @@ actions:
|
|||||||
update:
|
update:
|
||||||
x-codeSamples:
|
x-codeSamples:
|
||||||
- lang: java
|
- lang: java
|
||||||
label: list
|
label: get-watch-list
|
||||||
source: |-
|
source: |-
|
||||||
package hello.world;
|
package hello.world;
|
||||||
|
|
||||||
@@ -1207,7 +1225,7 @@ actions:
|
|||||||
update:
|
update:
|
||||||
x-codeSamples:
|
x-codeSamples:
|
||||||
- lang: java
|
- lang: java
|
||||||
label: details
|
label: get-library-details
|
||||||
source: |-
|
source: |-
|
||||||
package hello.world;
|
package hello.world;
|
||||||
|
|
||||||
@@ -1231,6 +1249,77 @@ actions:
|
|||||||
.sectionKey(9518)
|
.sectionKey(9518)
|
||||||
.call();
|
.call();
|
||||||
|
|
||||||
|
if (res.object().isPresent()) {
|
||||||
|
// handle response
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
- target: $["paths"]["/library/sections/{sectionKey}/actor"]["get"]
|
||||||
|
update:
|
||||||
|
x-codeSamples:
|
||||||
|
- lang: java
|
||||||
|
label: get-actors-library
|
||||||
|
source: |-
|
||||||
|
package hello.world;
|
||||||
|
|
||||||
|
import dev.plexapi.plexapi.PlexAPI;
|
||||||
|
import dev.plexapi.plexapi.models.errors.GetActorsLibraryBadRequest;
|
||||||
|
import dev.plexapi.plexapi.models.errors.GetActorsLibraryUnauthorized;
|
||||||
|
import dev.plexapi.plexapi.models.operations.GetActorsLibraryQueryParamType;
|
||||||
|
import dev.plexapi.plexapi.models.operations.GetActorsLibraryResponse;
|
||||||
|
import java.lang.Exception;
|
||||||
|
|
||||||
|
public class Application {
|
||||||
|
|
||||||
|
public static void main(String[] args) throws GetActorsLibraryBadRequest, GetActorsLibraryUnauthorized, Exception {
|
||||||
|
|
||||||
|
PlexAPI sdk = PlexAPI.builder()
|
||||||
|
.accessToken("<YOUR_API_KEY_HERE>")
|
||||||
|
.build();
|
||||||
|
|
||||||
|
GetActorsLibraryResponse res = sdk.library().getActorsLibrary()
|
||||||
|
.sectionKey(9518)
|
||||||
|
.type(GetActorsLibraryQueryParamType.TvShow)
|
||||||
|
.call();
|
||||||
|
|
||||||
|
if (res.object().isPresent()) {
|
||||||
|
// handle response
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
- target: $["paths"]["/library/sections/{sectionKey}/all"]["get"]
|
||||||
|
update:
|
||||||
|
x-codeSamples:
|
||||||
|
- lang: java
|
||||||
|
label: get-all-media-library
|
||||||
|
source: |-
|
||||||
|
package hello.world;
|
||||||
|
|
||||||
|
import dev.plexapi.plexapi.PlexAPI;
|
||||||
|
import dev.plexapi.plexapi.models.errors.GetAllMediaLibraryBadRequest;
|
||||||
|
import dev.plexapi.plexapi.models.errors.GetAllMediaLibraryUnauthorized;
|
||||||
|
import dev.plexapi.plexapi.models.operations.GetAllMediaLibraryQueryParamType;
|
||||||
|
import dev.plexapi.plexapi.models.operations.GetAllMediaLibraryRequest;
|
||||||
|
import dev.plexapi.plexapi.models.operations.GetAllMediaLibraryResponse;
|
||||||
|
import java.lang.Exception;
|
||||||
|
|
||||||
|
public class Application {
|
||||||
|
|
||||||
|
public static void main(String[] args) throws GetAllMediaLibraryBadRequest, GetAllMediaLibraryUnauthorized, Exception {
|
||||||
|
|
||||||
|
PlexAPI sdk = PlexAPI.builder()
|
||||||
|
.accessToken("<YOUR_API_KEY_HERE>")
|
||||||
|
.build();
|
||||||
|
|
||||||
|
GetAllMediaLibraryRequest req = GetAllMediaLibraryRequest.builder()
|
||||||
|
.sectionKey(9518)
|
||||||
|
.type(GetAllMediaLibraryQueryParamType.TvShow)
|
||||||
|
.build();
|
||||||
|
|
||||||
|
GetAllMediaLibraryResponse res = sdk.library().getAllMediaLibrary()
|
||||||
|
.request(req)
|
||||||
|
.call();
|
||||||
|
|
||||||
if (res.object().isPresent()) {
|
if (res.object().isPresent()) {
|
||||||
// handle response
|
// handle response
|
||||||
}
|
}
|
||||||
@@ -1240,13 +1329,14 @@ actions:
|
|||||||
update:
|
update:
|
||||||
x-codeSamples:
|
x-codeSamples:
|
||||||
- lang: java
|
- lang: java
|
||||||
label: library
|
label: get-countries-library
|
||||||
source: |-
|
source: |-
|
||||||
package hello.world;
|
package hello.world;
|
||||||
|
|
||||||
import dev.plexapi.plexapi.PlexAPI;
|
import dev.plexapi.plexapi.PlexAPI;
|
||||||
import dev.plexapi.plexapi.models.errors.GetCountriesLibraryBadRequest;
|
import dev.plexapi.plexapi.models.errors.GetCountriesLibraryBadRequest;
|
||||||
import dev.plexapi.plexapi.models.errors.GetCountriesLibraryUnauthorized;
|
import dev.plexapi.plexapi.models.errors.GetCountriesLibraryUnauthorized;
|
||||||
|
import dev.plexapi.plexapi.models.operations.GetCountriesLibraryQueryParamType;
|
||||||
import dev.plexapi.plexapi.models.operations.GetCountriesLibraryResponse;
|
import dev.plexapi.plexapi.models.operations.GetCountriesLibraryResponse;
|
||||||
import java.lang.Exception;
|
import java.lang.Exception;
|
||||||
|
|
||||||
@@ -1260,6 +1350,7 @@ actions:
|
|||||||
|
|
||||||
GetCountriesLibraryResponse res = sdk.library().getCountriesLibrary()
|
GetCountriesLibraryResponse res = sdk.library().getCountriesLibrary()
|
||||||
.sectionKey(9518)
|
.sectionKey(9518)
|
||||||
|
.type(GetCountriesLibraryQueryParamType.TvShow)
|
||||||
.call();
|
.call();
|
||||||
|
|
||||||
if (res.object().isPresent()) {
|
if (res.object().isPresent()) {
|
||||||
@@ -1271,13 +1362,14 @@ actions:
|
|||||||
update:
|
update:
|
||||||
x-codeSamples:
|
x-codeSamples:
|
||||||
- lang: java
|
- lang: java
|
||||||
label: library
|
label: get-genres-library
|
||||||
source: |-
|
source: |-
|
||||||
package hello.world;
|
package hello.world;
|
||||||
|
|
||||||
import dev.plexapi.plexapi.PlexAPI;
|
import dev.plexapi.plexapi.PlexAPI;
|
||||||
import dev.plexapi.plexapi.models.errors.GetGenresLibraryBadRequest;
|
import dev.plexapi.plexapi.models.errors.GetGenresLibraryBadRequest;
|
||||||
import dev.plexapi.plexapi.models.errors.GetGenresLibraryUnauthorized;
|
import dev.plexapi.plexapi.models.errors.GetGenresLibraryUnauthorized;
|
||||||
|
import dev.plexapi.plexapi.models.operations.GetGenresLibraryQueryParamType;
|
||||||
import dev.plexapi.plexapi.models.operations.GetGenresLibraryResponse;
|
import dev.plexapi.plexapi.models.operations.GetGenresLibraryResponse;
|
||||||
import java.lang.Exception;
|
import java.lang.Exception;
|
||||||
|
|
||||||
@@ -1291,6 +1383,7 @@ actions:
|
|||||||
|
|
||||||
GetGenresLibraryResponse res = sdk.library().getGenresLibrary()
|
GetGenresLibraryResponse res = sdk.library().getGenresLibrary()
|
||||||
.sectionKey(9518)
|
.sectionKey(9518)
|
||||||
|
.type(GetGenresLibraryQueryParamType.TvShow)
|
||||||
.call();
|
.call();
|
||||||
|
|
||||||
if (res.object().isPresent()) {
|
if (res.object().isPresent()) {
|
||||||
@@ -1302,7 +1395,7 @@ actions:
|
|||||||
update:
|
update:
|
||||||
x-codeSamples:
|
x-codeSamples:
|
||||||
- lang: java
|
- lang: java
|
||||||
label: metadata
|
label: get-refresh-library-metadata
|
||||||
source: |-
|
source: |-
|
||||||
package hello.world;
|
package hello.world;
|
||||||
|
|
||||||
@@ -1333,7 +1426,7 @@ actions:
|
|||||||
update:
|
update:
|
||||||
x-codeSamples:
|
x-codeSamples:
|
||||||
- lang: java
|
- lang: java
|
||||||
label: library
|
label: get-search-library
|
||||||
source: |-
|
source: |-
|
||||||
package hello.world;
|
package hello.world;
|
||||||
|
|
||||||
@@ -1366,7 +1459,7 @@ actions:
|
|||||||
update:
|
update:
|
||||||
x-codeSamples:
|
x-codeSamples:
|
||||||
- lang: java
|
- lang: java
|
||||||
label: items
|
label: get-library-items
|
||||||
source: |-
|
source: |-
|
||||||
package hello.world;
|
package hello.world;
|
||||||
|
|
||||||
@@ -1389,8 +1482,8 @@ actions:
|
|||||||
|
|
||||||
GetLibraryItemsRequest req = GetLibraryItemsRequest.builder()
|
GetLibraryItemsRequest req = GetLibraryItemsRequest.builder()
|
||||||
.tag(Tag.EDITION)
|
.tag(Tag.EDITION)
|
||||||
.sectionKey(9518)
|
|
||||||
.type(GetLibraryItemsQueryParamType.TvShow)
|
.type(GetLibraryItemsQueryParamType.TvShow)
|
||||||
|
.sectionKey(9518)
|
||||||
.build();
|
.build();
|
||||||
|
|
||||||
GetLibraryItemsResponse res = sdk.library().getLibraryItems()
|
GetLibraryItemsResponse res = sdk.library().getLibraryItems()
|
||||||
@@ -1498,7 +1591,7 @@ actions:
|
|||||||
update:
|
update:
|
||||||
x-codeSamples:
|
x-codeSamples:
|
||||||
- lang: java
|
- lang: java
|
||||||
label: providers
|
label: get-media-providers
|
||||||
source: |-
|
source: |-
|
||||||
package hello.world;
|
package hello.world;
|
||||||
|
|
||||||
@@ -1972,7 +2065,7 @@ actions:
|
|||||||
update:
|
update:
|
||||||
x-codeSamples:
|
x-codeSamples:
|
||||||
- lang: java
|
- lang: java
|
||||||
label: resources
|
label: get-server-resources
|
||||||
source: |-
|
source: |-
|
||||||
package hello.world;
|
package hello.world;
|
||||||
|
|
||||||
@@ -2467,11 +2560,58 @@ actions:
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
- target: $["paths"]["/users"]["get"]
|
||||||
|
update:
|
||||||
|
x-codeSamples:
|
||||||
|
- lang: java
|
||||||
|
label: get-users
|
||||||
|
source: |-
|
||||||
|
package hello.world;
|
||||||
|
|
||||||
|
import dev.plexapi.plexapi.PlexAPI;
|
||||||
|
import dev.plexapi.plexapi.models.errors.GetUsersBadRequest;
|
||||||
|
import dev.plexapi.plexapi.models.errors.GetUsersUnauthorized;
|
||||||
|
import dev.plexapi.plexapi.models.operations.GetUsersRequest;
|
||||||
|
import dev.plexapi.plexapi.models.operations.GetUsersResponse;
|
||||||
|
import java.lang.Exception;
|
||||||
|
|
||||||
|
public class Application {
|
||||||
|
|
||||||
|
public static void main(String[] args) throws GetUsersBadRequest, GetUsersUnauthorized, Exception {
|
||||||
|
|
||||||
|
PlexAPI sdk = PlexAPI.builder()
|
||||||
|
.build();
|
||||||
|
|
||||||
|
GetUsersRequest req = GetUsersRequest.builder()
|
||||||
|
.clientID("3381b62b-9ab7-4e37-827b-203e9809eb58")
|
||||||
|
.xPlexToken("CV5xoxjTpFKUzBTShsaf")
|
||||||
|
.clientName("Plex for Roku")
|
||||||
|
.deviceNickname("Roku 3")
|
||||||
|
.deviceName("Chrome")
|
||||||
|
.deviceScreenResolution("1487x1165,2560x1440")
|
||||||
|
.clientVersion("2.4.1")
|
||||||
|
.platform("Roku")
|
||||||
|
.clientFeatures("external-media,indirect-media,hub-style-list")
|
||||||
|
.model("4200X")
|
||||||
|
.xPlexSessionId("97e136ef-4ddd-4ff3-89a7-a5820c96c2ca")
|
||||||
|
.xPlexLanguage("en")
|
||||||
|
.platformVersion("4.3 build 1057")
|
||||||
|
.build();
|
||||||
|
|
||||||
|
GetUsersResponse res = sdk.users().getUsers()
|
||||||
|
.request(req)
|
||||||
|
.call();
|
||||||
|
|
||||||
|
if (res.body().isPresent()) {
|
||||||
|
// handle response
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
- target: $["paths"]["/users/signin"]["post"]
|
- target: $["paths"]["/users/signin"]["post"]
|
||||||
update:
|
update:
|
||||||
x-codeSamples:
|
x-codeSamples:
|
||||||
- lang: java
|
- lang: java
|
||||||
label: data
|
label: post-users-sign-in-data
|
||||||
source: |-
|
source: |-
|
||||||
package hello.world;
|
package hello.world;
|
||||||
|
|
||||||
|
|||||||
@@ -1,4 +1,4 @@
|
|||||||
# GetMetaDataByRatingKeyBadRequest
|
# GetActorsLibraryBadRequest
|
||||||
|
|
||||||
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\<[GetMetaDataByRatingKeyErrors](../../models/errors/GetMetaDataByRatingKeyErrors.md)> | :heavy_minus_sign: | N/A |
|
| `errors` | List\<[GetActorsLibraryErrors](../../models/errors/GetActorsLibraryErrors.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 @@
|
|||||||
# GetMetaDataByRatingKeyErrors
|
# GetActorsLibraryErrors
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
@@ -1,4 +1,4 @@
|
|||||||
# GetMetaDataByRatingKeyLibraryErrors
|
# GetActorsLibraryLibraryErrors
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
@@ -1,4 +1,4 @@
|
|||||||
# GetMetaDataByRatingKeyUnauthorized
|
# GetActorsLibraryUnauthorized
|
||||||
|
|
||||||
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\<[GetMetaDataByRatingKeyLibraryErrors](../../models/errors/GetMetaDataByRatingKeyLibraryErrors.md)> | :heavy_minus_sign: | N/A |
|
| `errors` | List\<[GetActorsLibraryLibraryErrors](../../models/errors/GetActorsLibraryLibraryErrors.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/errors/GetAllMediaLibraryBadRequest.md
Normal file
11
docs/models/errors/GetAllMediaLibraryBadRequest.md
Normal file
@@ -0,0 +1,11 @@
|
|||||||
|
# GetAllMediaLibraryBadRequest
|
||||||
|
|
||||||
|
Bad Request - A parameter was not specified, or was specified incorrectly.
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ |
|
||||||
|
| `errors` | List\<[GetAllMediaLibraryErrors](../../models/errors/GetAllMediaLibraryErrors.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 |
|
||||||
10
docs/models/errors/GetAllMediaLibraryErrors.md
Normal file
10
docs/models/errors/GetAllMediaLibraryErrors.md
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
# GetAllMediaLibraryErrors
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- |
|
||||||
|
| `code` | *Optional\<Integer>* | :heavy_minus_sign: | N/A | 1000 |
|
||||||
|
| `message` | *Optional\<String>* | :heavy_minus_sign: | N/A | X-Plex-Client-Identifier is missing |
|
||||||
|
| `status` | *Optional\<Integer>* | :heavy_minus_sign: | N/A | 400 |
|
||||||
10
docs/models/errors/GetAllMediaLibraryLibraryErrors.md
Normal file
10
docs/models/errors/GetAllMediaLibraryLibraryErrors.md
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
# GetAllMediaLibraryLibraryErrors
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
||||||
|
| `code` | *Optional\<Integer>* | :heavy_minus_sign: | N/A | 1001 |
|
||||||
|
| `message` | *Optional\<String>* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
||||||
|
| `status` | *Optional\<Integer>* | :heavy_minus_sign: | N/A | 401 |
|
||||||
11
docs/models/errors/GetAllMediaLibraryUnauthorized.md
Normal file
11
docs/models/errors/GetAllMediaLibraryUnauthorized.md
Normal file
@@ -0,0 +1,11 @@
|
|||||||
|
# GetAllMediaLibraryUnauthorized
|
||||||
|
|
||||||
|
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ |
|
||||||
|
| `errors` | List\<[GetAllMediaLibraryLibraryErrors](../../models/errors/GetAllMediaLibraryLibraryErrors.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 |
|
||||||
11
docs/models/errors/GetMediaMetaDataBadRequest.md
Normal file
11
docs/models/errors/GetMediaMetaDataBadRequest.md
Normal file
@@ -0,0 +1,11 @@
|
|||||||
|
# GetMediaMetaDataBadRequest
|
||||||
|
|
||||||
|
Bad Request - A parameter was not specified, or was specified incorrectly.
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ |
|
||||||
|
| `errors` | List\<[GetMediaMetaDataErrors](../../models/errors/GetMediaMetaDataErrors.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 |
|
||||||
10
docs/models/errors/GetMediaMetaDataErrors.md
Normal file
10
docs/models/errors/GetMediaMetaDataErrors.md
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
# GetMediaMetaDataErrors
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- |
|
||||||
|
| `code` | *Optional\<Integer>* | :heavy_minus_sign: | N/A | 1000 |
|
||||||
|
| `message` | *Optional\<String>* | :heavy_minus_sign: | N/A | X-Plex-Client-Identifier is missing |
|
||||||
|
| `status` | *Optional\<Integer>* | :heavy_minus_sign: | N/A | 400 |
|
||||||
10
docs/models/errors/GetMediaMetaDataLibraryErrors.md
Normal file
10
docs/models/errors/GetMediaMetaDataLibraryErrors.md
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
# GetMediaMetaDataLibraryErrors
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
||||||
|
| `code` | *Optional\<Integer>* | :heavy_minus_sign: | N/A | 1001 |
|
||||||
|
| `message` | *Optional\<String>* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
||||||
|
| `status` | *Optional\<Integer>* | :heavy_minus_sign: | N/A | 401 |
|
||||||
11
docs/models/errors/GetMediaMetaDataUnauthorized.md
Normal file
11
docs/models/errors/GetMediaMetaDataUnauthorized.md
Normal file
@@ -0,0 +1,11 @@
|
|||||||
|
# GetMediaMetaDataUnauthorized
|
||||||
|
|
||||||
|
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ |
|
||||||
|
| `errors` | List\<[GetMediaMetaDataLibraryErrors](../../models/errors/GetMediaMetaDataLibraryErrors.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 |
|
||||||
11
docs/models/errors/GetUsersBadRequest.md
Normal file
11
docs/models/errors/GetUsersBadRequest.md
Normal file
@@ -0,0 +1,11 @@
|
|||||||
|
# GetUsersBadRequest
|
||||||
|
|
||||||
|
Bad Request - A parameter was not specified, or was specified incorrectly.
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ |
|
||||||
|
| `errors` | List\<[GetUsersErrors](../../models/errors/GetUsersErrors.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 |
|
||||||
10
docs/models/errors/GetUsersErrors.md
Normal file
10
docs/models/errors/GetUsersErrors.md
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
# GetUsersErrors
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- |
|
||||||
|
| `code` | *Optional\<Integer>* | :heavy_minus_sign: | N/A | 1000 |
|
||||||
|
| `message` | *Optional\<String>* | :heavy_minus_sign: | N/A | X-Plex-Client-Identifier is missing |
|
||||||
|
| `status` | *Optional\<Integer>* | :heavy_minus_sign: | N/A | 400 |
|
||||||
11
docs/models/errors/GetUsersUnauthorized.md
Normal file
11
docs/models/errors/GetUsersUnauthorized.md
Normal file
@@ -0,0 +1,11 @@
|
|||||||
|
# GetUsersUnauthorized
|
||||||
|
|
||||||
|
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ |
|
||||||
|
| `errors` | List\<[GetUsersUsersErrors](../../models/errors/GetUsersUsersErrors.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 |
|
||||||
10
docs/models/errors/GetUsersUsersErrors.md
Normal file
10
docs/models/errors/GetUsersUsersErrors.md
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
# GetUsersUsersErrors
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
||||||
|
| `code` | *Optional\<Integer>* | :heavy_minus_sign: | N/A | 1001 |
|
||||||
|
| `message` | *Optional\<String>* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
||||||
|
| `status` | *Optional\<Integer>* | :heavy_minus_sign: | N/A | 401 |
|
||||||
11
docs/models/operations/AllLibraries.md
Normal file
11
docs/models/operations/AllLibraries.md
Normal file
@@ -0,0 +1,11 @@
|
|||||||
|
# AllLibraries
|
||||||
|
|
||||||
|
Indicates if the user has access to all libraries.
|
||||||
|
|
||||||
|
|
||||||
|
## Values
|
||||||
|
|
||||||
|
| Name | Value |
|
||||||
|
| --------- | --------- |
|
||||||
|
| `Disable` | 0 |
|
||||||
|
| `Enable` | 1 |
|
||||||
11
docs/models/operations/AllowCameraUpload.md
Normal file
11
docs/models/operations/AllowCameraUpload.md
Normal file
@@ -0,0 +1,11 @@
|
|||||||
|
# AllowCameraUpload
|
||||||
|
|
||||||
|
Indicates if the user is allowed to upload from a camera.
|
||||||
|
|
||||||
|
|
||||||
|
## Values
|
||||||
|
|
||||||
|
| Name | Value |
|
||||||
|
| --------- | --------- |
|
||||||
|
| `Disable` | 0 |
|
||||||
|
| `Enable` | 1 |
|
||||||
11
docs/models/operations/AllowChannels.md
Normal file
11
docs/models/operations/AllowChannels.md
Normal file
@@ -0,0 +1,11 @@
|
|||||||
|
# AllowChannels
|
||||||
|
|
||||||
|
Indicates if the user has access to channels.
|
||||||
|
|
||||||
|
|
||||||
|
## Values
|
||||||
|
|
||||||
|
| Name | Value |
|
||||||
|
| --------- | --------- |
|
||||||
|
| `Disable` | 0 |
|
||||||
|
| `Enable` | 1 |
|
||||||
11
docs/models/operations/AllowSubtitleAdmin.md
Normal file
11
docs/models/operations/AllowSubtitleAdmin.md
Normal file
@@ -0,0 +1,11 @@
|
|||||||
|
# AllowSubtitleAdmin
|
||||||
|
|
||||||
|
Indicates if the user can manage subtitles.
|
||||||
|
|
||||||
|
|
||||||
|
## Values
|
||||||
|
|
||||||
|
| Name | Value |
|
||||||
|
| --------- | --------- |
|
||||||
|
| `Disable` | 0 |
|
||||||
|
| `Enable` | 1 |
|
||||||
11
docs/models/operations/AllowSync.md
Normal file
11
docs/models/operations/AllowSync.md
Normal file
@@ -0,0 +1,11 @@
|
|||||||
|
# AllowSync
|
||||||
|
|
||||||
|
Indicates if the user is allowed to sync media.
|
||||||
|
|
||||||
|
|
||||||
|
## Values
|
||||||
|
|
||||||
|
| Name | Value |
|
||||||
|
| --------- | --------- |
|
||||||
|
| `Disable` | 0 |
|
||||||
|
| `Enable` | 1 |
|
||||||
11
docs/models/operations/AllowTuners.md
Normal file
11
docs/models/operations/AllowTuners.md
Normal file
@@ -0,0 +1,11 @@
|
|||||||
|
# AllowTuners
|
||||||
|
|
||||||
|
Indicates if the user is allowed to use tuners.
|
||||||
|
|
||||||
|
|
||||||
|
## Values
|
||||||
|
|
||||||
|
| Name | Value |
|
||||||
|
| --------- | --------- |
|
||||||
|
| `Disable` | 0 |
|
||||||
|
| `Enable` | 1 |
|
||||||
11
docs/models/operations/GetActorsLibraryDirectory.md
Normal file
11
docs/models/operations/GetActorsLibraryDirectory.md
Normal file
@@ -0,0 +1,11 @@
|
|||||||
|
# GetActorsLibraryDirectory
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- |
|
||||||
|
| `fastKey` | *String* | :heavy_check_mark: | A fast lookup key for the actor relative url. | /library/sections/2/all?actor=134671 |
|
||||||
|
| `thumb` | *String* | :heavy_check_mark: | URL for the thumbnail image of the actor. | https://metadata-static.plex.tv/e/people/e2a915b537ef720252b6d408bc1f91b3.jpg |
|
||||||
|
| `key` | *String* | :heavy_check_mark: | A unique key representing the actor. | 134671 |
|
||||||
|
| `title` | *String* | :heavy_check_mark: | The name of the actor. | Aaron Paul |
|
||||||
20
docs/models/operations/GetActorsLibraryMediaContainer.md
Normal file
20
docs/models/operations/GetActorsLibraryMediaContainer.md
Normal file
@@ -0,0 +1,20 @@
|
|||||||
|
# GetActorsLibraryMediaContainer
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- |
|
||||||
|
| `size` | *int* | :heavy_check_mark: | Number of media items returned in this response. | 50 |
|
||||||
|
| `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 |
|
||||||
|
| `identifier` | *String* | :heavy_check_mark: | An plugin identifier for the media container. | com.plexapp.plugins.library |
|
||||||
|
| `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 |
|
||||||
|
| `nocache` | *boolean* | :heavy_check_mark: | Specifies whether caching is disabled. | true |
|
||||||
|
| `thumb` | *String* | :heavy_check_mark: | URL for the thumbnail image of the media container. | /:/resources/show.png |
|
||||||
|
| `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 |
|
||||||
|
| `viewMode` | *String* | :heavy_check_mark: | Identifier for the view mode. | 131131 |
|
||||||
|
| `directory` | List\<[GetActorsLibraryDirectory](../../models/operations/GetActorsLibraryDirectory.md)> | :heavy_minus_sign: | An array of actor entries for media items. | |
|
||||||
22
docs/models/operations/GetActorsLibraryQueryParamType.md
Normal file
22
docs/models/operations/GetActorsLibraryQueryParamType.md
Normal file
@@ -0,0 +1,22 @@
|
|||||||
|
# GetActorsLibraryQueryParamType
|
||||||
|
|
||||||
|
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 |
|
||||||
9
docs/models/operations/GetActorsLibraryRequest.md
Normal file
9
docs/models/operations/GetActorsLibraryRequest.md
Normal file
@@ -0,0 +1,9 @@
|
|||||||
|
# GetActorsLibraryRequest
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| 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 |
|
||||||
|
| `type` | [GetActorsLibraryQueryParamType](../../models/operations/GetActorsLibraryQueryParamType.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 |
|
||||||
11
docs/models/operations/GetActorsLibraryResponse.md
Normal file
11
docs/models/operations/GetActorsLibraryResponse.md
Normal file
@@ -0,0 +1,11 @@
|
|||||||
|
# GetActorsLibraryResponse
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ |
|
||||||
|
| `contentType` | *String* | :heavy_check_mark: | HTTP response content type 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 |
|
||||||
|
| `object` | [Optional\<GetActorsLibraryResponseBody>](../../models/operations/GetActorsLibraryResponseBody.md) | :heavy_minus_sign: | Successful response containing media container data. |
|
||||||
10
docs/models/operations/GetActorsLibraryResponseBody.md
Normal file
10
docs/models/operations/GetActorsLibraryResponseBody.md
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
# GetActorsLibraryResponseBody
|
||||||
|
|
||||||
|
Successful response containing media container data.
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ |
|
||||||
|
| `mediaContainer` | [Optional\<GetActorsLibraryMediaContainer>](../../models/operations/GetActorsLibraryMediaContainer.md) | :heavy_minus_sign: | N/A |
|
||||||
12
docs/models/operations/GetAllMediaLibraryActiveDirection.md
Normal file
12
docs/models/operations/GetAllMediaLibraryActiveDirection.md
Normal file
@@ -0,0 +1,12 @@
|
|||||||
|
# GetAllMediaLibraryActiveDirection
|
||||||
|
|
||||||
|
The direction of the sort. Can be either `asc` or `desc`.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
## Values
|
||||||
|
|
||||||
|
| Name | Value |
|
||||||
|
| ------------ | ------------ |
|
||||||
|
| `Ascending` | asc |
|
||||||
|
| `Descending` | desc |
|
||||||
8
docs/models/operations/GetAllMediaLibraryCollection.md
Normal file
8
docs/models/operations/GetAllMediaLibraryCollection.md
Normal file
@@ -0,0 +1,8 @@
|
|||||||
|
# GetAllMediaLibraryCollection
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- |
|
||||||
|
| `tag` | *String* | :heavy_check_mark: | The user-made collection this media item belongs to | My Awesome Collection |
|
||||||
8
docs/models/operations/GetAllMediaLibraryCountry.md
Normal file
8
docs/models/operations/GetAllMediaLibraryCountry.md
Normal file
@@ -0,0 +1,8 @@
|
|||||||
|
# GetAllMediaLibraryCountry
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ---------------------------------------- | ---------------------------------------- | ---------------------------------------- | ---------------------------------------- | ---------------------------------------- |
|
||||||
|
| `tag` | *String* | :heavy_check_mark: | The country of origin of this media item | United States of America |
|
||||||
12
docs/models/operations/GetAllMediaLibraryDefaultDirection.md
Normal file
12
docs/models/operations/GetAllMediaLibraryDefaultDirection.md
Normal file
@@ -0,0 +1,12 @@
|
|||||||
|
# GetAllMediaLibraryDefaultDirection
|
||||||
|
|
||||||
|
The direction of the sort. Can be either `asc` or `desc`.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
## Values
|
||||||
|
|
||||||
|
| Name | Value |
|
||||||
|
| ------------ | ------------ |
|
||||||
|
| `Ascending` | asc |
|
||||||
|
| `Descending` | desc |
|
||||||
8
docs/models/operations/GetAllMediaLibraryDirector.md
Normal file
8
docs/models/operations/GetAllMediaLibraryDirector.md
Normal file
@@ -0,0 +1,8 @@
|
|||||||
|
# GetAllMediaLibraryDirector
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| -------------------- | -------------------- | -------------------- | -------------------- | -------------------- |
|
||||||
|
| `tag` | *String* | :heavy_check_mark: | The role of Director | Danny Boyle |
|
||||||
11
docs/models/operations/GetAllMediaLibraryField.md
Normal file
11
docs/models/operations/GetAllMediaLibraryField.md
Normal file
@@ -0,0 +1,11 @@
|
|||||||
|
# GetAllMediaLibraryField
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ------------------- | ------------------- | ------------------- | ------------------- | ------------------- |
|
||||||
|
| `key` | *String* | :heavy_check_mark: | N/A | show.title |
|
||||||
|
| `title` | *String* | :heavy_check_mark: | N/A | Show Title |
|
||||||
|
| `type` | *String* | :heavy_check_mark: | N/A | string |
|
||||||
|
| `subType` | *Optional\<String>* | :heavy_minus_sign: | N/A | rating |
|
||||||
9
docs/models/operations/GetAllMediaLibraryFieldType.md
Normal file
9
docs/models/operations/GetAllMediaLibraryFieldType.md
Normal file
@@ -0,0 +1,9 @@
|
|||||||
|
# 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 | |
|
||||||
13
docs/models/operations/GetAllMediaLibraryFilter.md
Normal file
13
docs/models/operations/GetAllMediaLibraryFilter.md
Normal file
@@ -0,0 +1,13 @@
|
|||||||
|
# GetAllMediaLibraryFilter
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| -------------------------------- | -------------------------------- | -------------------------------- | -------------------------------- | -------------------------------- |
|
||||||
|
| `filter` | *String* | :heavy_check_mark: | N/A | genre |
|
||||||
|
| `filterType` | *String* | :heavy_check_mark: | N/A | string |
|
||||||
|
| `key` | *String* | :heavy_check_mark: | N/A | /library/sections/2/genre?type=2 |
|
||||||
|
| `title` | *String* | :heavy_check_mark: | N/A | Genre |
|
||||||
|
| `type` | *String* | :heavy_check_mark: | N/A | filter |
|
||||||
|
| `advanced` | *Optional\<Boolean>* | :heavy_minus_sign: | N/A | true |
|
||||||
8
docs/models/operations/GetAllMediaLibraryGenre.md
Normal file
8
docs/models/operations/GetAllMediaLibraryGenre.md
Normal file
@@ -0,0 +1,8 @@
|
|||||||
|
# GetAllMediaLibraryGenre
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ---------------------------------------- | ---------------------------------------- | ---------------------------------------- | ---------------------------------------- | ---------------------------------------- |
|
||||||
|
| `tag` | *String* | :heavy_check_mark: | The country of origin of this media item | United States of America |
|
||||||
11
docs/models/operations/GetAllMediaLibraryHasThumbnail.md
Normal file
11
docs/models/operations/GetAllMediaLibraryHasThumbnail.md
Normal file
@@ -0,0 +1,11 @@
|
|||||||
|
# GetAllMediaLibraryHasThumbnail
|
||||||
|
|
||||||
|
Indicates if the part has a thumbnail.
|
||||||
|
|
||||||
|
|
||||||
|
## Values
|
||||||
|
|
||||||
|
| Name | Value |
|
||||||
|
| ------- | ------- |
|
||||||
|
| `False` | 0 |
|
||||||
|
| `True` | 1 |
|
||||||
10
docs/models/operations/GetAllMediaLibraryImage.md
Normal file
10
docs/models/operations/GetAllMediaLibraryImage.md
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
# 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 |
|
||||||
@@ -0,0 +1,4 @@
|
|||||||
|
# GetAllMediaLibraryLibraryOptimizedForStreaming
|
||||||
|
|
||||||
|
Has this media been optimized for streaming. NOTE: This can be 0, 1, false or true
|
||||||
|
|
||||||
@@ -0,0 +1,11 @@
|
|||||||
|
# GetAllMediaLibraryLibraryResponseType
|
||||||
|
|
||||||
|
|
||||||
|
## Values
|
||||||
|
|
||||||
|
| Name | Value |
|
||||||
|
| -------------- | -------------- |
|
||||||
|
| `COVER_POSTER` | coverPoster |
|
||||||
|
| `BACKGROUND` | background |
|
||||||
|
| `SNAPSHOT` | snapshot |
|
||||||
|
| `CLEAR_LOGO` | clearLogo |
|
||||||
16
docs/models/operations/GetAllMediaLibraryLibraryType.md
Normal file
16
docs/models/operations/GetAllMediaLibraryLibraryType.md
Normal file
@@ -0,0 +1,16 @@
|
|||||||
|
# GetAllMediaLibraryLibraryType
|
||||||
|
|
||||||
|
The type of media content
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
## Values
|
||||||
|
|
||||||
|
| Name | Value |
|
||||||
|
| --------- | --------- |
|
||||||
|
| `Movie` | movie |
|
||||||
|
| `TvShow` | show |
|
||||||
|
| `Season` | season |
|
||||||
|
| `Episode` | episode |
|
||||||
|
| `Artist` | artist |
|
||||||
|
| `Album` | album |
|
||||||
26
docs/models/operations/GetAllMediaLibraryMedia.md
Normal file
26
docs/models/operations/GetAllMediaLibraryMedia.md
Normal file
@@ -0,0 +1,26 @@
|
|||||||
|
# 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` | *boolean* | :heavy_check_mark: | 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_check_mark: | An array of parts for this media item. | |
|
||||||
26
docs/models/operations/GetAllMediaLibraryMediaContainer.md
Normal file
26
docs/models/operations/GetAllMediaLibraryMediaContainer.md
Normal file
@@ -0,0 +1,26 @@
|
|||||||
|
# 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. | |
|
||||||
12
docs/models/operations/GetAllMediaLibraryMeta.md
Normal file
12
docs/models/operations/GetAllMediaLibraryMeta.md
Normal file
@@ -0,0 +1,12 @@
|
|||||||
|
# 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 |
|
||||||
74
docs/models/operations/GetAllMediaLibraryMetadata.md
Normal file
74
docs/models/operations/GetAllMediaLibraryMetadata.md
Normal file
@@ -0,0 +1,74 @@
|
|||||||
|
# GetAllMediaLibraryMetadata
|
||||||
|
|
||||||
|
Unknown
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||||
|
| `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 |
|
||||||
|
| `key` | *String* | :heavy_check_mark: | The unique key for the media item. | /library/metadata/58683 |
|
||||||
|
| `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 |
|
||||||
|
| `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 |
|
||||||
|
| `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 |
|
||||||
|
| `contentRating` | *Optional\<String>* | :heavy_minus_sign: | The content rating for the media item. | PG-13 |
|
||||||
|
| `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/> |
|
||||||
|
| `rating` | *float* | :heavy_check_mark: | The critic rating for the media item. | 7.6 |
|
||||||
|
| `audienceRating` | *double* | :heavy_check_mark: | The audience rating for the media item. | 9.2 |
|
||||||
|
| `year` | *int* | :heavy_check_mark: | The release year of the media item. | 2022 |
|
||||||
|
| `tagline` | *String* | :heavy_check_mark: | A brief tagline for the media item. | Return to Pandora. |
|
||||||
|
| `thumb` | *String* | :heavy_check_mark: | The thumbnail image URL for the media item. | /library/metadata/58683/thumb/1703239236 |
|
||||||
|
| `art` | *String* | :heavy_check_mark: | The art image URL for the media item. | /library/metadata/58683/art/1703239236 |
|
||||||
|
| `theme` | *String* | :heavy_check_mark: | The theme URL for the media item. | /library/metadata/1/theme/1705636920 |
|
||||||
|
| `index` | *int* | :heavy_check_mark: | The index position of the media item. | 1 |
|
||||||
|
| `leafCount` | *Optional\<Integer>* | :heavy_minus_sign: | The number of leaf items (end nodes) under this media item. | 14 |
|
||||||
|
| `viewedLeafCount` | *Optional\<Integer>* | :heavy_minus_sign: | The number of leaf items that have been viewed. | 0 |
|
||||||
|
| `childCount` | *int* | :heavy_check_mark: | The number of child items associated with this media item. | 1 |
|
||||||
|
| `seasonCount` | *int* | :heavy_check_mark: | The total number of seasons (for TV shows). | 2022 |
|
||||||
|
| `duration` | *int* | :heavy_check_mark: | The duration of the media item in milliseconds. | 11558112 |
|
||||||
|
| `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 |
|
||||||
|
| `addedAt` | *long* | :heavy_check_mark: | N/A | 1556281940 |
|
||||||
|
| `updatedAt` | *Optional\<Long>* | :heavy_minus_sign: | Unix epoch datetime in seconds | 1556281940 |
|
||||||
|
| `audienceRatingImage` | *Optional\<String>* | :heavy_minus_sign: | The URL for the audience rating image. | rottentomatoes://image.rating.upright |
|
||||||
|
| `chapterSource` | *Optional\<String>* | :heavy_minus_sign: | The source from which chapter data is derived. | media |
|
||||||
|
| `primaryExtraKey` | *Optional\<String>* | :heavy_minus_sign: | The primary extra key associated with this media item. | /library/metadata/58684 |
|
||||||
|
| `originalTitle` | *Optional\<String>* | :heavy_minus_sign: | The original title of the media item (if different). | 映画 ブラッククローバー 魔法帝の剣 |
|
||||||
|
| `parentRatingKey` | *Optional\<String>* | :heavy_minus_sign: | The rating key of the parent media item. | 66 |
|
||||||
|
| `grandparentRatingKey` | *Optional\<String>* | :heavy_minus_sign: | The rating key of the grandparent media item. | 66 |
|
||||||
|
| `parentGuid` | *Optional\<String>* | :heavy_minus_sign: | The GUID of the parent media item. | plex://show/5d9c081b170e24001f2a7be4 |
|
||||||
|
| `grandparentGuid` | *Optional\<String>* | :heavy_minus_sign: | The GUID of the grandparent media item. | plex://show/5d9c081b170e24001f2a7be4 |
|
||||||
|
| `grandparentSlug` | *Optional\<String>* | :heavy_minus_sign: | The slug for the grandparent media item. | alice-in-borderland-2020 |
|
||||||
|
| `grandparentKey` | *Optional\<String>* | :heavy_minus_sign: | The key of the grandparent media item. | /library/metadata/66 |
|
||||||
|
| `parentKey` | *Optional\<String>* | :heavy_minus_sign: | The key of the parent media item. | /library/metadata/66 |
|
||||||
|
| `grandparentTitle` | *Optional\<String>* | :heavy_minus_sign: | The title of the grandparent media item. | Caprica |
|
||||||
|
| `grandparentThumb` | *Optional\<String>* | :heavy_minus_sign: | The thumbnail URL for the grandparent media item. | /library/metadata/66/thumb/1705716261 |
|
||||||
|
| `grandparentTheme` | *Optional\<String>* | :heavy_minus_sign: | The theme URL for the grandparent media item. | /library/metadata/66/theme/1705716261 |
|
||||||
|
| `grandparentArt` | *Optional\<String>* | :heavy_minus_sign: | The art URL for the grandparent media item. | /library/metadata/66/art/1705716261 |
|
||||||
|
| `parentTitle` | *Optional\<String>* | :heavy_minus_sign: | The title of the parent media item. | Caprica |
|
||||||
|
| `parentIndex` | *Optional\<Integer>* | :heavy_minus_sign: | The index position of the parent media item. | 1 |
|
||||||
|
| `parentThumb` | *Optional\<String>* | :heavy_minus_sign: | The thumbnail URL for the parent media item. | /library/metadata/66/thumb/1705716261 |
|
||||||
|
| `ratingImage` | *Optional\<String>* | :heavy_minus_sign: | The URL for the rating image. | rottentomatoes://image.rating.ripe |
|
||||||
|
| `viewCount` | *Optional\<Integer>* | :heavy_minus_sign: | The number of times this media item has been viewed. | 1 |
|
||||||
|
| `viewOffset` | *Optional\<Integer>* | :heavy_minus_sign: | The current playback offset (in milliseconds). | 5222500 |
|
||||||
|
| `skipCount` | *Optional\<Integer>* | :heavy_minus_sign: | The number of times this media item has been skipped. | 1 |
|
||||||
|
| `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 |
|
||||||
|
| `lastRatedAt` | *Optional\<Long>* | :heavy_minus_sign: | The Unix timestamp representing the last time the item was rated. | 1721813113 |
|
||||||
|
| `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 |
|
||||||
|
| `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 |
|
||||||
|
| `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 | |
|
||||||
|
| `ultraBlurColors` | [Optional\<GetAllMediaLibraryUltraBlurColors>](../../models/operations/GetAllMediaLibraryUltraBlurColors.md) | :heavy_minus_sign: | N/A | |
|
||||||
|
| `media` | List\<[GetAllMediaLibraryMedia](../../models/operations/GetAllMediaLibraryMedia.md)> | :heavy_minus_sign: | N/A | |
|
||||||
|
| `genre` | List\<[GetAllMediaLibraryGenre](../../models/operations/GetAllMediaLibraryGenre.md)> | :heavy_minus_sign: | N/A | |
|
||||||
|
| `country` | List\<[GetAllMediaLibraryCountry](../../models/operations/GetAllMediaLibraryCountry.md)> | :heavy_minus_sign: | N/A | |
|
||||||
|
| `director` | List\<[GetAllMediaLibraryDirector](../../models/operations/GetAllMediaLibraryDirector.md)> | :heavy_minus_sign: | N/A | |
|
||||||
|
| `writer` | List\<[GetAllMediaLibraryWriter](../../models/operations/GetAllMediaLibraryWriter.md)> | :heavy_minus_sign: | N/A | |
|
||||||
|
| `role` | List\<[GetAllMediaLibraryRole](../../models/operations/GetAllMediaLibraryRole.md)> | :heavy_minus_sign: | N/A | |
|
||||||
|
| `guids` | List\<[Guids](../../models/operations/Guids.md)> | :heavy_minus_sign: | N/A | |
|
||||||
|
| `collection` | List\<[GetAllMediaLibraryCollection](../../models/operations/GetAllMediaLibraryCollection.md)> | :heavy_minus_sign: | N/A | |
|
||||||
9
docs/models/operations/GetAllMediaLibraryOperator.md
Normal file
9
docs/models/operations/GetAllMediaLibraryOperator.md
Normal file
@@ -0,0 +1,9 @@
|
|||||||
|
# GetAllMediaLibraryOperator
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
|
||||||
|
| `key` | *String* | :heavy_check_mark: | N/A | = |
|
||||||
|
| `title` | *String* | :heavy_check_mark: | N/A | is |
|
||||||
@@ -0,0 +1,4 @@
|
|||||||
|
# GetAllMediaLibraryOptimizedForStreaming
|
||||||
|
|
||||||
|
Has this media been optimized for streaming. NOTE: This can be 0, 1, false or true
|
||||||
|
|
||||||
@@ -0,0 +1,9 @@
|
|||||||
|
# GetAllMediaLibraryOptimizedForStreaming1
|
||||||
|
|
||||||
|
|
||||||
|
## Values
|
||||||
|
|
||||||
|
| Name | Value |
|
||||||
|
| ------ | ------ |
|
||||||
|
| `ZERO` | 0 |
|
||||||
|
| `ONE` | 1 |
|
||||||
23
docs/models/operations/GetAllMediaLibraryPart.md
Normal file
23
docs/models/operations/GetAllMediaLibraryPart.md
Normal file
@@ -0,0 +1,23 @@
|
|||||||
|
# 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. | |
|
||||||
@@ -0,0 +1,12 @@
|
|||||||
|
# GetAllMediaLibraryQueryParamIncludeMeta
|
||||||
|
|
||||||
|
Adds the Meta object to the response
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
## Values
|
||||||
|
|
||||||
|
| Name | Value |
|
||||||
|
| --------- | --------- |
|
||||||
|
| `Disable` | 0 |
|
||||||
|
| `Enable` | 1 |
|
||||||
22
docs/models/operations/GetAllMediaLibraryQueryParamType.md
Normal file
22
docs/models/operations/GetAllMediaLibraryQueryParamType.md
Normal file
@@ -0,0 +1,22 @@
|
|||||||
|
# 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 |
|
||||||
16
docs/models/operations/GetAllMediaLibraryRequest.md
Normal file
16
docs/models/operations/GetAllMediaLibraryRequest.md
Normal file
@@ -0,0 +1,16 @@
|
|||||||
|
# GetAllMediaLibraryRequest
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| 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 |
|
||||||
|
| `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 |
|
||||||
|
| `includeMeta` | [Optional\<GetAllMediaLibraryQueryParamIncludeMeta>](../../models/operations/GetAllMediaLibraryQueryParamIncludeMeta.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 |
|
||||||
|
| `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 |
|
||||||
|
| `includeExternalMedia` | [Optional\<QueryParamIncludeExternalMedia>](../../models/operations/QueryParamIncludeExternalMedia.md) | :heavy_minus_sign: | N/A | 1 |
|
||||||
|
| `xPlexContainerStart` | *Optional\<Integer>* | :heavy_minus_sign: | The index of the first item to return. If not specified, the first item will be returned.<br/>If the number of items exceeds the limit, the response will be paginated.<br/>By default this is 0<br/> | 0 |
|
||||||
|
| `xPlexContainerSize` | *Optional\<Integer>* | :heavy_minus_sign: | The number of items to return. If not specified, all items will be returned.<br/>If the number of items exceeds the limit, the response will be paginated.<br/>By default this is 50<br/> | 50 |
|
||||||
11
docs/models/operations/GetAllMediaLibraryResponse.md
Normal file
11
docs/models/operations/GetAllMediaLibraryResponse.md
Normal file
@@ -0,0 +1,11 @@
|
|||||||
|
# GetAllMediaLibraryResponse
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ |
|
||||||
|
| `contentType` | *String* | :heavy_check_mark: | HTTP response content type 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 |
|
||||||
|
| `object` | [Optional\<GetAllMediaLibraryResponseBody>](../../models/operations/GetAllMediaLibraryResponseBody.md) | :heavy_minus_sign: | Successful response containing media container data. |
|
||||||
10
docs/models/operations/GetAllMediaLibraryResponseBody.md
Normal file
10
docs/models/operations/GetAllMediaLibraryResponseBody.md
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
# GetAllMediaLibraryResponseBody
|
||||||
|
|
||||||
|
Successful response containing media container data.
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- |
|
||||||
|
| `mediaContainer` | [Optional\<GetAllMediaLibraryMediaContainer>](../../models/operations/GetAllMediaLibraryMediaContainer.md) | :heavy_minus_sign: | N/A |
|
||||||
8
docs/models/operations/GetAllMediaLibraryRole.md
Normal file
8
docs/models/operations/GetAllMediaLibraryRole.md
Normal file
@@ -0,0 +1,8 @@
|
|||||||
|
# GetAllMediaLibraryRole
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- |
|
||||||
|
| `tag` | *String* | :heavy_check_mark: | The name of the actor for this role | Danny Boyle |
|
||||||
15
docs/models/operations/GetAllMediaLibrarySort.md
Normal file
15
docs/models/operations/GetAllMediaLibrarySort.md
Normal file
@@ -0,0 +1,15 @@
|
|||||||
|
# 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 |
|
||||||
54
docs/models/operations/GetAllMediaLibraryStream.md
Normal file
54
docs/models/operations/GetAllMediaLibraryStream.md
Normal file
@@ -0,0 +1,54 @@
|
|||||||
|
# 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` | *String* | :heavy_check_mark: | Language of the stream. | English |
|
||||||
|
| `languageTag` | *String* | :heavy_check_mark: | Language tag (e.g., en). | en |
|
||||||
|
| `languageCode` | *String* | :heavy_check_mark: | 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 |
|
||||||
|
| `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 |
|
||||||
|
| `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 |
|
||||||
15
docs/models/operations/GetAllMediaLibraryType.md
Normal file
15
docs/models/operations/GetAllMediaLibraryType.md
Normal file
@@ -0,0 +1,15 @@
|
|||||||
|
# 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
docs/models/operations/GetAllMediaLibraryUltraBlurColors.md
Normal file
11
docs/models/operations/GetAllMediaLibraryUltraBlurColors.md
Normal file
@@ -0,0 +1,11 @@
|
|||||||
|
# GetAllMediaLibraryUltraBlurColors
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
|
||||||
|
| `topLeft` | *String* | :heavy_check_mark: | N/A | 11333b |
|
||||||
|
| `topRight` | *String* | :heavy_check_mark: | N/A | 0a232d |
|
||||||
|
| `bottomRight` | *String* | :heavy_check_mark: | N/A | 73958 |
|
||||||
|
| `bottomLeft` | *String* | :heavy_check_mark: | N/A | 1f5066 |
|
||||||
8
docs/models/operations/GetAllMediaLibraryWriter.md
Normal file
8
docs/models/operations/GetAllMediaLibraryWriter.md
Normal file
@@ -0,0 +1,8 @@
|
|||||||
|
# GetAllMediaLibraryWriter
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
|
||||||
|
| `tag` | *String* | :heavy_check_mark: | The role of Writer | Danny Boyle |
|
||||||
@@ -5,18 +5,16 @@
|
|||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
| Field | Type | Required | Description | Example |
|
||||||
| ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- |
|
| ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- |
|
||||||
| `size` | *double* | :heavy_check_mark: | N/A | 50 |
|
| `size` | *int* | :heavy_check_mark: | Number of media items returned in this response. | 50 |
|
||||||
| `offset` | *Optional\<Integer>* | :heavy_minus_sign: | N/A | |
|
| `allowSync` | *boolean* | :heavy_check_mark: | Indicates whether syncing is allowed. | false |
|
||||||
| `totalSize` | *Optional\<Integer>* | :heavy_minus_sign: | N/A | |
|
| `art` | *String* | :heavy_check_mark: | URL for the background artwork of the media container. | /:/resources/show-fanart.jpg |
|
||||||
| `identifier` | *String* | :heavy_check_mark: | N/A | com.plexapp.plugins.library |
|
| `content` | *String* | :heavy_check_mark: | The content type or mode. | secondary |
|
||||||
| `allowSync` | *boolean* | :heavy_check_mark: | N/A | false |
|
| `identifier` | *String* | :heavy_check_mark: | An plugin identifier for the media container. | com.plexapp.plugins.library |
|
||||||
| `art` | *String* | :heavy_check_mark: | N/A | /:/resources/show-fanart.jpg |
|
| `mediaTagPrefix` | *String* | :heavy_check_mark: | The prefix used for media tag resource paths. | /system/bundle/media/flags/ |
|
||||||
| `content` | *String* | :heavy_check_mark: | N/A | secondary |
|
| `mediaTagVersion` | *long* | :heavy_check_mark: | The version number for media tags. | 1734362201 |
|
||||||
| `mediaTagPrefix` | *String* | :heavy_check_mark: | N/A | /system/bundle/media/flags/ |
|
| `nocache` | *boolean* | :heavy_check_mark: | Specifies whether caching is disabled. | true |
|
||||||
| `mediaTagVersion` | *long* | :heavy_check_mark: | N/A | 1734362201 |
|
| `thumb` | *String* | :heavy_check_mark: | URL for the thumbnail image of the media container. | /:/resources/show.png |
|
||||||
| `nocache` | *boolean* | :heavy_check_mark: | N/A | true |
|
| `title1` | *String* | :heavy_check_mark: | The primary title of the media container. | TV Series |
|
||||||
| `thumb` | *String* | :heavy_check_mark: | N/A | /:/resources/show.png |
|
| `title2` | *String* | :heavy_check_mark: | The secondary title of the media container. | By Starring Actor |
|
||||||
| `title1` | *String* | :heavy_check_mark: | N/A | TV Series |
|
| `viewGroup` | *String* | :heavy_check_mark: | Identifier for the view group layout. | secondary |
|
||||||
| `title2` | *String* | :heavy_check_mark: | N/A | By Country |
|
|
||||||
| `viewGroup` | *String* | :heavy_check_mark: | N/A | secondary |
|
|
||||||
| `directory` | List\<[GetCountriesLibraryDirectory](../../models/operations/GetCountriesLibraryDirectory.md)> | :heavy_minus_sign: | N/A | |
|
| `directory` | List\<[GetCountriesLibraryDirectory](../../models/operations/GetCountriesLibraryDirectory.md)> | :heavy_minus_sign: | N/A | |
|
||||||
22
docs/models/operations/GetCountriesLibraryQueryParamType.md
Normal file
22
docs/models/operations/GetCountriesLibraryQueryParamType.md
Normal file
@@ -0,0 +1,22 @@
|
|||||||
|
# GetCountriesLibraryQueryParamType
|
||||||
|
|
||||||
|
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 |
|
||||||
@@ -3,6 +3,7 @@
|
|||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
|
|
||||||
| 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` | [GetCountriesLibraryQueryParamType](../../models/operations/GetCountriesLibraryQueryParamType.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 |
|
||||||
@@ -5,18 +5,16 @@
|
|||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
| Field | Type | Required | Description | Example |
|
||||||
| ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- |
|
| ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- |
|
||||||
| `size` | *double* | :heavy_check_mark: | N/A | 50 |
|
| `size` | *int* | :heavy_check_mark: | Number of media items returned in this response. | 50 |
|
||||||
| `offset` | *Optional\<Integer>* | :heavy_minus_sign: | N/A | |
|
| `allowSync` | *boolean* | :heavy_check_mark: | Indicates whether syncing is allowed. | false |
|
||||||
| `totalSize` | *Optional\<Integer>* | :heavy_minus_sign: | N/A | |
|
| `art` | *String* | :heavy_check_mark: | URL for the background artwork of the media container. | /:/resources/show-fanart.jpg |
|
||||||
| `identifier` | *String* | :heavy_check_mark: | N/A | com.plexapp.plugins.library |
|
| `content` | *String* | :heavy_check_mark: | The content type or mode. | secondary |
|
||||||
| `allowSync` | *boolean* | :heavy_check_mark: | N/A | false |
|
| `identifier` | *String* | :heavy_check_mark: | An plugin identifier for the media container. | com.plexapp.plugins.library |
|
||||||
| `art` | *String* | :heavy_check_mark: | N/A | /:/resources/show-fanart.jpg |
|
| `mediaTagPrefix` | *String* | :heavy_check_mark: | The prefix used for media tag resource paths. | /system/bundle/media/flags/ |
|
||||||
| `content` | *String* | :heavy_check_mark: | N/A | secondary |
|
| `mediaTagVersion` | *long* | :heavy_check_mark: | The version number for media tags. | 1734362201 |
|
||||||
| `mediaTagPrefix` | *String* | :heavy_check_mark: | N/A | /system/bundle/media/flags/ |
|
| `nocache` | *boolean* | :heavy_check_mark: | Specifies whether caching is disabled. | true |
|
||||||
| `mediaTagVersion` | *long* | :heavy_check_mark: | N/A | 1734362201 |
|
| `thumb` | *String* | :heavy_check_mark: | URL for the thumbnail image of the media container. | /:/resources/show.png |
|
||||||
| `nocache` | *boolean* | :heavy_check_mark: | N/A | true |
|
| `title1` | *String* | :heavy_check_mark: | The primary title of the media container. | TV Series |
|
||||||
| `thumb` | *String* | :heavy_check_mark: | N/A | /:/resources/show.png |
|
| `title2` | *String* | :heavy_check_mark: | The secondary title of the media container. | By Starring Actor |
|
||||||
| `title1` | *String* | :heavy_check_mark: | N/A | TV Shows (Reality) |
|
| `viewGroup` | *String* | :heavy_check_mark: | Identifier for the view group layout. | secondary |
|
||||||
| `title2` | *String* | :heavy_check_mark: | N/A | By Genre |
|
|
||||||
| `viewGroup` | *String* | :heavy_check_mark: | N/A | secondary |
|
|
||||||
| `directory` | List\<[GetGenresLibraryDirectory](../../models/operations/GetGenresLibraryDirectory.md)> | :heavy_minus_sign: | N/A | |
|
| `directory` | List\<[GetGenresLibraryDirectory](../../models/operations/GetGenresLibraryDirectory.md)> | :heavy_minus_sign: | N/A | |
|
||||||
22
docs/models/operations/GetGenresLibraryQueryParamType.md
Normal file
22
docs/models/operations/GetGenresLibraryQueryParamType.md
Normal file
@@ -0,0 +1,22 @@
|
|||||||
|
# GetGenresLibraryQueryParamType
|
||||||
|
|
||||||
|
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 |
|
||||||
@@ -3,6 +3,7 @@
|
|||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
|
|
||||||
| 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` | [GetGenresLibraryQueryParamType](../../models/operations/GetGenresLibraryQueryParamType.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 |
|
||||||
@@ -9,4 +9,5 @@
|
|||||||
| `filterType` | *String* | :heavy_check_mark: | N/A | string |
|
| `filterType` | *String* | :heavy_check_mark: | N/A | string |
|
||||||
| `key` | *String* | :heavy_check_mark: | N/A | /library/sections/2/genre?type=2 |
|
| `key` | *String* | :heavy_check_mark: | N/A | /library/sections/2/genre?type=2 |
|
||||||
| `title` | *String* | :heavy_check_mark: | N/A | Genre |
|
| `title` | *String* | :heavy_check_mark: | N/A | Genre |
|
||||||
| `type` | *String* | :heavy_check_mark: | N/A | filter |
|
| `type` | *String* | :heavy_check_mark: | N/A | filter |
|
||||||
|
| `advanced` | *Optional\<Boolean>* | :heavy_minus_sign: | N/A | true |
|
||||||
@@ -11,4 +11,6 @@ The type of media content
|
|||||||
| `Movie` | movie |
|
| `Movie` | movie |
|
||||||
| `TvShow` | show |
|
| `TvShow` | show |
|
||||||
| `Season` | season |
|
| `Season` | season |
|
||||||
| `Episode` | episode |
|
| `Episode` | episode |
|
||||||
|
| `Artist` | artist |
|
||||||
|
| `Album` | album |
|
||||||
@@ -1,6 +1,6 @@
|
|||||||
# GetLibraryItemsQueryParamType
|
# GetLibraryItemsQueryParamType
|
||||||
|
|
||||||
The type of media to retrieve.
|
The type of media to retrieve or filter by.
|
||||||
1 = movie
|
1 = movie
|
||||||
2 = show
|
2 = show
|
||||||
3 = season
|
3 = season
|
||||||
|
|||||||
@@ -3,12 +3,12 @@
|
|||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
| Field | Type | Required | Description | Example |
|
||||||
| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||||
| `tag` | [Tag](../../models/operations/Tag.md) | :heavy_check_mark: | A key representing a specific tag within the section. | |
|
| `tag` | [Tag](../../models/operations/Tag.md) | :heavy_check_mark: | A key representing a specific tag within the section. | |
|
||||||
| `includeGuids` | [Optional\<IncludeGuids>](../../models/operations/IncludeGuids.md) | :heavy_minus_sign: | Adds the Guids object to the response<br/> | 1 |
|
| `includeGuids` | [Optional\<IncludeGuids>](../../models/operations/IncludeGuids.md) | :heavy_minus_sign: | Adds the Guids object to the response<br/> | 1 |
|
||||||
| `type` | [Optional\<GetLibraryItemsQueryParamType>](../../models/operations/GetLibraryItemsQueryParamType.md) | :heavy_minus_sign: | The type of media to retrieve.<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` | [GetLibraryItemsQueryParamType](../../models/operations/GetLibraryItemsQueryParamType.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 |
|
||||||
| `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 |
|
||||||
| `includeMeta` | [Optional\<GetLibraryItemsQueryParamIncludeMeta>](../../models/operations/GetLibraryItemsQueryParamIncludeMeta.md) | :heavy_minus_sign: | Adds the Meta object to the response<br/> | 1 |
|
| `includeMeta` | [Optional\<GetLibraryItemsQueryParamIncludeMeta>](../../models/operations/GetLibraryItemsQueryParamIncludeMeta.md) | :heavy_minus_sign: | Adds the Meta object to the response<br/> | 1 |
|
||||||
| `xPlexContainerStart` | *Optional\<Integer>* | :heavy_minus_sign: | The index of the first item to return. If not specified, the first item will be returned.<br/>If the number of items exceeds the limit, the response will be paginated.<br/>By default this is 0<br/> | 0 |
|
| `xPlexContainerStart` | *Optional\<Integer>* | :heavy_minus_sign: | The index of the first item to return. If not specified, the first item will be returned.<br/>If the number of items exceeds the limit, the response will be paginated.<br/>By default this is 0<br/> | 0 |
|
||||||
| `xPlexContainerSize` | *Optional\<Integer>* | :heavy_minus_sign: | The number of items to return. If not specified, all items will be returned.<br/>If the number of items exceeds the limit, the response will be paginated.<br/>By default this is 50<br/> | 50 |
|
| `xPlexContainerSize` | *Optional\<Integer>* | :heavy_minus_sign: | The number of items to return. If not specified, all items will be returned.<br/>If the number of items exceeds the limit, the response will be paginated.<br/>By default this is 50<br/> | 50 |
|
||||||
@@ -6,7 +6,8 @@
|
|||||||
| Field | Type | Required | Description | Example |
|
| Field | Type | Required | Description | Example |
|
||||||
| -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- |
|
| -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- |
|
||||||
| `key` | *String* | :heavy_check_mark: | N/A | /library/sections/2/all?type=2 |
|
| `key` | *String* | :heavy_check_mark: | N/A | /library/sections/2/all?type=2 |
|
||||||
| `type` | *String* | :heavy_check_mark: | N/A | show |
|
| `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 |
|
| `title` | *String* | :heavy_check_mark: | N/A | TV Shows |
|
||||||
| `active` | *boolean* | :heavy_check_mark: | N/A | false |
|
| `active` | *boolean* | :heavy_check_mark: | N/A | false |
|
||||||
| `filter` | List\<[GetLibraryItemsFilter](../../models/operations/GetLibraryItemsFilter.md)> | :heavy_minus_sign: | N/A | |
|
| `filter` | List\<[GetLibraryItemsFilter](../../models/operations/GetLibraryItemsFilter.md)> | :heavy_minus_sign: | N/A | |
|
||||||
|
|||||||
10
docs/models/operations/GetMediaMetaDataCountry.md
Normal file
10
docs/models/operations/GetMediaMetaDataCountry.md
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
# GetMediaMetaDataCountry
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ---------------------------------- | ---------------------------------- | ---------------------------------- | ---------------------------------- | ---------------------------------- |
|
||||||
|
| `id` | *int* | :heavy_check_mark: | The unique country identifier. | 58591 |
|
||||||
|
| `filter` | *String* | :heavy_check_mark: | The filter string for the country. | country=58591 |
|
||||||
|
| `tag` | *String* | :heavy_check_mark: | The country name. | United States of America |
|
||||||
13
docs/models/operations/GetMediaMetaDataDirector.md
Normal file
13
docs/models/operations/GetMediaMetaDataDirector.md
Normal file
@@ -0,0 +1,13 @@
|
|||||||
|
# GetMediaMetaDataDirector
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- |
|
||||||
|
| `id` | *long* | :heavy_check_mark: | The unique role identifier. | 109501 |
|
||||||
|
| `filter` | *String* | :heavy_check_mark: | The filter string for the role. | actor=109501 |
|
||||||
|
| `tag` | *String* | :heavy_check_mark: | The actor's name. | Bob Odenkirk |
|
||||||
|
| `tagKey` | *String* | :heavy_check_mark: | A key associated with the actor tag. | 5d77683254f42c001f8c3f69 |
|
||||||
|
| `role` | *Optional\<String>* | :heavy_minus_sign: | The character name or role. | Jimmy McGill |
|
||||||
|
| `thumb` | *Optional\<String>* | :heavy_minus_sign: | URL for the role thumbnail image. | https://metadata-static.plex.tv/f/people/f2ca7b474cc984efbdd5c503a096285a.jpg |
|
||||||
10
docs/models/operations/GetMediaMetaDataGenre.md
Normal file
10
docs/models/operations/GetMediaMetaDataGenre.md
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
# GetMediaMetaDataGenre
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| -------------------------------- | -------------------------------- | -------------------------------- | -------------------------------- | -------------------------------- |
|
||||||
|
| `id` | *long* | :heavy_check_mark: | The unique genre identifier. | 1057 |
|
||||||
|
| `filter` | *String* | :heavy_check_mark: | The filter string for the genre. | genre=1057 |
|
||||||
|
| `tag` | *String* | :heavy_check_mark: | The genre name. | Crime |
|
||||||
8
docs/models/operations/GetMediaMetaDataGuids.md
Normal file
8
docs/models/operations/GetMediaMetaDataGuids.md
Normal file
@@ -0,0 +1,8 @@
|
|||||||
|
# GetMediaMetaDataGuids
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
|
||||||
|
| `id` | *String* | :heavy_check_mark: | The GUID value. | imdb://tt3032476 |
|
||||||
11
docs/models/operations/GetMediaMetaDataHasThumbnail.md
Normal file
11
docs/models/operations/GetMediaMetaDataHasThumbnail.md
Normal file
@@ -0,0 +1,11 @@
|
|||||||
|
# GetMediaMetaDataHasThumbnail
|
||||||
|
|
||||||
|
Indicates if the part has a thumbnail.
|
||||||
|
|
||||||
|
|
||||||
|
## Values
|
||||||
|
|
||||||
|
| Name | Value |
|
||||||
|
| ------- | ------- |
|
||||||
|
| `False` | 0 |
|
||||||
|
| `True` | 1 |
|
||||||
10
docs/models/operations/GetMediaMetaDataImage.md
Normal file
10
docs/models/operations/GetMediaMetaDataImage.md
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
# GetMediaMetaDataImage
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ------------------------------------------------------------- | ------------------------------------------------------------- | ------------------------------------------------------------- | ------------------------------------------------------------- | ------------------------------------------------------------- |
|
||||||
|
| `alt` | *String* | :heavy_check_mark: | Alternate text for the image. | Better Call Saul |
|
||||||
|
| `type` | *String* | :heavy_check_mark: | The type of image (e.g., coverPoster, background, clearLogo). | coverPoster |
|
||||||
|
| `url` | *String* | :heavy_check_mark: | The URL of the image. | /library/metadata/44288/thumb/1736487993 |
|
||||||
@@ -0,0 +1,4 @@
|
|||||||
|
# GetMediaMetaDataLibraryOptimizedForStreaming
|
||||||
|
|
||||||
|
Has this media been optimized for streaming. NOTE: This can be 0, 1, false or true
|
||||||
|
|
||||||
8
docs/models/operations/GetMediaMetaDataLocation.md
Normal file
8
docs/models/operations/GetMediaMetaDataLocation.md
Normal file
@@ -0,0 +1,8 @@
|
|||||||
|
# GetMediaMetaDataLocation
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
||||||
|
| `path` | *String* | :heavy_check_mark: | The file path for the location. | /TV Shows/Better Call Saul |
|
||||||
26
docs/models/operations/GetMediaMetaDataMedia.md
Normal file
26
docs/models/operations/GetMediaMetaDataMedia.md
Normal file
@@ -0,0 +1,26 @@
|
|||||||
|
# GetMediaMetaDataMedia
|
||||||
|
|
||||||
|
|
||||||
|
## 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` | *boolean* | :heavy_check_mark: | 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\<GetMediaMetaDataOptimizedForStreaming>](../../models/operations/GetMediaMetaDataOptimizedForStreaming.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\<[GetMediaMetaDataPart](../../models/operations/GetMediaMetaDataPart.md)> | :heavy_check_mark: | An array of parts for this media item. | |
|
||||||
16
docs/models/operations/GetMediaMetaDataMediaContainer.md
Normal file
16
docs/models/operations/GetMediaMetaDataMediaContainer.md
Normal file
@@ -0,0 +1,16 @@
|
|||||||
|
# GetMediaMetaDataMediaContainer
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- |
|
||||||
|
| `size` | *int* | :heavy_check_mark: | Number of media items returned in this response. | 50 |
|
||||||
|
| `allowSync` | *boolean* | :heavy_check_mark: | Indicates whether syncing is allowed. | false |
|
||||||
|
| `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 |
|
||||||
|
| `metadata` | List\<[GetMediaMetaDataMetadata](../../models/operations/GetMediaMetaDataMetadata.md)> | :heavy_check_mark: | An array of metadata items. | |
|
||||||
@@ -1,45 +1,68 @@
|
|||||||
# GetMetaDataByRatingKeyMetadata
|
# GetMediaMetaDataMetadata
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
| Field | Type | Required | Description | Example |
|
||||||
| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||||
| `ratingKey` | *Optional\<String>* | :heavy_minus_sign: | N/A | 17 |
|
| `ratingKey` | *String* | :heavy_check_mark: | The rating key of the metadata item. | 44288 |
|
||||||
| `key` | *Optional\<String>* | :heavy_minus_sign: | N/A | /library/metadata/17 |
|
| `parentRatingKey` | *Optional\<String>* | :heavy_minus_sign: | The rating key of the parent of this metadata item. | 48047 |
|
||||||
| `guid` | *Optional\<String>* | :heavy_minus_sign: | N/A | plex://movie/5d77683f6f4521001ea9dc53 |
|
| `grandparentRatingKey` | *Optional\<String>* | :heavy_minus_sign: | The rating key of the grandparent of this metadata item. | 45520 |
|
||||||
| `studio` | *Optional\<String>* | :heavy_minus_sign: | N/A | Universal Pictures |
|
| `parentGuid` | *Optional\<String>* | :heavy_minus_sign: | A GUID identifying the parent entity (e.g., season) for the item. | plex://season/618b89208dde18df707ad15c |
|
||||||
| `type` | *Optional\<String>* | :heavy_minus_sign: | N/A | movie |
|
| `grandparentGuid` | *Optional\<String>* | :heavy_minus_sign: | A GUID identifying the grandparent entity (e.g., show). | plex://show/5e16253691c20300412003a8 |
|
||||||
| `title` | *Optional\<String>* | :heavy_minus_sign: | N/A | Serenity |
|
| `grandparentSlug` | *Optional\<String>* | :heavy_minus_sign: | A URL-friendly identifier (slug) for the grandparent entity. | alice-in-borderland-2020 |
|
||||||
| `librarySectionTitle` | *Optional\<String>* | :heavy_minus_sign: | N/A | Movies |
|
| `grandparentKey` | *Optional\<String>* | :heavy_minus_sign: | A key identifying the grandparent metadata in the library. | /library/metadata/45520 |
|
||||||
| `librarySectionID` | *Optional\<Integer>* | :heavy_minus_sign: | N/A | 1 |
|
| `parentKey` | *Optional\<String>* | :heavy_minus_sign: | A key identifying the parent metadata in the library. | /library/metadata/48047 |
|
||||||
| `librarySectionKey` | *Optional\<String>* | :heavy_minus_sign: | N/A | /library/sections/1 |
|
| `key` | *String* | :heavy_check_mark: | The API key to access metadata details. | /library/metadata/44288/children |
|
||||||
| `grandparentTitle` | *Optional\<String>* | :heavy_minus_sign: | The name of the album artist for the track when audio, and the name of the TV show for the episode when video. | |
|
| `guid` | *String* | :heavy_check_mark: | The globally unique identifier for the item. | plex://show/5d9c08254eefaa001f5d6dcb |
|
||||||
| `parentTitle` | *Optional\<String>* | :heavy_minus_sign: | The name of the album for the track when audio, and the name of the season for the episode when TV show. | |
|
| `slug` | *Optional\<String>* | :heavy_minus_sign: | A URL-friendly identifier for the item. | better-call-saul |
|
||||||
| `originalTitle` | *Optional\<String>* | :heavy_minus_sign: | The orginal untranslated name of the media item when non-english. | |
|
| `studio` | *Optional\<String>* | :heavy_minus_sign: | The studio that produced the content. | Sony Pictures Television |
|
||||||
| `index` | *Optional\<Long>* | :heavy_minus_sign: | The index starting from 0 of this media item in the MetaData array. | |
|
| `type` | *String* | :heavy_check_mark: | The type of content (e.g., show, movie). | show |
|
||||||
| `parentIndex` | *Optional\<Long>* | :heavy_minus_sign: | The parent index starting from 0 of this media item in the parent MetaData array. | |
|
| `title` | *String* | :heavy_check_mark: | The title of the content. | Better Call Saul |
|
||||||
| `contentRating` | *Optional\<String>* | :heavy_minus_sign: | N/A | PG-13 |
|
| `originalTitle` | *Optional\<String>* | :heavy_minus_sign: | The original title of the content. | Wicked: Part I |
|
||||||
| `summary` | *Optional\<String>* | :heavy_minus_sign: | N/A | Serenity continues the story of the TV series it was based upon ("Firefly"). River Tam had a secret - one in which she's not even aware - so dangerous, no one's safe, as an Alliance operative's sent to capture her, and all others are considered irrelevant to his job. |
|
| `librarySectionTitle` | *String* | :heavy_check_mark: | The title of the library section. | TV Series |
|
||||||
| `rating` | *Optional\<Double>* | :heavy_minus_sign: | N/A | 8.2 |
|
| `librarySectionID` | *long* | :heavy_check_mark: | The ID of the library section. | 2 |
|
||||||
| `audienceRating` | *Optional\<Double>* | :heavy_minus_sign: | N/A | 9.1 |
|
| `librarySectionKey` | *String* | :heavy_check_mark: | The key of the library section. | /library/sections/2 |
|
||||||
| `year` | *Optional\<Integer>* | :heavy_minus_sign: | N/A | 2005 |
|
| `contentRating` | *Optional\<String>* | :heavy_minus_sign: | The content rating (e.g., TV-MA). | TV-MA |
|
||||||
| `tagline` | *Optional\<String>* | :heavy_minus_sign: | N/A | They aim to misbehave. |
|
| `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. |
|
||||||
| `thumb` | *Optional\<String>* | :heavy_minus_sign: | N/A | /library/metadata/17/thumb/1705637165 |
|
| `index` | *Optional\<Long>* | :heavy_minus_sign: | The index or order of the item. | 1 |
|
||||||
| `art` | *Optional\<String>* | :heavy_minus_sign: | N/A | /library/metadata/17/art/1705637165 |
|
| `grandparentTitle` | *Optional\<String>* | :heavy_minus_sign: | The title of the grandparent entity (typically the show's title). | Alice in Borderland |
|
||||||
| `duration` | *Optional\<Integer>* | :heavy_minus_sign: | N/A | 141417 |
|
| `parentTitle` | *Optional\<String>* | :heavy_minus_sign: | The title of the parent entity (typically the season's title). | Season 2 |
|
||||||
| `originallyAvailableAt` | [LocalDate](https://docs.oracle.com/javase/8/docs/api/java/time/LocalDate.html) | :heavy_minus_sign: | N/A | 2005-09-29 00:00:00 +0000 UTC |
|
| `audienceRating` | *Optional\<Float>* | :heavy_minus_sign: | The audience rating for the content. | 8.7 |
|
||||||
| `addedAt` | *Optional\<Integer>* | :heavy_minus_sign: | N/A | 1705637164 |
|
| `viewCount` | *Optional\<Long>* | :heavy_minus_sign: | The number of times the item has been viewed. | 4 |
|
||||||
| `updatedAt` | *Optional\<Integer>* | :heavy_minus_sign: | N/A | 1705637165 |
|
| `skipCount` | *Optional\<Long>* | :heavy_minus_sign: | The number of times the item has been skipped. | 1 |
|
||||||
| `audienceRatingImage` | *Optional\<String>* | :heavy_minus_sign: | N/A | rottentomatoes://image.rating.upright |
|
| `lastViewedAt` | *Optional\<Long>* | :heavy_minus_sign: | Unix timestamp of when the item was last viewed. | 1625764795 |
|
||||||
| `hasPremiumPrimaryExtra` | *Optional\<String>* | :heavy_minus_sign: | N/A | 1 |
|
| `year` | *int* | :heavy_check_mark: | The release year. | 2015 |
|
||||||
| `ratingImage` | *Optional\<String>* | :heavy_minus_sign: | N/A | rottentomatoes://image.rating.ripe |
|
| `rating` | *Optional\<Float>* | :heavy_minus_sign: | The general rating | 6 |
|
||||||
| `media` | List\<[GetMetaDataByRatingKeyMedia](../../models/operations/GetMetaDataByRatingKeyMedia.md)> | :heavy_minus_sign: | N/A | |
|
| `ratingImage` | *Optional\<String>* | :heavy_minus_sign: | The URL or identifier for the rating image (e.g., Rotten Tomatoes rating image). | rottentomatoes://image.rating.ripe |
|
||||||
| `genre` | List\<[GetMetaDataByRatingKeyGenre](../../models/operations/GetMetaDataByRatingKeyGenre.md)> | :heavy_minus_sign: | N/A | |
|
| `tagline` | *Optional\<String>* | :heavy_minus_sign: | The tagline of the content. | Make the call |
|
||||||
| `country` | List\<[GetMetaDataByRatingKeyCountry](../../models/operations/GetMetaDataByRatingKeyCountry.md)> | :heavy_minus_sign: | N/A | |
|
| `chapterSource` | *Optional\<String>* | :heavy_minus_sign: | N/A | media |
|
||||||
| `guids` | List\<[Guids](../../models/operations/Guids.md)> | :heavy_minus_sign: | N/A | |
|
| `primaryExtraKey` | *Optional\<String>* | :heavy_minus_sign: | N/A | /library/metadata/134704 |
|
||||||
| `ratings` | List\<[Ratings](../../models/operations/Ratings.md)> | :heavy_minus_sign: | N/A | |
|
| `thumb` | *String* | :heavy_check_mark: | URL of the thumbnail image. | /library/metadata/44288/thumb/1736487993 |
|
||||||
| `director` | List\<[GetMetaDataByRatingKeyDirector](../../models/operations/GetMetaDataByRatingKeyDirector.md)> | :heavy_minus_sign: | N/A | |
|
| `art` | *String* | :heavy_check_mark: | URL of the art image. | /library/metadata/44288/art/1736487993 |
|
||||||
| `writer` | List\<[GetMetaDataByRatingKeyWriter](../../models/operations/GetMetaDataByRatingKeyWriter.md)> | :heavy_minus_sign: | N/A | |
|
| `theme` | *Optional\<String>* | :heavy_minus_sign: | URL of the theme image. | /library/metadata/44288/theme/1736487993 |
|
||||||
| `role` | List\<[GetMetaDataByRatingKeyRole](../../models/operations/GetMetaDataByRatingKeyRole.md)> | :heavy_minus_sign: | N/A | |
|
| `duration` | *int* | :heavy_check_mark: | Duration of the content in milliseconds. | 2700000 |
|
||||||
| `producer` | List\<[Producer](../../models/operations/Producer.md)> | :heavy_minus_sign: | N/A | |
|
| `originallyAvailableAt` | [LocalDate](https://docs.oracle.com/javase/8/docs/api/java/time/LocalDate.html) | :heavy_minus_sign: | The original release date. | 2015-02-08 |
|
||||||
|
| `leafCount` | *Optional\<Long>* | :heavy_minus_sign: | The total number of episodes (or leaves). | 63 |
|
||||||
|
| `viewedLeafCount` | *Optional\<Long>* | :heavy_minus_sign: | The number of episodes that have been viewed. | 4 |
|
||||||
|
| `childCount` | *Optional\<Integer>* | :heavy_minus_sign: | The number of child items. | 6 |
|
||||||
|
| `addedAt` | *long* | :heavy_check_mark: | N/A | 1556281940 |
|
||||||
|
| `updatedAt` | *long* | :heavy_check_mark: | N/A | 1556281940 |
|
||||||
|
| `audienceRatingImage` | *Optional\<String>* | :heavy_minus_sign: | The URL for the audience rating image. | themoviedb://image.rating |
|
||||||
|
| `parentIndex` | *Optional\<Long>* | :heavy_minus_sign: | The index number of the parent entity, which could indicate its order or position. | 2 |
|
||||||
|
| `parentThumb` | *Optional\<String>* | :heavy_minus_sign: | The URL of the parent's thumbnail image. | /library/metadata/48047/thumb/1671800243 |
|
||||||
|
| `grandparentThumb` | *Optional\<String>* | :heavy_minus_sign: | The URL of the grandparent's thumbnail image. | /library/metadata/45520/thumb/1736488003 |
|
||||||
|
| `grandparentArt` | *Optional\<String>* | :heavy_minus_sign: | The URL of the grandparent's art image. | /library/metadata/45520/art/1736488003 |
|
||||||
|
| `media` | List\<[GetMediaMetaDataMedia](../../models/operations/GetMediaMetaDataMedia.md)> | :heavy_minus_sign: | N/A | |
|
||||||
|
| `image` | List\<[GetMediaMetaDataImage](../../models/operations/GetMediaMetaDataImage.md)> | :heavy_check_mark: | An array of image objects. | |
|
||||||
|
| `ultraBlurColors` | [GetMediaMetaDataUltraBlurColors](../../models/operations/GetMediaMetaDataUltraBlurColors.md) | :heavy_check_mark: | N/A | |
|
||||||
|
| `genre` | List\<[GetMediaMetaDataGenre](../../models/operations/GetMediaMetaDataGenre.md)> | :heavy_minus_sign: | An array of genre tags. | |
|
||||||
|
| `country` | List\<[GetMediaMetaDataCountry](../../models/operations/GetMediaMetaDataCountry.md)> | :heavy_minus_sign: | An array of country tags. | |
|
||||||
|
| `guids` | List\<[GetMediaMetaDataGuids](../../models/operations/GetMediaMetaDataGuids.md)> | :heavy_minus_sign: | An array of GUID objects. | |
|
||||||
|
| `ratings` | List\<[Ratings](../../models/operations/Ratings.md)> | :heavy_minus_sign: | An array of rating objects. | |
|
||||||
|
| `role` | List\<[GetMediaMetaDataRole](../../models/operations/GetMediaMetaDataRole.md)> | :heavy_minus_sign: | An array of Actor roles. | |
|
||||||
|
| `director` | List\<[GetMediaMetaDataDirector](../../models/operations/GetMediaMetaDataDirector.md)> | :heavy_minus_sign: | An array of Director roles. | |
|
||||||
|
| `writer` | List\<[GetMediaMetaDataWriter](../../models/operations/GetMediaMetaDataWriter.md)> | :heavy_minus_sign: | An array of Writer roles. | |
|
||||||
|
| `producer` | List\<[Producer](../../models/operations/Producer.md)> | :heavy_minus_sign: | An array of Writer roles. | |
|
||||||
|
| `similar` | List\<[Similar](../../models/operations/Similar.md)> | :heavy_minus_sign: | An array of similar content objects. | |
|
||||||
|
| `location` | List\<[GetMediaMetaDataLocation](../../models/operations/GetMediaMetaDataLocation.md)> | :heavy_minus_sign: | An array of location objects. | |
|
||||||
@@ -0,0 +1,4 @@
|
|||||||
|
# GetMediaMetaDataOptimizedForStreaming
|
||||||
|
|
||||||
|
Has this media been optimized for streaming. NOTE: This can be 0, 1, false or true
|
||||||
|
|
||||||
@@ -0,0 +1,9 @@
|
|||||||
|
# GetMediaMetaDataOptimizedForStreaming1
|
||||||
|
|
||||||
|
|
||||||
|
## Values
|
||||||
|
|
||||||
|
| Name | Value |
|
||||||
|
| ------ | ------ |
|
||||||
|
| `ZERO` | 0 |
|
||||||
|
| `ONE` | 1 |
|
||||||
23
docs/models/operations/GetMediaMetaDataPart.md
Normal file
23
docs/models/operations/GetMediaMetaDataPart.md
Normal file
@@ -0,0 +1,23 @@
|
|||||||
|
# GetMediaMetaDataPart
|
||||||
|
|
||||||
|
|
||||||
|
## 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\<GetMediaMetaDataLibraryOptimizedForStreaming>](../../models/operations/GetMediaMetaDataLibraryOptimizedForStreaming.md) | :heavy_minus_sign: | Has this media been optimized for streaming. NOTE: This can be 0, 1, false or true | |
|
||||||
|
| `hasThumbnail` | [Optional\<GetMediaMetaDataHasThumbnail>](../../models/operations/GetMediaMetaDataHasThumbnail.md) | :heavy_minus_sign: | N/A | 1 |
|
||||||
|
| `stream` | List\<[GetMediaMetaDataStream](../../models/operations/GetMediaMetaDataStream.md)> | :heavy_minus_sign: | An array of streams for this part. | |
|
||||||
21
docs/models/operations/GetMediaMetaDataRequest.md
Normal file
21
docs/models/operations/GetMediaMetaDataRequest.md
Normal file
@@ -0,0 +1,21 @@
|
|||||||
|
# GetMediaMetaDataRequest
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ------------------------------------------------------ | ------------------------------------------------------ | ------------------------------------------------------ | ------------------------------------------------------ | ------------------------------------------------------ |
|
||||||
|
| `ratingKey` | *long* | :heavy_check_mark: | the id of the library item to return the children of. | 9518 |
|
||||||
|
| `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 |
|
||||||
|
| `includeOnDeck` | *Optional\<Boolean>* | :heavy_minus_sign: | Include on-deck items. | true |
|
||||||
|
| `includePopularLeaves` | *Optional\<Boolean>* | :heavy_minus_sign: | Include popular leaves (episodes/chapters). | true |
|
||||||
|
| `includePreferences` | *Optional\<Boolean>* | :heavy_minus_sign: | Include preferences information. | true |
|
||||||
|
| `includeReviews` | *Optional\<Boolean>* | :heavy_minus_sign: | Include reviews for the content. | true |
|
||||||
|
| `includeChapters` | *Optional\<Boolean>* | :heavy_minus_sign: | Include chapter details. | true |
|
||||||
|
| `includeStations` | *Optional\<Boolean>* | :heavy_minus_sign: | Include station data. | true |
|
||||||
|
| `includeExternalMedia` | *Optional\<Boolean>* | :heavy_minus_sign: | Include external media data. | true |
|
||||||
|
| `asyncAugmentMetadata` | *Optional\<Boolean>* | :heavy_minus_sign: | Trigger asynchronous metadata augmentation. | true |
|
||||||
|
| `asyncCheckFiles` | *Optional\<Boolean>* | :heavy_minus_sign: | Trigger asynchronous file checking. | 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 |
|
||||||
@@ -1,4 +1,4 @@
|
|||||||
# GetMetaDataByRatingKeyResponse
|
# GetMediaMetaDataResponse
|
||||||
|
|
||||||
|
|
||||||
## 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\<GetMetaDataByRatingKeyResponseBody>](../../models/operations/GetMetaDataByRatingKeyResponseBody.md) | :heavy_minus_sign: | The metadata of the library item. |
|
| `object` | [Optional\<GetMediaMetaDataResponseBody>](../../models/operations/GetMediaMetaDataResponseBody.md) | :heavy_minus_sign: | The metadata of the library item. |
|
||||||
10
docs/models/operations/GetMediaMetaDataResponseBody.md
Normal file
10
docs/models/operations/GetMediaMetaDataResponseBody.md
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
# GetMediaMetaDataResponseBody
|
||||||
|
|
||||||
|
The metadata of the library item.
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ |
|
||||||
|
| `mediaContainer` | [Optional\<GetMediaMetaDataMediaContainer>](../../models/operations/GetMediaMetaDataMediaContainer.md) | :heavy_minus_sign: | N/A |
|
||||||
13
docs/models/operations/GetMediaMetaDataRole.md
Normal file
13
docs/models/operations/GetMediaMetaDataRole.md
Normal file
@@ -0,0 +1,13 @@
|
|||||||
|
# GetMediaMetaDataRole
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- |
|
||||||
|
| `id` | *long* | :heavy_check_mark: | The unique role identifier. | 109501 |
|
||||||
|
| `filter` | *String* | :heavy_check_mark: | The filter string for the role. | actor=109501 |
|
||||||
|
| `tag` | *String* | :heavy_check_mark: | The actor's name. | Bob Odenkirk |
|
||||||
|
| `tagKey` | *String* | :heavy_check_mark: | A key associated with the actor tag. | 5d77683254f42c001f8c3f69 |
|
||||||
|
| `role` | *Optional\<String>* | :heavy_minus_sign: | The character name or role. | Jimmy McGill |
|
||||||
|
| `thumb` | *Optional\<String>* | :heavy_minus_sign: | URL for the role thumbnail image. | https://metadata-static.plex.tv/f/people/f2ca7b474cc984efbdd5c503a096285a.jpg |
|
||||||
54
docs/models/operations/GetMediaMetaDataStream.md
Normal file
54
docs/models/operations/GetMediaMetaDataStream.md
Normal file
@@ -0,0 +1,54 @@
|
|||||||
|
# GetMediaMetaDataStream
|
||||||
|
|
||||||
|
|
||||||
|
## 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` | *String* | :heavy_check_mark: | Language of the stream. | English |
|
||||||
|
| `languageTag` | *String* | :heavy_check_mark: | Language tag (e.g., en). | en |
|
||||||
|
| `languageCode` | *String* | :heavy_check_mark: | 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 |
|
||||||
|
| `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 |
|
||||||
|
| `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 |
|
||||||
11
docs/models/operations/GetMediaMetaDataUltraBlurColors.md
Normal file
11
docs/models/operations/GetMediaMetaDataUltraBlurColors.md
Normal file
@@ -0,0 +1,11 @@
|
|||||||
|
# GetMediaMetaDataUltraBlurColors
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ----------------------------- | ----------------------------- | ----------------------------- | ----------------------------- | ----------------------------- |
|
||||||
|
| `topLeft` | *String* | :heavy_check_mark: | The top-left color value. | 11333a |
|
||||||
|
| `topRight` | *String* | :heavy_check_mark: | The top-right color value. | 1d2721 |
|
||||||
|
| `bottomRight` | *String* | :heavy_check_mark: | The bottom-right color value. | 5c451d |
|
||||||
|
| `bottomLeft` | *String* | :heavy_check_mark: | The bottom-left color value. | 372c10 |
|
||||||
13
docs/models/operations/GetMediaMetaDataWriter.md
Normal file
13
docs/models/operations/GetMediaMetaDataWriter.md
Normal file
@@ -0,0 +1,13 @@
|
|||||||
|
# GetMediaMetaDataWriter
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- |
|
||||||
|
| `id` | *long* | :heavy_check_mark: | The unique role identifier. | 109501 |
|
||||||
|
| `filter` | *String* | :heavy_check_mark: | The filter string for the role. | actor=109501 |
|
||||||
|
| `tag` | *String* | :heavy_check_mark: | The actor's name. | Bob Odenkirk |
|
||||||
|
| `tagKey` | *String* | :heavy_check_mark: | A key associated with the actor tag. | 5d77683254f42c001f8c3f69 |
|
||||||
|
| `role` | *Optional\<String>* | :heavy_minus_sign: | The character name or role. | Jimmy McGill |
|
||||||
|
| `thumb` | *Optional\<String>* | :heavy_minus_sign: | URL for the role thumbnail image. | https://metadata-static.plex.tv/f/people/f2ca7b474cc984efbdd5c503a096285a.jpg |
|
||||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user