mirror of
https://github.com/LukeHagar/plexjava.git
synced 2025-12-06 20:47:45 +00:00
Compare commits
12 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
aa85c1813b | ||
|
|
84fb18428a | ||
|
|
37569715a6 | ||
|
|
c0e915da8b | ||
|
|
0077561a6a | ||
|
|
4b28ca3416 | ||
|
|
dd781d1e27 | ||
|
|
dcdcafc044 | ||
|
|
04db2979db | ||
|
|
c2eeb488c4 | ||
|
|
8194abfa99 | ||
|
|
26e1ac258e |
1
.gitattributes
vendored
1
.gitattributes
vendored
@@ -9,4 +9,3 @@
|
|||||||
|
|
||||||
# This allows generated code to be indexed correctly
|
# This allows generated code to be indexed correctly
|
||||||
*.java linguist-generated=false
|
*.java linguist-generated=false
|
||||||
|
|
||||||
|
|||||||
2
.gitignore
vendored
2
.gitignore
vendored
@@ -1,3 +1,5 @@
|
|||||||
|
**/.speakeasy/temp/
|
||||||
|
**/.speakeasy/logs/
|
||||||
.speakeasy/reports
|
.speakeasy/reports
|
||||||
# Ignore Gradle project-specific cache directory
|
# Ignore Gradle project-specific cache directory
|
||||||
.gradle
|
.gradle
|
||||||
|
|||||||
1587
.speakeasy/gen.lock
1587
.speakeasy/gen.lock
File diff suppressed because one or more lines are too long
@@ -4,19 +4,24 @@ generation:
|
|||||||
maintainOpenAPIOrder: true
|
maintainOpenAPIOrder: true
|
||||||
usageSnippets:
|
usageSnippets:
|
||||||
optionalPropertyRendering: withExample
|
optionalPropertyRendering: withExample
|
||||||
|
sdkInitStyle: constructor
|
||||||
useClassNamesForArrayFields: true
|
useClassNamesForArrayFields: true
|
||||||
fixes:
|
fixes:
|
||||||
nameResolutionDec2023: true
|
nameResolutionDec2023: true
|
||||||
|
nameResolutionFeb2025: false
|
||||||
parameterOrderingFeb2024: true
|
parameterOrderingFeb2024: true
|
||||||
requestResponseComponentNamesFeb2024: true
|
requestResponseComponentNamesFeb2024: true
|
||||||
|
securityFeb2025: false
|
||||||
|
sharedErrorComponentsApr2025: false
|
||||||
auth:
|
auth:
|
||||||
oAuth2ClientCredentialsEnabled: true
|
oAuth2ClientCredentialsEnabled: true
|
||||||
oAuth2PasswordEnabled: false
|
oAuth2PasswordEnabled: false
|
||||||
java:
|
java:
|
||||||
version: 0.12.0
|
version: 0.17.1
|
||||||
additionalDependencies: []
|
additionalDependencies: []
|
||||||
additionalPlugins: []
|
additionalPlugins: []
|
||||||
artifactID: plexapi
|
artifactID: plexapi
|
||||||
|
baseErrorName: PlexAPIError
|
||||||
clientServerStatusCodesAsErrors: true
|
clientServerStatusCodesAsErrors: true
|
||||||
companyEmail: lukeslakemail@gmail.com
|
companyEmail: lukeslakemail@gmail.com
|
||||||
companyName: plexapi
|
companyName: plexapi
|
||||||
|
|||||||
@@ -1,4 +1,4 @@
|
|||||||
speakeasyVersion: 1.487.1
|
speakeasyVersion: 1.557.0
|
||||||
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:0efb9039972533bf1190dfc1ffb377429a8e486b6299442e732f662c1ffbeca6
|
sourceRevisionDigest: sha256:dafcc1192236829b85bc924e0462432c0eb7318a17c542f46e3dd05a9a6265df
|
||||||
sourceBlobDigest: sha256:038d73166cc9db17f514d511cfe4365ea032f4ebcb247fa86b7aa1bba0e1ab46
|
sourceBlobDigest: sha256:bc072115d585e1695cb8393db901a3d36be1dcd57a69bad2b91a1ba7ac3c9c4b
|
||||||
tags:
|
tags:
|
||||||
- latest
|
- latest
|
||||||
- speakeasy-sdk-regen-1739147238
|
- speakeasy-sdk-regen-1749429180
|
||||||
targets:
|
targets:
|
||||||
plexjava:
|
plexjava:
|
||||||
source: plexapi
|
source: plexapi
|
||||||
sourceNamespace: plexapi
|
sourceNamespace: plexapi
|
||||||
sourceRevisionDigest: sha256:0efb9039972533bf1190dfc1ffb377429a8e486b6299442e732f662c1ffbeca6
|
sourceRevisionDigest: sha256:dafcc1192236829b85bc924e0462432c0eb7318a17c542f46e3dd05a9a6265df
|
||||||
sourceBlobDigest: sha256:038d73166cc9db17f514d511cfe4365ea032f4ebcb247fa86b7aa1bba0e1ab46
|
sourceBlobDigest: sha256:bc072115d585e1695cb8393db901a3d36be1dcd57a69bad2b91a1ba7ac3c9c4b
|
||||||
codeSamplesNamespace: code-samples-java-plexjava
|
codeSamplesNamespace: code-samples-java-plexjava
|
||||||
codeSamplesRevisionDigest: sha256:2d1414485f745cc63505b9790fa16ac01e42822a6b28a5ff61486ffdd08ed8de
|
codeSamplesRevisionDigest: sha256:9a3449eb22007686202d7d579803f2444900048695cc795361b72f801f88a98a
|
||||||
workflow:
|
workflow:
|
||||||
workflowVersion: 1.0.0
|
workflowVersion: 1.0.0
|
||||||
speakeasyVersion: latest
|
speakeasyVersion: latest
|
||||||
@@ -42,3 +42,5 @@ workflow:
|
|||||||
output: codeSamples.yaml
|
output: codeSamples.yaml
|
||||||
registry:
|
registry:
|
||||||
location: registry.speakeasyapi.dev/plexapi/plexapi/code-samples-java-plexjava
|
location: registry.speakeasyapi.dev/plexapi/plexapi/code-samples-java-plexjava
|
||||||
|
labelOverride:
|
||||||
|
fixedValue: PlexJava
|
||||||
|
|||||||
@@ -18,3 +18,5 @@ targets:
|
|||||||
output: codeSamples.yaml
|
output: codeSamples.yaml
|
||||||
registry:
|
registry:
|
||||||
location: registry.speakeasyapi.dev/plexapi/plexapi/code-samples-java-plexjava
|
location: registry.speakeasyapi.dev/plexapi/plexapi/code-samples-java-plexjava
|
||||||
|
labelOverride:
|
||||||
|
fixedValue: PlexJava
|
||||||
|
|||||||
78
README.md
78
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.12.0'
|
implementation 'dev.plexapi:plexapi:0.17.1'
|
||||||
```
|
```
|
||||||
|
|
||||||
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.12.0</version>
|
<version>0.17.1</version>
|
||||||
</dependency>
|
</dependency>
|
||||||
```
|
```
|
||||||
|
|
||||||
@@ -94,6 +94,29 @@ On Windows:
|
|||||||
```bash
|
```bash
|
||||||
gradlew.bat publishToMavenLocal -Pskip.signing
|
gradlew.bat publishToMavenLocal -Pskip.signing
|
||||||
```
|
```
|
||||||
|
|
||||||
|
### Logging
|
||||||
|
A logging framework/facade has not yet been adopted but is under consideration.
|
||||||
|
|
||||||
|
For request and response logging (especially json bodies) use:
|
||||||
|
```java
|
||||||
|
SpeakeasyHTTPClient.setDebugLogging(true); // experimental API only (may change without warning)
|
||||||
|
```
|
||||||
|
Example output:
|
||||||
|
```
|
||||||
|
Sending request: http://localhost:35123/bearer#global GET
|
||||||
|
Request headers: {Accept=[application/json], Authorization=[******], Client-Level-Header=[added by client], Idempotency-Key=[some-key], x-speakeasy-user-agent=[speakeasy-sdk/java 0.0.1 internal 0.1.0 org.openapis.openapi]}
|
||||||
|
Received response: (GET http://localhost:35123/bearer#global) 200
|
||||||
|
Response headers: {access-control-allow-credentials=[true], access-control-allow-origin=[*], connection=[keep-alive], content-length=[50], content-type=[application/json], date=[Wed, 09 Apr 2025 01:43:29 GMT], server=[gunicorn/19.9.0]}
|
||||||
|
Response body:
|
||||||
|
{
|
||||||
|
"authenticated": true,
|
||||||
|
"token": "global"
|
||||||
|
}
|
||||||
|
```
|
||||||
|
WARNING: This should only used for temporary debugging purposes. Leaving this option on in a production system could expose credentials/secrets in logs. <i>Authorization</i> headers are redacted by default and there is the ability to specify redacted header names via `SpeakeasyHTTPClient.setRedactedHeaders`.
|
||||||
|
|
||||||
|
Another option is to set the System property `-Djdk.httpclient.HttpClient.log=all`. However, this second option does not log bodies.
|
||||||
<!-- End SDK Installation [installation] -->
|
<!-- End SDK Installation [installation] -->
|
||||||
|
|
||||||
<!-- Start SDK Example Usage [usage] -->
|
<!-- Start SDK Example Usage [usage] -->
|
||||||
@@ -169,7 +192,7 @@ public class Application {
|
|||||||
* [getLibraryDetails](docs/sdks/library/README.md#getlibrarydetails) - Get Library Details
|
* [getLibraryDetails](docs/sdks/library/README.md#getlibrarydetails) - Get Library Details
|
||||||
* [deleteLibrary](docs/sdks/library/README.md#deletelibrary) - Delete Library Section
|
* [deleteLibrary](docs/sdks/library/README.md#deletelibrary) - Delete Library Section
|
||||||
* [getLibraryItems](docs/sdks/library/README.md#getlibraryitems) - Get Library Items
|
* [getLibraryItems](docs/sdks/library/README.md#getlibraryitems) - Get Library Items
|
||||||
* [getAllMediaLibrary](docs/sdks/library/README.md#getallmedialibrary) - Get all media of library
|
* [getLibrarySectionsAll](docs/sdks/library/README.md#getlibrarysectionsall) - Get Library section media by tag ALL
|
||||||
* [getRefreshLibraryMetadata](docs/sdks/library/README.md#getrefreshlibrarymetadata) - Refresh Metadata Of The Library
|
* [getRefreshLibraryMetadata](docs/sdks/library/README.md#getrefreshlibrarymetadata) - Refresh Metadata Of The Library
|
||||||
* [getSearchLibrary](docs/sdks/library/README.md#getsearchlibrary) - Search Library
|
* [getSearchLibrary](docs/sdks/library/README.md#getsearchlibrary) - Search Library
|
||||||
* [getGenresLibrary](docs/sdks/library/README.md#getgenreslibrary) - Get Genres of library media
|
* [getGenresLibrary](docs/sdks/library/README.md#getgenreslibrary) - Get Genres of library media
|
||||||
@@ -177,9 +200,12 @@ public class Application {
|
|||||||
* [getActorsLibrary](docs/sdks/library/README.md#getactorslibrary) - Get Actors 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
|
||||||
* [getMediaMetaData](docs/sdks/library/README.md#getmediametadata) - Get Media Metadata
|
* [getMediaMetaData](docs/sdks/library/README.md#getmediametadata) - Get Media Metadata
|
||||||
|
* [getMediaArts](docs/sdks/library/README.md#getmediaarts) - Get Media Background Artwork
|
||||||
|
* [postMediaArts](docs/sdks/library/README.md#postmediaarts) - Upload Media Background Artwork
|
||||||
|
* [getMediaPosters](docs/sdks/library/README.md#getmediaposters) - Get Media Posters
|
||||||
|
* [postMediaPoster](docs/sdks/library/README.md#postmediaposter) - Upload Media Poster
|
||||||
* [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
|
|
||||||
|
|
||||||
### [log()](docs/sdks/log/README.md)
|
### [log()](docs/sdks/log/README.md)
|
||||||
|
|
||||||
@@ -320,13 +346,49 @@ 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.SDK.Builder.ServerProtocol;
|
||||||
|
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(ServerProtocol.HTTPS)
|
||||||
|
.ip("4982:bc2a:b4f8:efb5:2394:5bc3:ab4f:0e6d")
|
||||||
|
.port("44765")
|
||||||
|
.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;
|
||||||
|
|
||||||
|
|||||||
110
RELEASES.md
110
RELEASES.md
@@ -259,3 +259,113 @@ Based on:
|
|||||||
- [java v0.12.0] .
|
- [java v0.12.0] .
|
||||||
### Releases
|
### Releases
|
||||||
- [Maven Central v0.12.0] https://central.sonatype.com/artifact/dev.plexapi/plexapi/0.12.0 - .
|
- [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 - .
|
||||||
|
|
||||||
|
## 2025-03-09 00:24:27
|
||||||
|
### Changes
|
||||||
|
Based on:
|
||||||
|
- OpenAPI Doc
|
||||||
|
- Speakeasy CLI 1.513.4 (2.545.4) https://github.com/speakeasy-api/speakeasy
|
||||||
|
### Generated
|
||||||
|
- [java v0.13.1] .
|
||||||
|
### Releases
|
||||||
|
- [Maven Central v0.13.1] https://central.sonatype.com/artifact/dev.plexapi/plexapi/0.13.1 - .
|
||||||
|
|
||||||
|
## 2025-03-31 17:07:30
|
||||||
|
### Changes
|
||||||
|
Based on:
|
||||||
|
- OpenAPI Doc
|
||||||
|
- Speakeasy CLI 1.526.6 (2.563.1) https://github.com/speakeasy-api/speakeasy
|
||||||
|
### Generated
|
||||||
|
- [java v0.14.0] .
|
||||||
|
### Releases
|
||||||
|
- [Maven Central v0.14.0] https://central.sonatype.com/artifact/dev.plexapi/plexapi/0.14.0 - .
|
||||||
|
|
||||||
|
## 2025-04-03 00:27:41
|
||||||
|
### Changes
|
||||||
|
Based on:
|
||||||
|
- OpenAPI Doc
|
||||||
|
- Speakeasy CLI 1.528.1 (2.565.1) https://github.com/speakeasy-api/speakeasy
|
||||||
|
### Generated
|
||||||
|
- [java v0.14.1] .
|
||||||
|
### Releases
|
||||||
|
- [Maven Central v0.14.1] https://central.sonatype.com/artifact/dev.plexapi/plexapi/0.14.1 - .
|
||||||
|
|
||||||
|
## 2025-04-06 00:30:19
|
||||||
|
### Changes
|
||||||
|
Based on:
|
||||||
|
- OpenAPI Doc
|
||||||
|
- Speakeasy CLI 1.529.1 (2.566.5) https://github.com/speakeasy-api/speakeasy
|
||||||
|
### Generated
|
||||||
|
- [java v0.14.2] .
|
||||||
|
### Releases
|
||||||
|
- [Maven Central v0.14.2] https://central.sonatype.com/artifact/dev.plexapi/plexapi/0.14.2 - .
|
||||||
|
|
||||||
|
## 2025-04-14 00:30:37
|
||||||
|
### Changes
|
||||||
|
Based on:
|
||||||
|
- OpenAPI Doc
|
||||||
|
- Speakeasy CLI 1.531.4 (2.570.4) https://github.com/speakeasy-api/speakeasy
|
||||||
|
### Generated
|
||||||
|
- [java v0.15.0] .
|
||||||
|
### Releases
|
||||||
|
- [Maven Central v0.15.0] https://central.sonatype.com/artifact/dev.plexapi/plexapi/0.15.0 - .
|
||||||
|
|
||||||
|
## 2025-04-19 00:27:27
|
||||||
|
### Changes
|
||||||
|
Based on:
|
||||||
|
- OpenAPI Doc
|
||||||
|
- Speakeasy CLI 1.535.1 (2.585.2) https://github.com/speakeasy-api/speakeasy
|
||||||
|
### Generated
|
||||||
|
- [java v0.16.0] .
|
||||||
|
### Releases
|
||||||
|
- [Maven Central v0.16.0] https://central.sonatype.com/artifact/dev.plexapi/plexapi/0.16.0 - .
|
||||||
|
|
||||||
|
## 2025-05-01 00:32:51
|
||||||
|
### Changes
|
||||||
|
Based on:
|
||||||
|
- OpenAPI Doc
|
||||||
|
- Speakeasy CLI 1.541.2 (2.595.4) https://github.com/speakeasy-api/speakeasy
|
||||||
|
### Generated
|
||||||
|
- [java v0.16.1] .
|
||||||
|
### Releases
|
||||||
|
- [Maven Central v0.16.1] https://central.sonatype.com/artifact/dev.plexapi/plexapi/0.16.1 - .
|
||||||
|
|
||||||
|
## 2025-05-05 00:31:37
|
||||||
|
### Changes
|
||||||
|
Based on:
|
||||||
|
- OpenAPI Doc
|
||||||
|
- Speakeasy CLI 1.542.1 (2.597.9) https://github.com/speakeasy-api/speakeasy
|
||||||
|
### Generated
|
||||||
|
- [java v0.16.2] .
|
||||||
|
### Releases
|
||||||
|
- [Maven Central v0.16.2] https://central.sonatype.com/artifact/dev.plexapi/plexapi/0.16.2 - .
|
||||||
|
|
||||||
|
## 2025-06-04 00:30:54
|
||||||
|
### Changes
|
||||||
|
Based on:
|
||||||
|
- OpenAPI Doc
|
||||||
|
- Speakeasy CLI 1.555.2 (2.620.2) https://github.com/speakeasy-api/speakeasy
|
||||||
|
### Generated
|
||||||
|
- [java v0.17.0] .
|
||||||
|
### Releases
|
||||||
|
- [Maven Central v0.17.0] https://central.sonatype.com/artifact/dev.plexapi/plexapi/0.17.0 - .
|
||||||
|
|
||||||
|
## 2025-06-09 00:32:43
|
||||||
|
### Changes
|
||||||
|
Based on:
|
||||||
|
- OpenAPI Doc
|
||||||
|
- Speakeasy CLI 1.557.0 (2.623.0) https://github.com/speakeasy-api/speakeasy
|
||||||
|
### Generated
|
||||||
|
- [java v0.17.1] .
|
||||||
|
### Releases
|
||||||
|
- [Maven Central v0.17.1] https://central.sonatype.com/artifact/dev.plexapi/plexapi/0.17.1 - .
|
||||||
27
build.gradle
27
build.gradle
@@ -39,9 +39,12 @@ model {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
version = "${version}"
|
||||||
|
group = "${groupId}"
|
||||||
|
|
||||||
jar {
|
jar {
|
||||||
dependsOn(":generatePomFileForMavenPublication")
|
dependsOn(":generatePomFileForMavenPublication")
|
||||||
archiveBaseName = "plexapi"
|
archiveBaseName = "${artifactId}"
|
||||||
|
|
||||||
into("META-INF/maven/dev.plexapi/plexapi") {
|
into("META-INF/maven/dev.plexapi/plexapi") {
|
||||||
from("$buildDir/pom.xml")
|
from("$buildDir/pom.xml")
|
||||||
@@ -62,15 +65,12 @@ tasks.withType(Javadoc) {
|
|||||||
options.addStringOption('Xdoclint:none', '-quiet')
|
options.addStringOption('Xdoclint:none', '-quiet')
|
||||||
}
|
}
|
||||||
|
|
||||||
group = "dev.plexapi"
|
|
||||||
version = "0.12.0"
|
|
||||||
|
|
||||||
sourcesJar {
|
sourcesJar {
|
||||||
archiveBaseName = "plexapi"
|
archiveBaseName = "${artifactId}"
|
||||||
}
|
}
|
||||||
|
|
||||||
javadocJar {
|
javadocJar {
|
||||||
archiveBaseName = "plexapi"
|
archiveBaseName = "${artifactId}"
|
||||||
}
|
}
|
||||||
sonatypeCentralUpload {
|
sonatypeCentralUpload {
|
||||||
// This is your Sonatype generated username
|
// This is your Sonatype generated username
|
||||||
@@ -80,9 +80,9 @@ sonatypeCentralUpload {
|
|||||||
|
|
||||||
// This is a list of files to upload. Ideally you would point to your jar file, source and javadoc jar (required by central)
|
// This is a list of files to upload. Ideally you would point to your jar file, source and javadoc jar (required by central)
|
||||||
archives = files(
|
archives = files(
|
||||||
"$buildDir/libs/plexapi-${version}.jar",
|
"$buildDir/libs/${artifactId}-${version}.jar",
|
||||||
"$buildDir/libs/plexapi-${version}-sources.jar",
|
"$buildDir/libs/${artifactId}-${version}-sources.jar",
|
||||||
"$buildDir/libs/plexapi-${version}-javadoc.jar"
|
"$buildDir/libs/${artifactId}-${version}-javadoc.jar"
|
||||||
)
|
)
|
||||||
|
|
||||||
// This is the pom file to upload. This is required by central
|
// This is the pom file to upload. This is required by central
|
||||||
@@ -99,9 +99,11 @@ publishing {
|
|||||||
|
|
||||||
publications {
|
publications {
|
||||||
maven(MavenPublication) {
|
maven(MavenPublication) {
|
||||||
groupId = 'dev.plexapi'
|
// note that properties can't yet be used below!
|
||||||
artifactId = 'plexapi'
|
// https://github.com/gradle/gradle/issues/18619
|
||||||
version = '0.12.0'
|
groupId = "dev.plexapi"
|
||||||
|
artifactId = "plexapi"
|
||||||
|
version = "0.17.1"
|
||||||
|
|
||||||
from components.java
|
from components.java
|
||||||
|
|
||||||
@@ -152,7 +154,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'
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
1143
codeSamples.yaml
1143
codeSamples.yaml
File diff suppressed because it is too large
Load Diff
@@ -1,10 +0,0 @@
|
|||||||
# 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 |
|
|
||||||
@@ -1,4 +1,4 @@
|
|||||||
# GetAllMediaLibraryBadRequest
|
# GetLibrarySectionsAllBadRequest
|
||||||
|
|
||||||
Bad Request - A parameter was not specified, or was specified incorrectly.
|
Bad Request - A parameter was not specified, or was specified incorrectly.
|
||||||
|
|
||||||
@@ -7,5 +7,5 @@ Bad Request - A parameter was not specified, or was specified incorrectly.
|
|||||||
|
|
||||||
| Field | Type | Required | Description |
|
| Field | Type | Required | Description |
|
||||||
| ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ |
|
| ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ |
|
||||||
| `errors` | List\<[GetAllMediaLibraryErrors](../../models/errors/GetAllMediaLibraryErrors.md)> | :heavy_minus_sign: | N/A |
|
| `errors` | List\<[GetLibrarySectionsAllErrors](../../models/errors/GetLibrarySectionsAllErrors.md)> | :heavy_minus_sign: | N/A |
|
||||||
| `rawResponse` | [HttpResponse\<InputStream>](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
| `rawResponse` | [HttpResponse\<InputStream>](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
||||||
@@ -1,4 +1,4 @@
|
|||||||
# GetOnDeckErrors
|
# GetLibrarySectionsAllErrors
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
@@ -1,4 +1,4 @@
|
|||||||
# GetAllMediaLibraryLibraryErrors
|
# GetLibrarySectionsAllLibraryErrors
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
@@ -1,4 +1,4 @@
|
|||||||
# GetOnDeckUnauthorized
|
# GetLibrarySectionsAllUnauthorized
|
||||||
|
|
||||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||||
|
|
||||||
@@ -7,5 +7,5 @@ Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
|||||||
|
|
||||||
| Field | Type | Required | Description |
|
| Field | Type | Required | Description |
|
||||||
| ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ |
|
| ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ |
|
||||||
| `errors` | List\<[GetOnDeckLibraryErrors](../../models/errors/GetOnDeckLibraryErrors.md)> | :heavy_minus_sign: | N/A |
|
| `errors` | List\<[GetLibrarySectionsAllLibraryErrors](../../models/errors/GetLibrarySectionsAllLibraryErrors.md)> | :heavy_minus_sign: | N/A |
|
||||||
| `rawResponse` | [HttpResponse\<InputStream>](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
| `rawResponse` | [HttpResponse\<InputStream>](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
||||||
@@ -1,11 +0,0 @@
|
|||||||
# GetOnDeckBadRequest
|
|
||||||
|
|
||||||
Bad Request - A parameter was not specified, or was specified incorrectly.
|
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description |
|
|
||||||
| ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ |
|
|
||||||
| `errors` | List\<[GetOnDeckErrors](../../models/errors/GetOnDeckErrors.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 |
|
|
||||||
@@ -1,10 +0,0 @@
|
|||||||
# GetOnDeckLibraryErrors
|
|
||||||
|
|
||||||
|
|
||||||
## 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/Attributes.md
Normal file
11
docs/models/operations/Attributes.md
Normal file
@@ -0,0 +1,11 @@
|
|||||||
|
# Attributes
|
||||||
|
|
||||||
|
Attributes associated with the marker.
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| -------------------------------------------- | -------------------------------------------- | -------------------------------------------- | -------------------------------------------- | -------------------------------------------- |
|
||||||
|
| `id` | *long* | :heavy_check_mark: | The identifier for the attributes. | 306970 |
|
||||||
|
| `version` | *Optional\<Long>* | :heavy_minus_sign: | The version number of the marker attributes. | 4 |
|
||||||
15
docs/models/operations/Chapter.md
Normal file
15
docs/models/operations/Chapter.md
Normal file
@@ -0,0 +1,15 @@
|
|||||||
|
# Chapter
|
||||||
|
|
||||||
|
The thumbnail for the chapter
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ |
|
||||||
|
| `id` | *long* | :heavy_check_mark: | N/A | 4 |
|
||||||
|
| `filter` | *String* | :heavy_check_mark: | N/A | thumb=4 |
|
||||||
|
| `index` | *long* | :heavy_check_mark: | N/A | 1 |
|
||||||
|
| `startTimeOffset` | *long* | :heavy_check_mark: | N/A | 0 |
|
||||||
|
| `endTimeOffset` | *long* | :heavy_check_mark: | N/A | 100100 |
|
||||||
|
| `thumb` | *String* | :heavy_check_mark: | N/A | /library/media/46883/chapterImages/1 |
|
||||||
@@ -3,6 +3,6 @@
|
|||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
| Field | Type | Required | Description | Example |
|
||||||
| ------------------- | ------------------- | ------------------- | ------------------- | ------------------- |
|
| --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- |
|
||||||
| `tag` | *Optional\<String>* | :heavy_minus_sign: | N/A | Working NL Subs |
|
| `tag` | *String* | :heavy_check_mark: | The user-made collection this media item belongs to | My Awesome Collection |
|
||||||
@@ -1,8 +1,12 @@
|
|||||||
# Country
|
# Country
|
||||||
|
|
||||||
|
The filter query string for country media items.
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
| Field | Type | Required | Description | Example |
|
||||||
| ------------------------ | ------------------------ | ------------------------ | ------------------------ | ------------------------ |
|
| ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- |
|
||||||
| `tag` | *Optional\<String>* | :heavy_minus_sign: | N/A | United States of America |
|
| `id` | *int* | :heavy_check_mark: | The unique identifier for the country.<br/>NOTE: This is different for each Plex server and is not globally unique.<br/> | 259 |
|
||||||
|
| `tag` | *String* | :heavy_check_mark: | The country of origin of this media item | United States of America |
|
||||||
|
| `filter` | *String* | :heavy_check_mark: | N/A | country=19 |
|
||||||
@@ -3,6 +3,10 @@
|
|||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
| Field | Type | Required | Description | Example |
|
||||||
| ------------------- | ------------------- | ------------------- | ------------------- | ------------------- |
|
| ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- |
|
||||||
| `tag` | *Optional\<String>* | :heavy_minus_sign: | N/A | James Cameron |
|
| `id` | *int* | :heavy_check_mark: | Unique identifier for the director. | 126522 |
|
||||||
|
| `filter` | *String* | :heavy_check_mark: | The filter string used to query this director. | director=235876 |
|
||||||
|
| `tag` | *String* | :heavy_check_mark: | The role of Director | Danny Boyle |
|
||||||
|
| `tagKey` | *String* | :heavy_check_mark: | A unique 24-character hexadecimal key associated with the director's tag, used for internal identification. | 5d776831151a60001f24d031 |
|
||||||
|
| `thumb` | *Optional\<String>* | :heavy_minus_sign: | The absolute URL of the thumbnail image for the director. | https://metadata-static.plex.tv/8/people/8d65fa96804802e08f2de09fe014408e.jpg |
|
||||||
@@ -1,11 +0,0 @@
|
|||||||
# EnableCreditsMarkerGeneration
|
|
||||||
|
|
||||||
Setting that indicates if credits markers detection is enabled. (-1 = Library default, 0 = Disabled).
|
|
||||||
|
|
||||||
|
|
||||||
## Values
|
|
||||||
|
|
||||||
| Name | Value |
|
|
||||||
| ---------------- | ---------------- |
|
|
||||||
| `LibraryDefault` | -1 |
|
|
||||||
| `Disabled` | 0 |
|
|
||||||
@@ -1,12 +0,0 @@
|
|||||||
# EpisodeSort
|
|
||||||
|
|
||||||
Setting that indicates how episodes are sorted for the show. (-1 = Library default, 0 = Oldest first, 1 = Newest first).
|
|
||||||
|
|
||||||
|
|
||||||
## Values
|
|
||||||
|
|
||||||
| Name | Value |
|
|
||||||
| ---------------- | ---------------- |
|
|
||||||
| `LibraryDefault` | -1 |
|
|
||||||
| `OldestFirst` | 0 |
|
|
||||||
| `NewestFirst` | 1 |
|
|
||||||
8
docs/models/operations/Extras.md
Normal file
8
docs/models/operations/Extras.md
Normal file
@@ -0,0 +1,8 @@
|
|||||||
|
# Extras
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ----------------------- | ----------------------- | ----------------------- | ----------------------- | ----------------------- |
|
||||||
|
| `size` | *Optional\<Long>* | :heavy_minus_sign: | The size of the extras. | 1 |
|
||||||
@@ -3,6 +3,7 @@
|
|||||||
Setting that indicates if seasons are set to hidden for the show. (-1 = Library default, 0 = Hide, 1 = Show).
|
Setting that indicates if seasons are set to hidden for the show. (-1 = Library default, 0 = Hide, 1 = Show).
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## Values
|
## Values
|
||||||
|
|
||||||
| Name | Value |
|
| Name | Value |
|
||||||
|
|||||||
@@ -1,8 +1,12 @@
|
|||||||
# Genre
|
# Genre
|
||||||
|
|
||||||
|
The filter query string for similar items.
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
| Field | Type | Required | Description | Example |
|
||||||
| ------------------- | ------------------- | ------------------- | ------------------- | ------------------- |
|
| -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- |
|
||||||
| `tag` | *Optional\<String>* | :heavy_minus_sign: | N/A | Adventure |
|
| `id` | *int* | :heavy_check_mark: | The unique identifier for the genre.<br/>NOTE: This is different for each Plex server and is not globally unique.<br/> | 259 |
|
||||||
|
| `filter` | *String* | :heavy_check_mark: | N/A | genre=19 |
|
||||||
|
| `tag` | *String* | :heavy_check_mark: | The genre name of this media-item<br/> | Crime |
|
||||||
@@ -16,5 +16,5 @@
|
|||||||
| `title1` | *String* | :heavy_check_mark: | The primary title of the media container. | TV Series |
|
| `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 |
|
| `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 |
|
| `viewGroup` | *String* | :heavy_check_mark: | Identifier for the view group layout. | secondary |
|
||||||
| `viewMode` | *String* | :heavy_check_mark: | Identifier for the view mode. | 131131 |
|
| `viewMode` | *Optional\<String>* | :heavy_minus_sign: | Identifier for the view mode. | 131131 |
|
||||||
| `directory` | List\<[GetActorsLibraryDirectory](../../models/operations/GetActorsLibraryDirectory.md)> | :heavy_minus_sign: | An array of actor entries for media items. | |
|
| `directory` | List\<[GetActorsLibraryDirectory](../../models/operations/GetActorsLibraryDirectory.md)> | :heavy_minus_sign: | An array of actor entries for media items. | |
|
||||||
@@ -11,12 +11,14 @@ E.g. A movie library will not return anything with type 3 as there are no season
|
|||||||
|
|
||||||
## Values
|
## Values
|
||||||
|
|
||||||
| Name | Value |
|
| Name | Value |
|
||||||
| --------- | --------- |
|
| ------------ | ------------ |
|
||||||
| `Movie` | 1 |
|
| `Movie` | 1 |
|
||||||
| `TvShow` | 2 |
|
| `TvShow` | 2 |
|
||||||
| `Season` | 3 |
|
| `Season` | 3 |
|
||||||
| `Episode` | 4 |
|
| `Episode` | 4 |
|
||||||
| `Audio` | 8 |
|
| `Artist` | 5 |
|
||||||
| `Album` | 9 |
|
| `Album` | 6 |
|
||||||
| `Track` | 10 |
|
| `Track` | 7 |
|
||||||
|
| `PhotoAlbum` | 8 |
|
||||||
|
| `Photo` | 9 |
|
||||||
@@ -3,26 +3,26 @@
|
|||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
| Field | Type | Required | Description | Example |
|
||||||
| ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ |
|
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
||||||
| `allowSync` | *boolean* | :heavy_check_mark: | N/A | true |
|
| `allowSync` | *boolean* | :heavy_check_mark: | Indicates whether syncing is allowed. | false |
|
||||||
| `art` | *String* | :heavy_check_mark: | N/A | /:/resources/movie-fanart.jpg |
|
| `art` | *String* | :heavy_check_mark: | URL for the background artwork of the media container. | /:/resources/show-fanart.jpg |
|
||||||
| `composite` | *String* | :heavy_check_mark: | N/A | /library/sections/1/composite/1705615584 |
|
| `composite` | *String* | :heavy_check_mark: | The relative path to the composite media item. | /library/sections/1/composite/1743824484 |
|
||||||
| `filters` | *boolean* | :heavy_check_mark: | N/A | true |
|
| `filters` | *boolean* | :heavy_check_mark: | UNKNOWN | true |
|
||||||
| `refreshing` | *boolean* | :heavy_check_mark: | N/A | false |
|
| `refreshing` | *boolean* | :heavy_check_mark: | Indicates whether the library is currently being refreshed or updated | true |
|
||||||
| `thumb` | *String* | :heavy_check_mark: | N/A | /:/resources/movie.png |
|
| `thumb` | *String* | :heavy_check_mark: | URL for the thumbnail image of the media container. | /:/resources/show.png |
|
||||||
| `key` | *String* | :heavy_check_mark: | N/A | 1 |
|
| `key` | *String* | :heavy_check_mark: | The library key representing the unique identifier | 1 |
|
||||||
| `type` | *String* | :heavy_check_mark: | N/A | movie |
|
| `type` | [GetAllLibrariesType](../../models/operations/GetAllLibrariesType.md) | :heavy_check_mark: | N/A | movie |
|
||||||
| `title` | *String* | :heavy_check_mark: | N/A | Movies |
|
| `title` | *String* | :heavy_check_mark: | The title of the library | Movies |
|
||||||
| `agent` | *String* | :heavy_check_mark: | N/A | tv.plex.agents.movie |
|
| `agent` | *String* | :heavy_check_mark: | The Plex agent used to match and retrieve media metadata. | tv.plex.agents.movie |
|
||||||
| `scanner` | *String* | :heavy_check_mark: | N/A | Plex Movie |
|
| `scanner` | *String* | :heavy_check_mark: | UNKNOWN | Plex Movie |
|
||||||
| `language` | *String* | :heavy_check_mark: | N/A | en-US |
|
| `language` | *String* | :heavy_check_mark: | The Plex library language that has been set | en-US |
|
||||||
| `uuid` | *String* | :heavy_check_mark: | N/A | 322a231a-b7f7-49f5-920f-14c61199cd30 |
|
| `uuid` | *String* | :heavy_check_mark: | The universally unique identifier for the library. | e69655a2-ef48-4aba-bb19-01e7d3cc34d6 |
|
||||||
| `updatedAt` | *long* | :heavy_check_mark: | Unix epoch datetime in seconds | 1556281940 |
|
| `updatedAt` | *long* | :heavy_check_mark: | Unix epoch datetime in seconds | 1556281940 |
|
||||||
| `createdAt` | *long* | :heavy_check_mark: | Unix epoch datetime in seconds | 1556281940 |
|
| `createdAt` | *Optional\<Long>* | :heavy_minus_sign: | N/A | 1556281940 |
|
||||||
| `scannedAt` | *long* | :heavy_check_mark: | Unix epoch datetime in seconds | 1556281940 |
|
| `scannedAt` | *long* | :heavy_check_mark: | Unix epoch datetime in seconds | 1556281940 |
|
||||||
| `content` | *boolean* | :heavy_check_mark: | N/A | true |
|
| `content` | *boolean* | :heavy_check_mark: | UNKNOWN | true |
|
||||||
| `directory` | *boolean* | :heavy_check_mark: | N/A | true |
|
| `directory` | *boolean* | :heavy_check_mark: | UNKNOWN | true |
|
||||||
| `contentChangedAt` | *long* | :heavy_check_mark: | Unix epoch datetime in seconds | 1556281940 |
|
| `contentChangedAt` | *long* | :heavy_check_mark: | Timestamp (in seconds) representing the last time the content was modified.<br/>NOTE: Some Plex server have some absurd values for this field, like 8457612157633039800 so it should be int64<br/> | 9173960 |
|
||||||
| `hidden` | *int* | :heavy_check_mark: | N/A | 0 |
|
| `hidden` | [Optional\<Hidden>](../../models/operations/Hidden.md) | :heavy_minus_sign: | The Plex library visibility setting | 1 |
|
||||||
| `location` | List\<[GetAllLibrariesLocation](../../models/operations/GetAllLibrariesLocation.md)> | :heavy_check_mark: | N/A | |
|
| `location` | List\<[GetAllLibrariesLocation](../../models/operations/GetAllLibrariesLocation.md)> | :heavy_check_mark: | N/A | |
|
||||||
@@ -3,7 +3,7 @@
|
|||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
| Field | Type | Required | Description | Example |
|
||||||
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
|
| --------------------------- | --------------------------- | --------------------------- | --------------------------- | --------------------------- |
|
||||||
| `id` | *int* | :heavy_check_mark: | N/A | 1 |
|
| `id` | *int* | :heavy_check_mark: | The ID of the location. | 1 |
|
||||||
| `path` | *String* | :heavy_check_mark: | N/A | /movies |
|
| `path` | *String* | :heavy_check_mark: | The path to the media item. | /Movies |
|
||||||
@@ -5,7 +5,7 @@
|
|||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
| Field | Type | Required | Description | Example |
|
||||||
| -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- |
|
| -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- |
|
||||||
| `size` | *int* | :heavy_check_mark: | N/A | 5 |
|
| `size` | *int* | :heavy_check_mark: | Number of media items returned in this response. | 50 |
|
||||||
| `allowSync` | *boolean* | :heavy_check_mark: | N/A | false |
|
| `allowSync` | *boolean* | :heavy_check_mark: | Indicates whether syncing is allowed. | false |
|
||||||
| `title1` | *String* | :heavy_check_mark: | N/A | Plex Library |
|
| `title1` | *String* | :heavy_check_mark: | The primary title of the media container. | TV Series |
|
||||||
| `directory` | List\<[GetAllLibrariesDirectory](../../models/operations/GetAllLibrariesDirectory.md)> | :heavy_check_mark: | N/A | |
|
| `directory` | List\<[GetAllLibrariesDirectory](../../models/operations/GetAllLibrariesDirectory.md)> | :heavy_minus_sign: | N/A | |
|
||||||
@@ -5,6 +5,6 @@ The libraries available on the Server
|
|||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
|
|
||||||
| Field | Type | Required | Description |
|
| Field | Type | Required | Description |
|
||||||
| ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- |
|
| ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- |
|
||||||
| `mediaContainer` | [GetAllLibrariesMediaContainer](../../models/operations/GetAllLibrariesMediaContainer.md) | :heavy_check_mark: | N/A |
|
| `mediaContainer` | [Optional\<GetAllLibrariesMediaContainer>](../../models/operations/GetAllLibrariesMediaContainer.md) | :heavy_minus_sign: | N/A |
|
||||||
19
docs/models/operations/GetAllLibrariesType.md
Normal file
19
docs/models/operations/GetAllLibrariesType.md
Normal file
@@ -0,0 +1,19 @@
|
|||||||
|
# GetAllLibrariesType
|
||||||
|
|
||||||
|
The library type
|
||||||
|
|
||||||
|
|
||||||
|
## Values
|
||||||
|
|
||||||
|
| Name | Value |
|
||||||
|
| ------------ | ------------ |
|
||||||
|
| `Movie` | movie |
|
||||||
|
| `TvShow` | show |
|
||||||
|
| `Season` | season |
|
||||||
|
| `Episode` | episode |
|
||||||
|
| `Artist` | artist |
|
||||||
|
| `Album` | album |
|
||||||
|
| `Track` | track |
|
||||||
|
| `PhotoAlbum` | photoalbum |
|
||||||
|
| `Photo` | photo |
|
||||||
|
| `Collection` | collection |
|
||||||
@@ -1,12 +0,0 @@
|
|||||||
# GetAllMediaLibraryDefaultDirection
|
|
||||||
|
|
||||||
The direction of the sort. Can be either `asc` or `desc`.
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## Values
|
|
||||||
|
|
||||||
| Name | Value |
|
|
||||||
| ------------ | ------------ |
|
|
||||||
| `Ascending` | asc |
|
|
||||||
| `Descending` | desc |
|
|
||||||
@@ -1,9 +0,0 @@
|
|||||||
# GetAllMediaLibraryFieldType
|
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
|
||||||
| ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ |
|
|
||||||
| `type` | *String* | :heavy_check_mark: | N/A | tag |
|
|
||||||
| `operator` | List\<[GetAllMediaLibraryOperator](../../models/operations/GetAllMediaLibraryOperator.md)> | :heavy_check_mark: | N/A | |
|
|
||||||
@@ -1,10 +0,0 @@
|
|||||||
# GetAllMediaLibraryImage
|
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
|
||||||
| --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- |
|
|
||||||
| `alt` | *String* | :heavy_check_mark: | N/A | Episode 1 |
|
|
||||||
| `type` | [GetAllMediaLibraryLibraryResponseType](../../models/operations/GetAllMediaLibraryLibraryResponseType.md) | :heavy_check_mark: | N/A | background |
|
|
||||||
| `url` | *String* | :heavy_check_mark: | N/A | /library/metadata/45521/thumb/1644710589 |
|
|
||||||
@@ -1,16 +0,0 @@
|
|||||||
# GetAllMediaLibraryLibraryType
|
|
||||||
|
|
||||||
The type of media content
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## Values
|
|
||||||
|
|
||||||
| Name | Value |
|
|
||||||
| --------- | --------- |
|
|
||||||
| `Movie` | movie |
|
|
||||||
| `TvShow` | show |
|
|
||||||
| `Season` | season |
|
|
||||||
| `Episode` | episode |
|
|
||||||
| `Artist` | artist |
|
|
||||||
| `Album` | album |
|
|
||||||
@@ -1,26 +0,0 @@
|
|||||||
# GetAllMediaLibraryMedia
|
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
|
||||||
| ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ |
|
|
||||||
| `id` | *long* | :heavy_check_mark: | Unique media identifier. | 387322 |
|
|
||||||
| `duration` | *Optional\<Integer>* | :heavy_minus_sign: | Duration of the media in milliseconds. | 9610350 |
|
|
||||||
| `bitrate` | *Optional\<Integer>* | :heavy_minus_sign: | Bitrate in bits per second. | 25512 |
|
|
||||||
| `width` | *Optional\<Integer>* | :heavy_minus_sign: | Video width in pixels. | 3840 |
|
|
||||||
| `height` | *Optional\<Integer>* | :heavy_minus_sign: | Video height in pixels. | 1602 |
|
|
||||||
| `aspectRatio` | *Optional\<Float>* | :heavy_minus_sign: | Aspect ratio of the video. | 2.35 |
|
|
||||||
| `audioChannels` | *Optional\<Integer>* | :heavy_minus_sign: | Number of audio channels. | 6 |
|
|
||||||
| `displayOffset` | *Optional\<Integer>* | :heavy_minus_sign: | N/A | 50 |
|
|
||||||
| `audioCodec` | *Optional\<String>* | :heavy_minus_sign: | Audio codec used. | eac3 |
|
|
||||||
| `videoCodec` | *Optional\<String>* | :heavy_minus_sign: | Video codec used. | hevc |
|
|
||||||
| `videoResolution` | *Optional\<String>* | :heavy_minus_sign: | Video resolution (e.g., 4k). | 4k |
|
|
||||||
| `container` | *Optional\<String>* | :heavy_minus_sign: | File container type. | mkv |
|
|
||||||
| `videoFrameRate` | *Optional\<String>* | :heavy_minus_sign: | Frame rate of the video. Values found include NTSC, PAL, 24p<br/> | 24p |
|
|
||||||
| `videoProfile` | *Optional\<String>* | :heavy_minus_sign: | Video profile (e.g., main 10). | main 10 |
|
|
||||||
| `hasVoiceActivity` | *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. | |
|
|
||||||
@@ -1,26 +0,0 @@
|
|||||||
# GetAllMediaLibraryMediaContainer
|
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
|
||||||
| ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- |
|
|
||||||
| `size` | *int* | :heavy_check_mark: | Number of media items returned in this response. | 50 |
|
|
||||||
| `totalSize` | *int* | :heavy_check_mark: | Total number of media items in the library. | 50 |
|
|
||||||
| `offset` | *long* | :heavy_check_mark: | Offset value for pagination. | 0 |
|
|
||||||
| `allowSync` | *boolean* | :heavy_check_mark: | Indicates whether syncing is allowed. | false |
|
|
||||||
| `art` | *String* | :heavy_check_mark: | URL for the background artwork of the media container. | /:/resources/show-fanart.jpg |
|
|
||||||
| `content` | *String* | :heavy_check_mark: | The content type or mode. | secondary |
|
|
||||||
| `identifier` | *String* | :heavy_check_mark: | An plugin identifier for the media container. | com.plexapp.plugins.library |
|
|
||||||
| `librarySectionID` | *long* | :heavy_check_mark: | The unique identifier for the library section. | 2 |
|
|
||||||
| `librarySectionTitle` | *String* | :heavy_check_mark: | The title of the library section. | TV Series |
|
|
||||||
| `librarySectionUUID` | *Optional\<String>* | :heavy_minus_sign: | The universally unique identifier for the library section. | e69655a2-ef48-4aba-bb19-0cc34d1e7d36 |
|
|
||||||
| `mediaTagPrefix` | *String* | :heavy_check_mark: | The prefix used for media tag resource paths. | /system/bundle/media/flags/ |
|
|
||||||
| `mediaTagVersion` | *long* | :heavy_check_mark: | The version number for media tags. | 1734362201 |
|
|
||||||
| `thumb` | *String* | :heavy_check_mark: | URL for the thumbnail image of the media container. | /:/resources/show.png |
|
|
||||||
| `nocache` | *boolean* | :heavy_check_mark: | Specifies whether caching is disabled. | true |
|
|
||||||
| `title1` | *String* | :heavy_check_mark: | The primary title of the media container. | TV Series |
|
|
||||||
| `title2` | *String* | :heavy_check_mark: | The secondary title of the media container. | By Starring Actor |
|
|
||||||
| `viewGroup` | *String* | :heavy_check_mark: | Identifier for the view group layout. | secondary |
|
|
||||||
| `meta` | [Optional\<GetAllMediaLibraryMeta>](../../models/operations/GetAllMediaLibraryMeta.md) | :heavy_minus_sign: | The Meta object is only included in the response if the `includeMeta` parameter is set to `1`.<br/> | |
|
|
||||||
| `metadata` | List\<[GetAllMediaLibraryMetadata](../../models/operations/GetAllMediaLibraryMetadata.md)> | :heavy_minus_sign: | An array of metadata items. | |
|
|
||||||
@@ -1,12 +0,0 @@
|
|||||||
# GetAllMediaLibraryMeta
|
|
||||||
|
|
||||||
The Meta object is only included in the response if the `includeMeta` parameter is set to `1`.
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description |
|
|
||||||
| -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- |
|
|
||||||
| `type` | List\<[GetAllMediaLibraryType](../../models/operations/GetAllMediaLibraryType.md)> | :heavy_minus_sign: | N/A |
|
|
||||||
| `fieldType` | List\<[GetAllMediaLibraryFieldType](../../models/operations/GetAllMediaLibraryFieldType.md)> | :heavy_minus_sign: | N/A |
|
|
||||||
@@ -1,23 +0,0 @@
|
|||||||
# GetAllMediaLibraryPart
|
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
|
||||||
| -------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- |
|
|
||||||
| `accessible` | *Optional\<Boolean>* | :heavy_minus_sign: | Indicates if the part is accessible. | true |
|
|
||||||
| `exists` | *Optional\<Boolean>* | :heavy_minus_sign: | Indicates if the part exists. | true |
|
|
||||||
| `id` | *long* | :heavy_check_mark: | Unique part identifier. | 418385 |
|
|
||||||
| `key` | *String* | :heavy_check_mark: | Key to access this part. | /library/parts/418385/1735864239/file.mkv |
|
|
||||||
| `indexes` | *Optional\<String>* | :heavy_minus_sign: | N/A | sd |
|
|
||||||
| `duration` | *Optional\<Integer>* | :heavy_minus_sign: | Duration of the part in milliseconds. | 9610350 |
|
|
||||||
| `file` | *String* | :heavy_check_mark: | File path for the part. | /mnt/Movies_1/W/Wicked (2024).mkv |
|
|
||||||
| `size` | *long* | :heavy_check_mark: | File size in bytes. | 30649952104 |
|
|
||||||
| `packetLength` | *Optional\<Integer>* | :heavy_minus_sign: | N/A | 188 |
|
|
||||||
| `container` | *Optional\<String>* | :heavy_minus_sign: | Container format of the part. | mkv |
|
|
||||||
| `videoProfile` | *Optional\<String>* | :heavy_minus_sign: | Video profile for the part. | main 10 |
|
|
||||||
| `audioProfile` | *Optional\<String>* | :heavy_minus_sign: | The audio profile used for the media (e.g., DTS, Dolby Digital, etc.). | dts |
|
|
||||||
| `has64bitOffsets` | *Optional\<Boolean>* | :heavy_minus_sign: | N/A | false |
|
|
||||||
| `optimizedForStreaming` | [Optional\<GetAllMediaLibraryLibraryOptimizedForStreaming>](../../models/operations/GetAllMediaLibraryLibraryOptimizedForStreaming.md) | :heavy_minus_sign: | Has this media been optimized for streaming. NOTE: This can be 0, 1, false or true | |
|
|
||||||
| `hasThumbnail` | [Optional\<GetAllMediaLibraryHasThumbnail>](../../models/operations/GetAllMediaLibraryHasThumbnail.md) | :heavy_minus_sign: | N/A | 1 |
|
|
||||||
| `stream` | List\<[GetAllMediaLibraryStream](../../models/operations/GetAllMediaLibraryStream.md)> | :heavy_minus_sign: | An array of streams for this part. | |
|
|
||||||
@@ -1,22 +0,0 @@
|
|||||||
# GetAllMediaLibraryQueryParamType
|
|
||||||
|
|
||||||
The type of media to retrieve or filter by.
|
|
||||||
1 = movie
|
|
||||||
2 = show
|
|
||||||
3 = season
|
|
||||||
4 = episode
|
|
||||||
E.g. A movie library will not return anything with type 3 as there are no seasons for movie libraries
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## Values
|
|
||||||
|
|
||||||
| Name | Value |
|
|
||||||
| --------- | --------- |
|
|
||||||
| `Movie` | 1 |
|
|
||||||
| `TvShow` | 2 |
|
|
||||||
| `Season` | 3 |
|
|
||||||
| `Episode` | 4 |
|
|
||||||
| `Audio` | 8 |
|
|
||||||
| `Album` | 9 |
|
|
||||||
| `Track` | 10 |
|
|
||||||
@@ -1,10 +0,0 @@
|
|||||||
# GetAllMediaLibraryResponseBody
|
|
||||||
|
|
||||||
Successful response containing media container data.
|
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description |
|
|
||||||
| ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- |
|
|
||||||
| `mediaContainer` | [Optional\<GetAllMediaLibraryMediaContainer>](../../models/operations/GetAllMediaLibraryMediaContainer.md) | :heavy_minus_sign: | N/A |
|
|
||||||
@@ -1,8 +0,0 @@
|
|||||||
# GetAllMediaLibraryRole
|
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
|
||||||
| ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- |
|
|
||||||
| `tag` | *String* | :heavy_check_mark: | The name of the actor for this role | Danny Boyle |
|
|
||||||
@@ -1,15 +0,0 @@
|
|||||||
# GetAllMediaLibrarySort
|
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
|
||||||
| -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- |
|
|
||||||
| `default_` | *Optional\<String>* | :heavy_minus_sign: | N/A | asc |
|
|
||||||
| `active` | *Optional\<Boolean>* | :heavy_minus_sign: | N/A | false |
|
|
||||||
| `activeDirection` | [Optional\<GetAllMediaLibraryActiveDirection>](../../models/operations/GetAllMediaLibraryActiveDirection.md) | :heavy_minus_sign: | The direction of the sort. Can be either `asc` or `desc`.<br/> | asc |
|
|
||||||
| `defaultDirection` | [Optional\<GetAllMediaLibraryDefaultDirection>](../../models/operations/GetAllMediaLibraryDefaultDirection.md) | :heavy_minus_sign: | The direction of the sort. Can be either `asc` or `desc`.<br/> | asc |
|
|
||||||
| `descKey` | *Optional\<String>* | :heavy_minus_sign: | N/A | titleSort:desc |
|
|
||||||
| `firstCharacterKey` | *Optional\<String>* | :heavy_minus_sign: | N/A | /library/sections/2/firstCharacter |
|
|
||||||
| `key` | *String* | :heavy_check_mark: | N/A | titleSort |
|
|
||||||
| `title` | *String* | :heavy_check_mark: | N/A | Title |
|
|
||||||
@@ -1,15 +0,0 @@
|
|||||||
# GetAllMediaLibraryType
|
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
|
||||||
| -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- |
|
|
||||||
| `key` | *String* | :heavy_check_mark: | N/A | /library/sections/2/all?type=2 |
|
|
||||||
| `type` | *String* | :heavy_check_mark: | N/A | filter |
|
|
||||||
| `subtype` | *Optional\<String>* | :heavy_minus_sign: | N/A | clip |
|
|
||||||
| `title` | *String* | :heavy_check_mark: | N/A | TV Shows |
|
|
||||||
| `active` | *boolean* | :heavy_check_mark: | N/A | false |
|
|
||||||
| `filter` | List\<[GetAllMediaLibraryFilter](../../models/operations/GetAllMediaLibraryFilter.md)> | :heavy_minus_sign: | N/A | |
|
|
||||||
| `sort` | List\<[GetAllMediaLibrarySort](../../models/operations/GetAllMediaLibrarySort.md)> | :heavy_minus_sign: | N/A | |
|
|
||||||
| `field` | List\<[GetAllMediaLibraryField](../../models/operations/GetAllMediaLibraryField.md)> | :heavy_minus_sign: | N/A | |
|
|
||||||
@@ -11,12 +11,14 @@ E.g. A movie library will not return anything with type 3 as there are no season
|
|||||||
|
|
||||||
## Values
|
## Values
|
||||||
|
|
||||||
| Name | Value |
|
| Name | Value |
|
||||||
| --------- | --------- |
|
| ------------ | ------------ |
|
||||||
| `Movie` | 1 |
|
| `Movie` | 1 |
|
||||||
| `TvShow` | 2 |
|
| `TvShow` | 2 |
|
||||||
| `Season` | 3 |
|
| `Season` | 3 |
|
||||||
| `Episode` | 4 |
|
| `Episode` | 4 |
|
||||||
| `Audio` | 8 |
|
| `Artist` | 5 |
|
||||||
| `Album` | 9 |
|
| `Album` | 6 |
|
||||||
| `Track` | 10 |
|
| `Track` | 7 |
|
||||||
|
| `PhotoAlbum` | 8 |
|
||||||
|
| `Photo` | 9 |
|
||||||
@@ -11,12 +11,14 @@ E.g. A movie library will not return anything with type 3 as there are no season
|
|||||||
|
|
||||||
## Values
|
## Values
|
||||||
|
|
||||||
| Name | Value |
|
| Name | Value |
|
||||||
| --------- | --------- |
|
| ------------ | ------------ |
|
||||||
| `Movie` | 1 |
|
| `Movie` | 1 |
|
||||||
| `TvShow` | 2 |
|
| `TvShow` | 2 |
|
||||||
| `Season` | 3 |
|
| `Season` | 3 |
|
||||||
| `Episode` | 4 |
|
| `Episode` | 4 |
|
||||||
| `Audio` | 8 |
|
| `Artist` | 5 |
|
||||||
| `Album` | 9 |
|
| `Album` | 6 |
|
||||||
| `Track` | 10 |
|
| `Track` | 7 |
|
||||||
|
| `PhotoAlbum` | 8 |
|
||||||
|
| `Photo` | 9 |
|
||||||
@@ -3,7 +3,7 @@
|
|||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
| Field | Type | Required | Description | Example |
|
||||||
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||||
| `includeDetails` | [Optional\<IncludeDetails>](../../models/operations/IncludeDetails.md) | :heavy_minus_sign: | Whether or not to include details for a section (types, filters, and sorts). <br/>Only exists for backwards compatibility, media providers other than the server libraries have it on always.<br/> | |
|
| `includeDetails` | [Optional\<IncludeDetails>](../../models/operations/IncludeDetails.md) | :heavy_minus_sign: | Whether or not to include details for a section (types, filters, and sorts).<br/>Only exists for backwards compatibility, media providers other than the server libraries have it on always.<br/> | |
|
||||||
| `sectionKey` | *int* | :heavy_check_mark: | The unique key of the Plex library. <br/>Note: This is unique in the context of the Plex server.<br/> | 9518 |
|
| `sectionKey` | *int* | :heavy_check_mark: | The unique key of the Plex library. <br/>Note: This is unique in the context of the Plex server.<br/> | 9518 |
|
||||||
@@ -3,6 +3,6 @@
|
|||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
| Field | Type | Required | Description | Example |
|
||||||
| ------------------- | ------------------- | ------------------- | ------------------- | ------------------- |
|
| --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- |
|
||||||
| `tag` | *Optional\<String>* | :heavy_minus_sign: | N/A | Working NL Subs |
|
| `tag` | *String* | :heavy_check_mark: | The user-made collection this media item belongs to | My Awesome Collection |
|
||||||
@@ -3,6 +3,7 @@
|
|||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
| Field | Type | Required | Description | Example |
|
||||||
| ------------------------ | ------------------------ | ------------------------ | ------------------------ | ------------------------ |
|
| ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- |
|
||||||
| `tag` | *Optional\<String>* | :heavy_minus_sign: | N/A | United States of America |
|
| `id` | *int* | :heavy_check_mark: | The unique identifier for the country.<br/>NOTE: This is different for each Plex server and is not globally unique.<br/> | 259 |
|
||||||
|
| `tag` | *String* | :heavy_check_mark: | The country of origin of this media item | United States of America |
|
||||||
@@ -3,6 +3,8 @@
|
|||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
| Field | Type | Required | Description | Example |
|
||||||
| ------------------- | ------------------- | ------------------- | ------------------- | ------------------- |
|
| ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- |
|
||||||
| `tag` | *Optional\<String>* | :heavy_minus_sign: | N/A | James Cameron |
|
| `id` | *int* | :heavy_check_mark: | Unique identifier for the director. | 126522 |
|
||||||
|
| `tag` | *String* | :heavy_check_mark: | The role of Director | Danny Boyle |
|
||||||
|
| `thumb` | *Optional\<String>* | :heavy_minus_sign: | The absolute URL of the thumbnail image for the director. | https://metadata-static.plex.tv/8/people/8d65fa96804802e08f2de09fe014408e.jpg |
|
||||||
@@ -1,11 +0,0 @@
|
|||||||
# GetLibraryItemsEnableCreditsMarkerGeneration
|
|
||||||
|
|
||||||
Setting that indicates if credits markers detection is enabled. (-1 = Library default, 0 = Disabled).
|
|
||||||
|
|
||||||
|
|
||||||
## Values
|
|
||||||
|
|
||||||
| Name | Value |
|
|
||||||
| ---------------- | ---------------- |
|
|
||||||
| `LibraryDefault` | -1 |
|
|
||||||
| `Disabled` | 0 |
|
|
||||||
@@ -1,12 +0,0 @@
|
|||||||
# GetLibraryItemsEpisodeSort
|
|
||||||
|
|
||||||
Setting that indicates how episodes are sorted for the show. (-1 = Library default, 0 = Oldest first, 1 = Newest first).
|
|
||||||
|
|
||||||
|
|
||||||
## Values
|
|
||||||
|
|
||||||
| Name | Value |
|
|
||||||
| ---------------- | ---------------- |
|
|
||||||
| `LibraryDefault` | -1 |
|
|
||||||
| `OldestFirst` | 0 |
|
|
||||||
| `NewestFirst` | 1 |
|
|
||||||
@@ -10,4 +10,3 @@
|
|||||||
| `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 |
|
|
||||||
@@ -1,12 +0,0 @@
|
|||||||
# GetLibraryItemsFlattenSeasons
|
|
||||||
|
|
||||||
Setting that indicates if seasons are set to hidden for the show. (-1 = Library default, 0 = Hide, 1 = Show).
|
|
||||||
|
|
||||||
|
|
||||||
## Values
|
|
||||||
|
|
||||||
| Name | Value |
|
|
||||||
| ---------------- | ---------------- |
|
|
||||||
| `LibraryDefault` | -1 |
|
|
||||||
| `Hide` | 0 |
|
|
||||||
| `Show` | 1 |
|
|
||||||
@@ -3,6 +3,7 @@
|
|||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
| Field | Type | Required | Description | Example |
|
||||||
| ------------------- | ------------------- | ------------------- | ------------------- | ------------------- |
|
| -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- |
|
||||||
| `tag` | *Optional\<String>* | :heavy_minus_sign: | N/A | Adventure |
|
| `id` | *int* | :heavy_check_mark: | The unique identifier for the genre.<br/>NOTE: This is different for each Plex server and is not globally unique.<br/> | 259 |
|
||||||
|
| `tag` | *String* | :heavy_check_mark: | The genre name of this media-item<br/> | Crime |
|
||||||
8
docs/models/operations/GetLibraryItemsGuids.md
Normal file
8
docs/models/operations/GetLibraryItemsGuids.md
Normal file
@@ -0,0 +1,8 @@
|
|||||||
|
# GetLibraryItemsGuids
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||||
|
| `id` | *String* | :heavy_check_mark: | The unique identifier for the Guid. Can be prefixed with imdb://, tmdb://, tvdb://<br/> | {<br/>"imdbExample": {<br/>"summary": "IMDB example",<br/>"value": "imdb://tt13015952"<br/>},<br/>"tmdbExample": {<br/>"summary": "TMDB example",<br/>"value": "tmdb://2434012"<br/>},<br/>"tvdbExample": {<br/>"summary": "TVDB example",<br/>"value": "tvdb://7945991"<br/>}<br/>} |
|
||||||
@@ -1,5 +1,8 @@
|
|||||||
# GetLibraryItemsHasThumbnail
|
# GetLibraryItemsHasThumbnail
|
||||||
|
|
||||||
|
Indicates if the part has a thumbnail.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## Values
|
## Values
|
||||||
|
|
||||||
|
|||||||
@@ -3,8 +3,8 @@
|
|||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
| Field | Type | Required | Description | Example |
|
||||||
| --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- |
|
| --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- |
|
||||||
| `alt` | *String* | :heavy_check_mark: | N/A | Episode 1 |
|
| `alt` | *String* | :heavy_check_mark: | N/A | Episode 1 |
|
||||||
| `type` | [GetLibraryItemsLibraryResponse200Type](../../models/operations/GetLibraryItemsLibraryResponse200Type.md) | :heavy_check_mark: | N/A | background |
|
| `type` | [GetLibraryItemsLibraryResponseType](../../models/operations/GetLibraryItemsLibraryResponseType.md) | :heavy_check_mark: | N/A | background |
|
||||||
| `url` | *String* | :heavy_check_mark: | N/A | /library/metadata/45521/thumb/1644710589 |
|
| `url` | *String* | :heavy_check_mark: | N/A | /library/metadata/45521/thumb/1644710589 |
|
||||||
@@ -1,12 +0,0 @@
|
|||||||
# GetLibraryItemsLibraryDefaultDirection
|
|
||||||
|
|
||||||
The direction of the sort. Can be either `asc` or `desc`.
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## Values
|
|
||||||
|
|
||||||
| Name | Value |
|
|
||||||
| ------------ | ------------ |
|
|
||||||
| `Ascending` | asc |
|
|
||||||
| `Descending` | desc |
|
|
||||||
@@ -1,11 +0,0 @@
|
|||||||
# GetLibraryItemsLibraryField
|
|
||||||
|
|
||||||
|
|
||||||
## 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 |
|
|
||||||
@@ -1,12 +0,0 @@
|
|||||||
# GetLibraryItemsLibraryFilter
|
|
||||||
|
|
||||||
|
|
||||||
## 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 |
|
|
||||||
@@ -1,9 +0,0 @@
|
|||||||
# GetLibraryItemsLibraryOperator
|
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
|
||||||
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
|
|
||||||
| `key` | *String* | :heavy_check_mark: | N/A | = |
|
|
||||||
| `title` | *String* | :heavy_check_mark: | N/A | is |
|
|
||||||
@@ -1,4 +1,5 @@
|
|||||||
# GetAllMediaLibraryLibraryOptimizedForStreaming
|
# GetLibraryItemsLibraryOptimizedForStreaming
|
||||||
|
|
||||||
Has this media been optimized for streaming. NOTE: This can be 0, 1, false or true
|
Has this media been optimized for streaming. NOTE: This can be 0, 1, false or true
|
||||||
|
|
||||||
|
|
||||||
@@ -1,14 +1,11 @@
|
|||||||
# GetLibraryItemsLibraryResponseType
|
# GetLibraryItemsLibraryResponseType
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
## Values
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
| Name | Value |
|
||||||
| ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- |
|
| -------------- | -------------- |
|
||||||
| `key` | *String* | :heavy_check_mark: | N/A | /library/sections/2/all?type=2 |
|
| `COVER_POSTER` | coverPoster |
|
||||||
| `type` | *String* | :heavy_check_mark: | N/A | show |
|
| `BACKGROUND` | background |
|
||||||
| `title` | *String* | :heavy_check_mark: | N/A | TV Shows |
|
| `SNAPSHOT` | snapshot |
|
||||||
| `active` | *boolean* | :heavy_check_mark: | N/A | false |
|
| `CLEAR_LOGO` | clearLogo |
|
||||||
| `filter` | List\<[GetLibraryItemsLibraryFilter](../../models/operations/GetLibraryItemsLibraryFilter.md)> | :heavy_minus_sign: | N/A | |
|
|
||||||
| `sort` | List\<[GetLibraryItemsLibrarySort](../../models/operations/GetLibraryItemsLibrarySort.md)> | :heavy_minus_sign: | N/A | |
|
|
||||||
| `field` | List\<[GetLibraryItemsLibraryField](../../models/operations/GetLibraryItemsLibraryField.md)> | :heavy_minus_sign: | N/A | |
|
|
||||||
@@ -1,15 +0,0 @@
|
|||||||
# GetLibraryItemsLibrarySort
|
|
||||||
|
|
||||||
|
|
||||||
## 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\<GetLibraryItemsLibraryActiveDirection>](../../models/operations/GetLibraryItemsLibraryActiveDirection.md) | :heavy_minus_sign: | The direction of the sort. Can be either `asc` or `desc`.<br/> | asc |
|
|
||||||
| `defaultDirection` | [Optional\<GetLibraryItemsLibraryDefaultDirection>](../../models/operations/GetLibraryItemsLibraryDefaultDirection.md) | :heavy_minus_sign: | The direction of the sort. Can be either `asc` or `desc`.<br/> | asc |
|
|
||||||
| `descKey` | *Optional\<String>* | :heavy_minus_sign: | N/A | titleSort:desc |
|
|
||||||
| `firstCharacterKey` | *Optional\<String>* | :heavy_minus_sign: | N/A | /library/sections/2/firstCharacter |
|
|
||||||
| `key` | *String* | :heavy_check_mark: | N/A | titleSort |
|
|
||||||
| `title` | *String* | :heavy_check_mark: | N/A | Title |
|
|
||||||
@@ -1,16 +1,14 @@
|
|||||||
# GetLibraryItemsLibraryType
|
# GetLibraryItemsLibraryType
|
||||||
|
|
||||||
The type of media content
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
## Values
|
| -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- |
|
||||||
|
| `key` | *String* | :heavy_check_mark: | N/A | /library/sections/2/all?type=2 |
|
||||||
| Name | Value |
|
| `type` | *String* | :heavy_check_mark: | N/A | show |
|
||||||
| --------- | --------- |
|
| `title` | *String* | :heavy_check_mark: | N/A | TV Shows |
|
||||||
| `Movie` | movie |
|
| `active` | *boolean* | :heavy_check_mark: | N/A | false |
|
||||||
| `TvShow` | show |
|
| `filter` | List\<[GetLibraryItemsFilter](../../models/operations/GetLibraryItemsFilter.md)> | :heavy_minus_sign: | N/A | |
|
||||||
| `Season` | season |
|
| `sort` | List\<[GetLibraryItemsSort](../../models/operations/GetLibraryItemsSort.md)> | :heavy_minus_sign: | N/A | |
|
||||||
| `Episode` | episode |
|
| `field` | List\<[GetLibraryItemsField](../../models/operations/GetLibraryItemsField.md)> | :heavy_minus_sign: | N/A | |
|
||||||
| `Artist` | artist |
|
|
||||||
| `Album` | album |
|
|
||||||
@@ -1,8 +1,10 @@
|
|||||||
# GetLibraryItemsLocation
|
# GetLibraryItemsLocation
|
||||||
|
|
||||||
|
The folder path for the media item.
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
| Field | Type | Required | Description | Example |
|
||||||
| ------------------- | ------------------- | ------------------- | ------------------- | ------------------- |
|
| ------------------------- | ------------------------- | ------------------------- | ------------------------- | ------------------------- |
|
||||||
| `path` | *Optional\<String>* | :heavy_minus_sign: | N/A | /TV Shows/House |
|
| `path` | *String* | :heavy_check_mark: | N/A | /TV Shows/Clarkson's Farm |
|
||||||
@@ -3,23 +3,24 @@
|
|||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
| Field | Type | Required | Description | Example |
|
||||||
| ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ |
|
| -------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||||
| `id` | *int* | :heavy_check_mark: | N/A | 119534 |
|
| `id` | *long* | :heavy_check_mark: | Unique media identifier. | 387322 |
|
||||||
| `duration` | *Optional\<Integer>* | :heavy_minus_sign: | N/A | 11558112 |
|
| `duration` | *Optional\<Integer>* | :heavy_minus_sign: | Duration of the media in milliseconds. | 9610350 |
|
||||||
| `bitrate` | *Optional\<Integer>* | :heavy_minus_sign: | N/A | 25025 |
|
| `bitrate` | *Optional\<Integer>* | :heavy_minus_sign: | Bitrate in bits per second. | 25512 |
|
||||||
| `width` | *Optional\<Integer>* | :heavy_minus_sign: | N/A | 3840 |
|
| `width` | *Optional\<Integer>* | :heavy_minus_sign: | Video width in pixels. | 3840 |
|
||||||
| `height` | *Optional\<Integer>* | :heavy_minus_sign: | N/A | 2072 |
|
| `height` | *Optional\<Integer>* | :heavy_minus_sign: | Video height in pixels. | 1602 |
|
||||||
| `aspectRatio` | *Optional\<Double>* | :heavy_minus_sign: | N/A | 1.85 |
|
| `aspectRatio` | *Optional\<Float>* | :heavy_minus_sign: | Aspect ratio of the video. | 2.35 |
|
||||||
| `audioProfile` | *Optional\<String>* | :heavy_minus_sign: | N/A | dts |
|
| `audioChannels` | *Optional\<Integer>* | :heavy_minus_sign: | Number of audio channels. | 6 |
|
||||||
| `audioChannels` | *Optional\<Integer>* | :heavy_minus_sign: | N/A | 6 |
|
| `displayOffset` | *Optional\<Integer>* | :heavy_minus_sign: | N/A | 50 |
|
||||||
| `audioCodec` | *Optional\<String>* | :heavy_minus_sign: | N/A | eac3 |
|
| `audioCodec` | *Optional\<String>* | :heavy_minus_sign: | Audio codec used. | aac |
|
||||||
| `videoCodec` | *Optional\<String>* | :heavy_minus_sign: | N/A | hevc |
|
| `videoCodec` | *Optional\<String>* | :heavy_minus_sign: | Video codec used. | hevc |
|
||||||
| `videoResolution` | *Optional\<String>* | :heavy_minus_sign: | N/A | 4k |
|
| `videoResolution` | *Optional\<String>* | :heavy_minus_sign: | Video resolution (e.g., 4k). | 4k |
|
||||||
| `container` | *String* | :heavy_check_mark: | N/A | mkv |
|
| `container` | *Optional\<String>* | :heavy_minus_sign: | Container format of the media. | mp4 |
|
||||||
| `videoFrameRate` | *Optional\<String>* | :heavy_minus_sign: | N/A | 24p |
|
| `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: | N/A | main 10 |
|
| `videoProfile` | *Optional\<String>* | :heavy_minus_sign: | Video profile (e.g., main 10). | main 10 |
|
||||||
| `hasVoiceActivity` | *Optional\<Boolean>* | :heavy_minus_sign: | N/A | false |
|
| `hasVoiceActivity` | *Optional\<Boolean>* | :heavy_minus_sign: | Indicates whether voice activity is detected. | false |
|
||||||
| `optimizedForStreaming` | [Optional\<GetLibraryItemsOptimizedForStreaming>](../../models/operations/GetLibraryItemsOptimizedForStreaming.md) | :heavy_minus_sign: | N/A | 1 |
|
| `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\<GetLibraryItemsOptimizedForStreaming>](../../models/operations/GetLibraryItemsOptimizedForStreaming.md) | :heavy_minus_sign: | Has this media been optimized for streaming. NOTE: This can be 0, 1, false or true | |
|
||||||
| `part` | List\<[GetLibraryItemsPart](../../models/operations/GetLibraryItemsPart.md)> | :heavy_check_mark: | N/A | |
|
| `has64bitOffsets` | *Optional\<Boolean>* | :heavy_minus_sign: | Indicates whether the media has 64-bit offsets.<br/>This is relevant for media files that may require larger offsets than what 32-bit integers can provide.<br/> | false |
|
||||||
|
| `part` | List\<[GetLibraryItemsPart](../../models/operations/GetLibraryItemsPart.md)> | :heavy_minus_sign: | N/A | |
|
||||||
@@ -1,33 +1,28 @@
|
|||||||
# GetLibraryItemsMediaContainer
|
# GetLibraryItemsMediaContainer
|
||||||
|
|
||||||
The Meta object is only included in the response if the `includeMeta` parameter is set to `1`.
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
| Field | Type | Required | Description | Example |
|
||||||
| ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- |
|
| ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- |
|
||||||
| `type` | List\<[GetLibraryItemsType](../../models/operations/GetLibraryItemsType.md)> | :heavy_minus_sign: | N/A | |
|
| `size` | *int* | :heavy_check_mark: | Number of media items returned in this response. | 50 |
|
||||||
| `fieldType` | List\<[GetLibraryItemsFieldType](../../models/operations/GetLibraryItemsFieldType.md)> | :heavy_minus_sign: | N/A | |
|
| `totalSize` | *int* | :heavy_check_mark: | Total number of media items in the library. | 50 |
|
||||||
| `size` | *int* | :heavy_check_mark: | N/A | 70 |
|
| `offset` | *long* | :heavy_check_mark: | Offset value for pagination. | 0 |
|
||||||
| `totalSize` | *int* | :heavy_check_mark: | N/A | 170 |
|
| `content` | *String* | :heavy_check_mark: | The content type or mode. | secondary |
|
||||||
| `offset` | *int* | :heavy_check_mark: | N/A | 0 |
|
| `allowSync` | *boolean* | :heavy_check_mark: | Indicates whether syncing is allowed. | false |
|
||||||
| `content` | *String* | :heavy_check_mark: | N/A | secondary |
|
| `nocache` | *boolean* | :heavy_check_mark: | Specifies whether caching is disabled. | true |
|
||||||
| `allowSync` | *boolean* | :heavy_check_mark: | N/A | true |
|
| `art` | *String* | :heavy_check_mark: | URL for the background artwork of the media container. | /:/resources/show-fanart.jpg |
|
||||||
| `nocache` | *Optional\<Boolean>* | :heavy_minus_sign: | N/A | true |
|
| `identifier` | *String* | :heavy_check_mark: | An plugin identifier for the media container. | com.plexapp.plugins.library |
|
||||||
| `art` | *String* | :heavy_check_mark: | N/A | /:/resources/movie-fanart.jpg |
|
| `librarySectionID` | *Optional\<Long>* | :heavy_minus_sign: | The unique identifier for the library section. | 2 |
|
||||||
| `identifier` | *String* | :heavy_check_mark: | N/A | com.plexapp.plugins.library |
|
| `librarySectionTitle` | *Optional\<String>* | :heavy_minus_sign: | The title of the library section. | TV Series |
|
||||||
| `librarySectionID` | *long* | :heavy_check_mark: | N/A | 1 |
|
| `librarySectionUUID` | *Optional\<String>* | :heavy_minus_sign: | The universally unique identifier for the library section. | e69655a2-ef48-4aba-bb19-0cc34d1e7d36 |
|
||||||
| `librarySectionTitle` | *String* | :heavy_check_mark: | N/A | Movies |
|
| `mediaTagPrefix` | *String* | :heavy_check_mark: | The prefix used for media tag resource paths. | /system/bundle/media/flags/ |
|
||||||
| `librarySectionUUID` | *String* | :heavy_check_mark: | N/A | 322a231a-b7f7-49f5-920f-14c61199cd30 |
|
| `mediaTagVersion` | *long* | :heavy_check_mark: | The version number for media tags. | 1734362201 |
|
||||||
| `mediaTagPrefix` | *String* | :heavy_check_mark: | N/A | /system/bundle/media/flags/ |
|
| `thumb` | *String* | :heavy_check_mark: | URL for the thumbnail image of the media container. | /:/resources/show.png |
|
||||||
| `mediaTagVersion` | *int* | :heavy_check_mark: | N/A | 1701731894 |
|
| `title1` | *String* | :heavy_check_mark: | The primary title of the media container. | TV Series |
|
||||||
| `thumb` | *String* | :heavy_check_mark: | N/A | /:/resources/movie.png |
|
| `title2` | *String* | :heavy_check_mark: | The secondary title of the media container. | By Starring Actor |
|
||||||
| `title1` | *String* | :heavy_check_mark: | N/A | Movies |
|
| `viewGroup` | *String* | :heavy_check_mark: | Identifier for the view group layout. | secondary |
|
||||||
| `title2` | *String* | :heavy_check_mark: | N/A | Recently Released |
|
| `viewMode` | *Optional\<String>* | :heavy_minus_sign: | Identifier for the view mode. | 131131 |
|
||||||
| `viewGroup` | *String* | :heavy_check_mark: | N/A | movie |
|
| `mixedParents` | *Optional\<Boolean>* | :heavy_minus_sign: | Indicates if the media container has mixed parents. | true |
|
||||||
| `viewMode` | *Optional\<Integer>* | :heavy_minus_sign: | N/A | 65592 |
|
| `metadata` | List\<[GetLibraryItemsMetadata](../../models/operations/GetLibraryItemsMetadata.md)> | :heavy_check_mark: | An array of metadata items. | |
|
||||||
| `mixedParents` | *Optional\<Boolean>* | :heavy_minus_sign: | N/A | true |
|
|
||||||
| `metadata` | List\<[GetLibraryItemsMetadata](../../models/operations/GetLibraryItemsMetadata.md)> | :heavy_minus_sign: | N/A | |
|
|
||||||
| `meta` | [Optional\<GetLibraryItemsMeta>](../../models/operations/GetLibraryItemsMeta.md) | :heavy_minus_sign: | The Meta object is only included in the response if the `includeMeta` parameter is set to `1`.<br/> | |
|
| `meta` | [Optional\<GetLibraryItemsMeta>](../../models/operations/GetLibraryItemsMeta.md) | :heavy_minus_sign: | The Meta object is only included in the response if the `includeMeta` parameter is set to `1`.<br/> | |
|
||||||
@@ -1,8 +0,0 @@
|
|||||||
# GetLibraryItemsMediaGuid
|
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
|
||||||
| --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- |
|
|
||||||
| `id` | *String* | :heavy_check_mark: | Can be one of the following formats:<br/>imdb://tt13015952, tmdb://2434012, tvdb://7945991<br/> | imdb://tt13015952 |
|
|
||||||
@@ -6,7 +6,7 @@ The Meta object is only included in the response if the `includeMeta` parameter
|
|||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
|
|
||||||
| Field | Type | Required | Description |
|
| Field | Type | Required | Description |
|
||||||
| ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- |
|
| ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ |
|
||||||
| `type` | List\<[GetLibraryItemsLibraryResponseType](../../models/operations/GetLibraryItemsLibraryResponseType.md)> | :heavy_minus_sign: | N/A |
|
| `type` | List\<[GetLibraryItemsLibraryType](../../models/operations/GetLibraryItemsLibraryType.md)> | :heavy_minus_sign: | N/A |
|
||||||
| `fieldType` | List\<[GetLibraryItemsLibraryFieldType](../../models/operations/GetLibraryItemsLibraryFieldType.md)> | :heavy_minus_sign: | N/A |
|
| `fieldType` | List\<[GetLibraryItemsFieldType](../../models/operations/GetLibraryItemsFieldType.md)> | :heavy_minus_sign: | N/A |
|
||||||
@@ -1,10 +0,0 @@
|
|||||||
# GetLibraryItemsMetaDataRating
|
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
|
||||||
| -------------------------------------------- | -------------------------------------------- | -------------------------------------------- | -------------------------------------------- | -------------------------------------------- |
|
|
||||||
| `image` | *String* | :heavy_check_mark: | A URI or path to the rating image. | themoviedb://image.rating |
|
|
||||||
| `value` | *float* | :heavy_check_mark: | The value of the rating. | 3 |
|
|
||||||
| `type` | *String* | :heavy_check_mark: | The type of rating (e.g., audience, critic). | audience |
|
|
||||||
@@ -1,83 +1,88 @@
|
|||||||
# GetLibraryItemsMetadata
|
# GetLibraryItemsMetadata
|
||||||
|
|
||||||
|
Unknown
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
| Field | Type | Required | Description | Example |
|
||||||
| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||||
| `ratingKey` | *String* | :heavy_check_mark: | The rating key (Media ID) of this media item.<br/>Note: This is always an integer, but is represented as a string in the API.<br/> | 58683 |
|
| `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: | N/A | /library/metadata/58683 |
|
| `key` | *String* | :heavy_check_mark: | The unique key for the media item. | /library/metadata/58683 |
|
||||||
| `guid` | *String* | :heavy_check_mark: | N/A | plex://movie/5d7768ba96b655001fdc0408 |
|
| `guid` | *String* | :heavy_check_mark: | The globally unique identifier for the media item. | plex://movie/5d7768ba96b655001fdc0408 |
|
||||||
| `studio` | *Optional\<String>* | :heavy_minus_sign: | N/A | 20th Century Studios |
|
| `slug` | *String* | :heavy_check_mark: | A URL‐friendly version of the media title. | 4-for-texas |
|
||||||
| `skipChildren` | *Optional\<Boolean>* | :heavy_minus_sign: | N/A | false |
|
| `studio` | *Optional\<String>* | :heavy_minus_sign: | The studio that produced the media item. | 20th Century Studios |
|
||||||
| `librarySectionID` | *Optional\<Long>* | :heavy_minus_sign: | N/A | 1 |
|
| `type` | [GetLibraryItemsType](../../models/operations/GetLibraryItemsType.md) | :heavy_check_mark: | N/A | movie |
|
||||||
| `librarySectionTitle` | *Optional\<String>* | :heavy_minus_sign: | N/A | Movies |
|
| `title` | *String* | :heavy_check_mark: | The title of the media item. | Avatar: The Way of Water |
|
||||||
| `librarySectionKey` | *Optional\<String>* | :heavy_minus_sign: | N/A | /library/sections/1 |
|
| `banner` | *String* | :heavy_check_mark: | The banner image URL for the media item. | /library/metadata/58683/banner/1703239236 |
|
||||||
| `type` | [GetLibraryItemsLibraryType](../../models/operations/GetLibraryItemsLibraryType.md) | :heavy_check_mark: | The type of media content<br/> | movie |
|
| `titleSort` | *String* | :heavy_check_mark: | The sort title used for ordering media items. | Whale |
|
||||||
| `title` | *String* | :heavy_check_mark: | N/A | Avatar: The Way of Water |
|
| `contentRating` | *Optional\<String>* | :heavy_minus_sign: | The content rating for the media item. | PG-13 |
|
||||||
| `slug` | *Optional\<String>* | :heavy_minus_sign: | N/A | 4-for-texas |
|
| `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/> |
|
||||||
| `contentRating` | *Optional\<String>* | :heavy_minus_sign: | N/A | PG-13 |
|
| `rating` | *float* | :heavy_check_mark: | The critic rating for the media item. | 7.6 |
|
||||||
| `summary` | *String* | :heavy_check_mark: | N/A | Jake Sully lives with his newfound family formed on the extrasolar moon Pandora. Once a familiar threat returns to finish what was previously started, Jake must work with Neytiri and the army of the Na'vi race to protect their home. |
|
| `audienceRating` | *double* | :heavy_check_mark: | The audience rating for the media item. | 9.2 |
|
||||||
| `rating` | *Optional\<Double>* | :heavy_minus_sign: | N/A | 7.6 |
|
| `year` | *Optional\<Integer>* | :heavy_minus_sign: | The release year of the media item. | 2022 |
|
||||||
| `audienceRating` | *Optional\<Double>* | :heavy_minus_sign: | N/A | 9.2 |
|
| `tagline` | *String* | :heavy_check_mark: | A brief tagline for the media item. | Return to Pandora. |
|
||||||
| `year` | *Optional\<Integer>* | :heavy_minus_sign: | N/A | 2022 |
|
| `thumb` | *String* | :heavy_check_mark: | The thumbnail image URL for the media item. | /library/metadata/58683/thumb/1703239236 |
|
||||||
| `seasonCount` | *Optional\<Integer>* | :heavy_minus_sign: | N/A | 2022 |
|
| `art` | *String* | :heavy_check_mark: | The art image URL for the media item. | /library/metadata/58683/art/1703239236 |
|
||||||
| `tagline` | *Optional\<String>* | :heavy_minus_sign: | N/A | Return to Pandora. |
|
| `theme` | *String* | :heavy_check_mark: | The theme URL for the media item. | /library/metadata/1/theme/1705636920 |
|
||||||
| `flattenSeasons` | [Optional\<GetLibraryItemsFlattenSeasons>](../../models/operations/GetLibraryItemsFlattenSeasons.md) | :heavy_minus_sign: | Setting that indicates if seasons are set to hidden for the show. (-1 = Library default, 0 = Hide, 1 = Show). | 1 |
|
| `index` | *int* | :heavy_check_mark: | The index position of the media item. | 1 |
|
||||||
| `episodeSort` | [Optional\<GetLibraryItemsEpisodeSort>](../../models/operations/GetLibraryItemsEpisodeSort.md) | :heavy_minus_sign: | Setting that indicates how episodes are sorted for the show. (-1 = Library default, 0 = Oldest first, 1 = Newest first). | 0 |
|
| `leafCount` | *Optional\<Integer>* | :heavy_minus_sign: | The number of leaf items (end nodes) under this media item. | 14 |
|
||||||
| `enableCreditsMarkerGeneration` | [Optional\<GetLibraryItemsEnableCreditsMarkerGeneration>](../../models/operations/GetLibraryItemsEnableCreditsMarkerGeneration.md) | :heavy_minus_sign: | Setting that indicates if credits markers detection is enabled. (-1 = Library default, 0 = Disabled). | -1 |
|
| `viewedLeafCount` | *Optional\<Integer>* | :heavy_minus_sign: | The number of leaf items that have been viewed. | 0 |
|
||||||
| `showOrdering` | [Optional\<GetLibraryItemsShowOrdering>](../../models/operations/GetLibraryItemsShowOrdering.md) | :heavy_minus_sign: | Setting that indicates the episode ordering for the show.<br/>None = Library default,<br/>tmdbAiring = The Movie Database (Aired),<br/>aired = TheTVDB (Aired),<br/>dvd = TheTVDB (DVD),<br/>absolute = TheTVDB (Absolute)).<br/> | absolute |
|
| `childCount` | *int* | :heavy_check_mark: | The number of child items associated with this media item. | 1 |
|
||||||
| `thumb` | *Optional\<String>* | :heavy_minus_sign: | N/A | /library/metadata/58683/thumb/1703239236 |
|
| `seasonCount` | *int* | :heavy_check_mark: | The total number of seasons (for TV shows). | 2022 |
|
||||||
| `art` | *Optional\<String>* | :heavy_minus_sign: | N/A | /library/metadata/58683/art/1703239236 |
|
| `duration` | *int* | :heavy_check_mark: | The duration of the media item in milliseconds. | 11558112 |
|
||||||
| `banner` | *Optional\<String>* | :heavy_minus_sign: | N/A | /library/metadata/58683/banner/1703239236 |
|
| `originallyAvailableAt` | [LocalDate](https://docs.oracle.com/javase/8/docs/api/java/time/LocalDate.html) | :heavy_minus_sign: | The original release date of the media item. | 2022-12-14 |
|
||||||
| `duration` | *Optional\<Integer>* | :heavy_minus_sign: | N/A | 11558112 |
|
| `addedAt` | *long* | :heavy_check_mark: | N/A | 1556281940 |
|
||||||
| `originallyAvailableAt` | [LocalDate](https://docs.oracle.com/javase/8/docs/api/java/time/LocalDate.html) | :heavy_minus_sign: | N/A | 2022-12-14 00:00:00 +0000 UTC |
|
| `updatedAt` | *Optional\<Long>* | :heavy_minus_sign: | Unix epoch datetime in seconds | 1556281940 |
|
||||||
| `addedAt` | *long* | :heavy_check_mark: | Unix epoch datetime in seconds | 1556281940 |
|
| `audienceRatingImage` | *Optional\<String>* | :heavy_minus_sign: | The URL for the audience rating image. | rottentomatoes://image.rating.upright |
|
||||||
| `updatedAt` | *Optional\<Long>* | :heavy_minus_sign: | Unix epoch datetime in seconds | 1556281940 |
|
| `chapterSource` | *Optional\<String>* | :heavy_minus_sign: | The source from which chapter data is derived. | media |
|
||||||
| `audienceRatingImage` | *Optional\<String>* | :heavy_minus_sign: | N/A | rottentomatoes://image.rating.upright |
|
| `primaryExtraKey` | *Optional\<String>* | :heavy_minus_sign: | The primary extra key associated with this media item. | /library/metadata/58684 |
|
||||||
| `chapterSource` | *Optional\<String>* | :heavy_minus_sign: | N/A | media |
|
| `originalTitle` | *Optional\<String>* | :heavy_minus_sign: | The original title of the media item (if different). | 映画 ブラッククローバー 魔法帝の剣 |
|
||||||
| `primaryExtraKey` | *Optional\<String>* | :heavy_minus_sign: | N/A | /library/metadata/58684 |
|
| `parentRatingKey` | *Optional\<String>* | :heavy_minus_sign: | The rating key of the parent media item. | 66 |
|
||||||
| `ratingImage` | *Optional\<String>* | :heavy_minus_sign: | N/A | rottentomatoes://image.rating.ripe |
|
| `grandparentRatingKey` | *Optional\<String>* | :heavy_minus_sign: | The rating key of the grandparent media item. | 66 |
|
||||||
| `grandparentRatingKey` | *Optional\<String>* | :heavy_minus_sign: | N/A | 66 |
|
| `parentGuid` | *Optional\<String>* | :heavy_minus_sign: | The GUID of the parent media item. | plex://show/5d9c081b170e24001f2a7be4 |
|
||||||
| `grandparentGuid` | *Optional\<String>* | :heavy_minus_sign: | N/A | plex://show/5d9c081b170e24001f2a7be4 |
|
| `grandparentGuid` | *Optional\<String>* | :heavy_minus_sign: | The GUID of the grandparent media item. | plex://show/5d9c081b170e24001f2a7be4 |
|
||||||
| `grandparentKey` | *Optional\<String>* | :heavy_minus_sign: | N/A | /library/metadata/66 |
|
| `grandparentSlug` | *Optional\<String>* | :heavy_minus_sign: | The slug for the grandparent media item. | alice-in-borderland-2020 |
|
||||||
| `grandparentTitle` | *Optional\<String>* | :heavy_minus_sign: | N/A | Caprica |
|
| `grandparentKey` | *Optional\<String>* | :heavy_minus_sign: | The key of the grandparent media item. | /library/metadata/66 |
|
||||||
| `grandparentThumb` | *Optional\<String>* | :heavy_minus_sign: | N/A | /library/metadata/66/thumb/1705716261 |
|
| `parentKey` | *Optional\<String>* | :heavy_minus_sign: | The key of the parent media item. | /library/metadata/66 |
|
||||||
| `parentSlug` | *Optional\<String>* | :heavy_minus_sign: | N/A | alice-in-borderland-2020 |
|
| `grandparentTitle` | *Optional\<String>* | :heavy_minus_sign: | The title of the grandparent media item. | Caprica |
|
||||||
| `grandparentSlug` | *Optional\<String>* | :heavy_minus_sign: | N/A | alice-in-borderland-2020 |
|
| `grandparentThumb` | *Optional\<String>* | :heavy_minus_sign: | The thumbnail URL for the grandparent media item. | /library/metadata/66/thumb/1705716261 |
|
||||||
| `grandparentArt` | *Optional\<String>* | :heavy_minus_sign: | N/A | /library/metadata/66/art/1705716261 |
|
| `grandparentTheme` | *Optional\<String>* | :heavy_minus_sign: | The theme URL for the grandparent media item. | /library/metadata/66/theme/1705716261 |
|
||||||
| `grandparentTheme` | *Optional\<String>* | :heavy_minus_sign: | N/A | /library/metadata/66/theme/1705716261 |
|
| `grandparentArt` | *Optional\<String>* | :heavy_minus_sign: | The art URL for the grandparent media item. | /library/metadata/66/art/1705716261 |
|
||||||
| `media` | List\<[GetLibraryItemsMedia](../../models/operations/GetLibraryItemsMedia.md)> | :heavy_minus_sign: | The Media object is only included when type query is `4` or higher.<br/> | |
|
| `parentTitle` | *Optional\<String>* | :heavy_minus_sign: | The title of the parent media item. | Caprica |
|
||||||
| `genre` | List\<[GetLibraryItemsGenre](../../models/operations/GetLibraryItemsGenre.md)> | :heavy_minus_sign: | N/A | |
|
| `parentIndex` | *Optional\<Integer>* | :heavy_minus_sign: | The index position of the parent media item. | 1 |
|
||||||
| `country` | List\<[GetLibraryItemsCountry](../../models/operations/GetLibraryItemsCountry.md)> | :heavy_minus_sign: | N/A | |
|
| `parentThumb` | *Optional\<String>* | :heavy_minus_sign: | The thumbnail URL for the parent media item. | /library/metadata/66/thumb/1705716261 |
|
||||||
| `director` | List\<[GetLibraryItemsDirector](../../models/operations/GetLibraryItemsDirector.md)> | :heavy_minus_sign: | N/A | |
|
| `ratingImage` | *Optional\<String>* | :heavy_minus_sign: | The URL for the rating image. | rottentomatoes://image.rating.ripe |
|
||||||
| `writer` | List\<[GetLibraryItemsWriter](../../models/operations/GetLibraryItemsWriter.md)> | :heavy_minus_sign: | N/A | |
|
| `viewCount` | *Optional\<Integer>* | :heavy_minus_sign: | The number of times this media item has been viewed. | 1 |
|
||||||
| `collection` | List\<[GetLibraryItemsCollection](../../models/operations/GetLibraryItemsCollection.md)> | :heavy_minus_sign: | N/A | |
|
| `viewOffset` | *Optional\<Integer>* | :heavy_minus_sign: | The current playback offset (in milliseconds). | 5222500 |
|
||||||
| `role` | List\<[GetLibraryItemsRole](../../models/operations/GetLibraryItemsRole.md)> | :heavy_minus_sign: | N/A | |
|
| `skipCount` | *Optional\<Integer>* | :heavy_minus_sign: | The number of times this media item has been skipped. | 1 |
|
||||||
| `location` | List\<[GetLibraryItemsLocation](../../models/operations/GetLibraryItemsLocation.md)> | :heavy_minus_sign: | N/A | |
|
| `subtype` | *Optional\<String>* | :heavy_minus_sign: | A classification that further describes the type of media item. For example, 'clip' indicates that the item is a short video clip. | clip |
|
||||||
| `mediaGuid` | List\<[GetLibraryItemsMediaGuid](../../models/operations/GetLibraryItemsMediaGuid.md)> | :heavy_minus_sign: | The Guid object is only included in the response if the `includeGuids` parameter is set to `1`.<br/> | |
|
| `lastRatedAt` | *Optional\<Long>* | :heavy_minus_sign: | The Unix timestamp representing the last time the item was rated. | 1721813113 |
|
||||||
| `ultraBlurColors` | [Optional\<GetLibraryItemsUltraBlurColors>](../../models/operations/GetLibraryItemsUltraBlurColors.md) | :heavy_minus_sign: | N/A | |
|
| `createdAtAccuracy` | *Optional\<String>* | :heavy_minus_sign: | The accuracy of the creation timestamp. This value indicates the format(s) provided (for example, 'epoch,local' means both epoch and local time formats are available). | epoch,local |
|
||||||
| `metaDataRating` | List\<[GetLibraryItemsMetaDataRating](../../models/operations/GetLibraryItemsMetaDataRating.md)> | :heavy_minus_sign: | N/A | |
|
| `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 |
|
||||||
| `image` | List\<[GetLibraryItemsImage](../../models/operations/GetLibraryItemsImage.md)> | :heavy_minus_sign: | N/A | |
|
| `lastViewedAt` | *Optional\<Integer>* | :heavy_minus_sign: | Unix timestamp for when the media item was last viewed. | 1682752242 |
|
||||||
| `titleSort` | *Optional\<String>* | :heavy_minus_sign: | N/A | Whale |
|
| `userRating` | *Optional\<Float>* | :heavy_minus_sign: | The rating provided by a user for the item. This value is expressed as a decimal number. | 10 |
|
||||||
| `viewCount` | *Optional\<Integer>* | :heavy_minus_sign: | N/A | 1 |
|
| `image` | List\<[GetLibraryItemsImage](../../models/operations/GetLibraryItemsImage.md)> | :heavy_minus_sign: | N/A | |
|
||||||
| `lastViewedAt` | *Optional\<Integer>* | :heavy_minus_sign: | N/A | 1682752242 |
|
| `ultraBlurColors` | [Optional\<GetLibraryItemsUltraBlurColors>](../../models/operations/GetLibraryItemsUltraBlurColors.md) | :heavy_minus_sign: | N/A | |
|
||||||
| `originalTitle` | *Optional\<String>* | :heavy_minus_sign: | N/A | 映画 ブラッククローバー 魔法帝の剣 |
|
| `guids` | List\<[GetLibraryItemsGuids](../../models/operations/GetLibraryItemsGuids.md)> | :heavy_minus_sign: | N/A | |
|
||||||
| `viewOffset` | *Optional\<Integer>* | :heavy_minus_sign: | N/A | 5222500 |
|
| `librarySectionID` | *Optional\<Long>* | :heavy_minus_sign: | The identifier for the library section. | 1 |
|
||||||
| `skipCount` | *Optional\<Integer>* | :heavy_minus_sign: | N/A | 1 |
|
| `librarySectionTitle` | *Optional\<String>* | :heavy_minus_sign: | The title of the library section. | Movies |
|
||||||
| `index` | *Optional\<Integer>* | :heavy_minus_sign: | N/A | 1 |
|
| `librarySectionKey` | *Optional\<String>* | :heavy_minus_sign: | The key corresponding to the library section. | /library/sections/1 |
|
||||||
| `theme` | *Optional\<String>* | :heavy_minus_sign: | N/A | /library/metadata/1/theme/1705636920 |
|
| `showOrdering` | [Optional\<ShowOrdering>](../../models/operations/ShowOrdering.md) | :heavy_minus_sign: | Setting that indicates the episode ordering for the show.<br/>Options:<br/> - None = Library default<br/> - tmdbAiring = The Movie Database (Aired)<br/> - aired = TheTVDB (Aired)<br/> - dvd = TheTVDB (DVD)<br/> - absolute = TheTVDB (Absolute)<br/> | absolute |
|
||||||
| `leafCount` | *Optional\<Integer>* | :heavy_minus_sign: | N/A | 14 |
|
| `flattenSeasons` | [Optional\<FlattenSeasons>](../../models/operations/FlattenSeasons.md) | :heavy_minus_sign: | Setting that indicates if seasons are set to hidden for the show. (-1 = Library default, 0 = Hide, 1 = Show).<br/> | 1 |
|
||||||
| `viewedLeafCount` | *Optional\<Integer>* | :heavy_minus_sign: | N/A | 0 |
|
| `skipChildren` | *Optional\<Boolean>* | :heavy_minus_sign: | Indicates whether child items should be skipped. | false |
|
||||||
| `childCount` | *Optional\<Integer>* | :heavy_minus_sign: | N/A | 1 |
|
| `media` | List\<[GetLibraryItemsMedia](../../models/operations/GetLibraryItemsMedia.md)> | :heavy_minus_sign: | N/A | |
|
||||||
| `hasPremiumExtras` | *Optional\<String>* | :heavy_minus_sign: | N/A | 1 |
|
| `genre` | List\<[GetLibraryItemsGenre](../../models/operations/GetLibraryItemsGenre.md)> | :heavy_minus_sign: | N/A | |
|
||||||
| `hasPremiumPrimaryExtra` | *Optional\<String>* | :heavy_minus_sign: | N/A | 1 |
|
| `country` | List\<[GetLibraryItemsCountry](../../models/operations/GetLibraryItemsCountry.md)> | :heavy_minus_sign: | N/A | |
|
||||||
| `parentRatingKey` | *Optional\<String>* | :heavy_minus_sign: | The rating key of the parent item.<br/> | 66 |
|
| `director` | List\<[GetLibraryItemsDirector](../../models/operations/GetLibraryItemsDirector.md)> | :heavy_minus_sign: | N/A | |
|
||||||
| `parentGuid` | *Optional\<String>* | :heavy_minus_sign: | N/A | plex://show/5d9c081b170e24001f2a7be4 |
|
| `writer` | List\<[GetLibraryItemsWriter](../../models/operations/GetLibraryItemsWriter.md)> | :heavy_minus_sign: | N/A | |
|
||||||
| `parentStudio` | *Optional\<String>* | :heavy_minus_sign: | N/A | UCP |
|
| `producer` | List\<[GetLibraryItemsProducer](../../models/operations/GetLibraryItemsProducer.md)> | :heavy_minus_sign: | N/A | |
|
||||||
| `parentKey` | *Optional\<String>* | :heavy_minus_sign: | N/A | /library/metadata/66 |
|
| `collection` | List\<[GetLibraryItemsCollection](../../models/operations/GetLibraryItemsCollection.md)> | :heavy_minus_sign: | N/A | |
|
||||||
| `parentTitle` | *Optional\<String>* | :heavy_minus_sign: | N/A | Caprica |
|
| `role` | List\<[GetLibraryItemsRole](../../models/operations/GetLibraryItemsRole.md)> | :heavy_minus_sign: | N/A | |
|
||||||
| `parentIndex` | *Optional\<Integer>* | :heavy_minus_sign: | N/A | 1 |
|
| `ratings` | List\<[Ratings](../../models/operations/Ratings.md)> | :heavy_minus_sign: | N/A | |
|
||||||
| `parentYear` | *Optional\<Integer>* | :heavy_minus_sign: | N/A | 2010 |
|
| `similar` | List\<[GetLibraryItemsSimilar](../../models/operations/GetLibraryItemsSimilar.md)> | :heavy_minus_sign: | N/A | |
|
||||||
| `parentThumb` | *Optional\<String>* | :heavy_minus_sign: | N/A | /library/metadata/66/thumb/1705716261 |
|
| `location` | List\<[GetLibraryItemsLocation](../../models/operations/GetLibraryItemsLocation.md)> | :heavy_minus_sign: | N/A | |
|
||||||
| `parentTheme` | *Optional\<String>* | :heavy_minus_sign: | N/A | /library/metadata/66/theme/1705716261 |
|
| `chapter` | List\<[Chapter](../../models/operations/Chapter.md)> | :heavy_minus_sign: | N/A | |
|
||||||
|
| `marker` | List\<[Marker](../../models/operations/Marker.md)> | :heavy_minus_sign: | N/A | |
|
||||||
|
| `extras` | [Optional\<Extras>](../../models/operations/Extras.md) | :heavy_minus_sign: | N/A | |
|
||||||
@@ -1,9 +1,4 @@
|
|||||||
# GetLibraryItemsOptimizedForStreaming
|
# GetLibraryItemsOptimizedForStreaming
|
||||||
|
|
||||||
|
Has this media been optimized for streaming. NOTE: This can be 0, 1, false or true
|
||||||
|
|
||||||
## Values
|
|
||||||
|
|
||||||
| Name | Value |
|
|
||||||
| --------- | --------- |
|
|
||||||
| `Disable` | 0 |
|
|
||||||
| `Enable` | 1 |
|
|
||||||
@@ -1,4 +1,4 @@
|
|||||||
# GetAllMediaLibraryOptimizedForStreaming1
|
# GetLibraryItemsOptimizedForStreaming1
|
||||||
|
|
||||||
|
|
||||||
## Values
|
## Values
|
||||||
@@ -3,18 +3,20 @@
|
|||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
| Field | Type | Required | Description | Example |
|
||||||
| -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- |
|
| -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- |
|
||||||
| `id` | *int* | :heavy_check_mark: | N/A | 119542 |
|
| `accessible` | *Optional\<Boolean>* | :heavy_minus_sign: | Indicates if the part is accessible. | true |
|
||||||
| `key` | *String* | :heavy_check_mark: | N/A | /library/parts/119542/1680457526/file.mkv |
|
| `exists` | *Optional\<Boolean>* | :heavy_minus_sign: | Indicates if the part exists. | true |
|
||||||
| `duration` | *Optional\<Integer>* | :heavy_minus_sign: | N/A | 11558112 |
|
| `id` | *long* | :heavy_check_mark: | Unique part identifier. | 418385 |
|
||||||
| `file` | *String* | :heavy_check_mark: | N/A | /movies/Avatar The Way of Water (2022)/Avatar.The.Way.of.Water.2022.2160p.WEB-DL.DDP5.1.Atmos.DV.HDR10.HEVC-CMRG.mkv |
|
| `key` | *Optional\<String>* | :heavy_minus_sign: | Key to access this part. | /library/parts/418385/1735864239/file.mkv |
|
||||||
| `size` | *long* | :heavy_check_mark: | N/A | 36158371307 |
|
| `indexes` | *Optional\<String>* | :heavy_minus_sign: | N/A | sd |
|
||||||
| `container` | *String* | :heavy_check_mark: | The container format of the media file.<br/> | mkv |
|
| `duration` | *Optional\<Integer>* | :heavy_minus_sign: | Duration of the part in milliseconds. | 9610350 |
|
||||||
| `audioProfile` | *Optional\<String>* | :heavy_minus_sign: | N/A | dts |
|
| `file` | *Optional\<String>* | :heavy_minus_sign: | File path for the part. | /mnt/Movies_1/W/Wicked (2024).mkv |
|
||||||
| `has64bitOffsets` | *Optional\<Boolean>* | :heavy_minus_sign: | N/A | false |
|
| `size` | *Optional\<Long>* | :heavy_minus_sign: | File size in bytes. | 30649952104 |
|
||||||
| `optimizedForStreaming` | *Optional\<Boolean>* | :heavy_minus_sign: | N/A | false |
|
| `packetLength` | *Optional\<Integer>* | :heavy_minus_sign: | N/A | 188 |
|
||||||
| `videoProfile` | *Optional\<String>* | :heavy_minus_sign: | N/A | main 10 |
|
| `container` | *Optional\<String>* | :heavy_minus_sign: | Container format of the part. | mkv |
|
||||||
| `indexes` | *Optional\<String>* | :heavy_minus_sign: | N/A | sd |
|
| `videoProfile` | *Optional\<String>* | :heavy_minus_sign: | Video profile for the part. | main 10 |
|
||||||
| `hasThumbnail` | [Optional\<GetLibraryItemsHasThumbnail>](../../models/operations/GetLibraryItemsHasThumbnail.md) | :heavy_minus_sign: | N/A | 1 |
|
| `audioProfile` | *Optional\<String>* | :heavy_minus_sign: | The audio profile used for the media (e.g., DTS, Dolby Digital, etc.). | dts |
|
||||||
| `stream` | List\<[GetLibraryItemsStream](../../models/operations/GetLibraryItemsStream.md)> | :heavy_minus_sign: | N/A | |
|
| `has64bitOffsets` | *Optional\<Boolean>* | :heavy_minus_sign: | N/A | false |
|
||||||
|
| `optimizedForStreaming` | [Optional\<GetLibraryItemsLibraryOptimizedForStreaming>](../../models/operations/GetLibraryItemsLibraryOptimizedForStreaming.md) | :heavy_minus_sign: | Has this media been optimized for streaming. NOTE: This can be 0, 1, false or true<br/> | |
|
||||||
|
| `hasThumbnail` | [Optional\<GetLibraryItemsHasThumbnail>](../../models/operations/GetLibraryItemsHasThumbnail.md) | :heavy_minus_sign: | N/A | 1 |
|
||||||
13
docs/models/operations/GetLibraryItemsProducer.md
Normal file
13
docs/models/operations/GetLibraryItemsProducer.md
Normal file
@@ -0,0 +1,13 @@
|
|||||||
|
# GetLibraryItemsProducer
|
||||||
|
|
||||||
|
|
||||||
|
## 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 |
|
||||||
@@ -11,12 +11,14 @@ E.g. A movie library will not return anything with type 3 as there are no season
|
|||||||
|
|
||||||
## Values
|
## Values
|
||||||
|
|
||||||
| Name | Value |
|
| Name | Value |
|
||||||
| --------- | --------- |
|
| ------------ | ------------ |
|
||||||
| `Movie` | 1 |
|
| `Movie` | 1 |
|
||||||
| `TvShow` | 2 |
|
| `TvShow` | 2 |
|
||||||
| `Season` | 3 |
|
| `Season` | 3 |
|
||||||
| `Episode` | 4 |
|
| `Episode` | 4 |
|
||||||
| `Audio` | 8 |
|
| `Artist` | 5 |
|
||||||
| `Album` | 9 |
|
| `Album` | 6 |
|
||||||
| `Track` | 10 |
|
| `Track` | 7 |
|
||||||
|
| `PhotoAlbum` | 8 |
|
||||||
|
| `Photo` | 9 |
|
||||||
@@ -3,11 +3,9 @@
|
|||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
| Field | Type | Required | Description | Example |
|
||||||
| ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- |
|
| ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- |
|
||||||
| `id` | *Optional\<Long>* | :heavy_minus_sign: | The ID of the tag or actor. | 294129 |
|
| `id` | *int* | :heavy_check_mark: | The unique identifier for the role.<br/>NOTE: This is different for each Plex server and is not globally unique.<br/> | 126522 |
|
||||||
| `filter` | *Optional\<String>* | :heavy_minus_sign: | The filter used to find the actor or tag. | actor=294129 |
|
| `tag` | *String* | :heavy_check_mark: | The display tag for the actor (typically the actor's name). | Teller |
|
||||||
| `thumb` | *Optional\<String>* | :heavy_minus_sign: | The thumbnail of the actor | https://metadata-static.plex.tv/2/people/27b85844536c39f3f9ac943aaad46608.jpg |
|
| `role` | *Optional\<String>* | :heavy_minus_sign: | The role played by the actor in the media item. | Self - Judge |
|
||||||
| `tag` | *Optional\<String>* | :heavy_minus_sign: | The name of the tag or actor. | Mike Smith |
|
| `thumb` | *Optional\<String>* | :heavy_minus_sign: | The absolute URL of the thumbnail image for the actor. | https://metadata-static.plex.tv/7/people/708568fd018d7aa8b1032dcf867747e8.jpg |
|
||||||
| `tagKey` | *Optional\<String>* | :heavy_minus_sign: | Unique identifier for the tag. | 668e7e7b22bcad9064350c91 |
|
|
||||||
| `role` | *Optional\<String>* | :heavy_minus_sign: | The role of the actor or tag in the media. | Self |
|
|
||||||
@@ -1,20 +0,0 @@
|
|||||||
# GetLibraryItemsShowOrdering
|
|
||||||
|
|
||||||
Setting that indicates the episode ordering for the show.
|
|
||||||
None = Library default,
|
|
||||||
tmdbAiring = The Movie Database (Aired),
|
|
||||||
aired = TheTVDB (Aired),
|
|
||||||
dvd = TheTVDB (DVD),
|
|
||||||
absolute = TheTVDB (Absolute)).
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## Values
|
|
||||||
|
|
||||||
| Name | Value |
|
|
||||||
| -------------- | -------------- |
|
|
||||||
| `None` | None |
|
|
||||||
| `TmdbAiring` | tmdbAiring |
|
|
||||||
| `TvdbAired` | aired |
|
|
||||||
| `TvdbDvd` | dvd |
|
|
||||||
| `TvdbAbsolute` | absolute |
|
|
||||||
@@ -1,8 +1,10 @@
|
|||||||
# GetAllMediaLibraryGenre
|
# GetLibraryItemsSimilar
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
| Field | Type | Required | Description | Example |
|
||||||
| ---------------------------------------- | ---------------------------------------- | ---------------------------------------- | ---------------------------------------- | ---------------------------------------- |
|
| ---------------------------------------- | ---------------------------------------- | ---------------------------------------- | ---------------------------------------- | ---------------------------------------- |
|
||||||
| `tag` | *String* | :heavy_check_mark: | The country of origin of this media item | United States of America |
|
| `id` | *long* | :heavy_check_mark: | The unique similar item identifier. | 26 |
|
||||||
|
| `filter` | *String* | :heavy_check_mark: | The filter string for similar items. | similar=26 |
|
||||||
|
| `tag` | *String* | :heavy_check_mark: | The tag or title of the similar content. | Breaking Bad |
|
||||||
@@ -1,45 +0,0 @@
|
|||||||
# GetLibraryItemsStream
|
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
|
||||||
| ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- |
|
|
||||||
| `id` | *long* | :heavy_check_mark: | N/A | 272796 |
|
|
||||||
| `streamType` | *long* | :heavy_check_mark: | Type of stream (1 = video, 2 = audio, 3 = subtitle) | 1 |
|
|
||||||
| `default_` | *Optional\<Boolean>* | :heavy_minus_sign: | Indicates if this is the default stream | true |
|
|
||||||
| `selected` | *Optional\<Boolean>* | :heavy_minus_sign: | Indicates if the stream is selected | true |
|
|
||||||
| `codec` | *String* | :heavy_check_mark: | Codec used by the stream | h264 |
|
|
||||||
| `index` | *long* | :heavy_check_mark: | The index of the stream | 0 |
|
|
||||||
| `bitrate` | *Optional\<Long>* | :heavy_minus_sign: | The bitrate of the stream in kbps | 6273 |
|
|
||||||
| `colorPrimaries` | *Optional\<String>* | :heavy_minus_sign: | The color primaries of the video stream | bt709 |
|
|
||||||
| `colorRange` | *Optional\<String>* | :heavy_minus_sign: | The color range of the video stream | tv |
|
|
||||||
| `colorSpace` | *Optional\<String>* | :heavy_minus_sign: | The color space of the video stream | bt709 |
|
|
||||||
| `colorTrc` | *Optional\<String>* | :heavy_minus_sign: | The transfer characteristics (TRC) of the video stream | bt709 |
|
|
||||||
| `bitDepth` | *Optional\<Long>* | :heavy_minus_sign: | The bit depth of the video stream | 8 |
|
|
||||||
| `chromaLocation` | *Optional\<String>* | :heavy_minus_sign: | The chroma location of the video stream | left |
|
|
||||||
| `streamIdentifier` | *Optional\<String>* | :heavy_minus_sign: | The identifier of the video stream | 2 |
|
|
||||||
| `chromaSubsampling` | *Optional\<String>* | :heavy_minus_sign: | The chroma subsampling format | 4:2:0 |
|
|
||||||
| `codedHeight` | *Optional\<Long>* | :heavy_minus_sign: | The coded height of the video stream | 1088 |
|
|
||||||
| `codedWidth` | *Optional\<Long>* | :heavy_minus_sign: | The coded width of the video stream | 1920 |
|
|
||||||
| `frameRate` | *Optional\<Double>* | :heavy_minus_sign: | The frame rate of the video stream | 29.97 |
|
|
||||||
| `hasScalingMatrix` | *Optional\<Boolean>* | :heavy_minus_sign: | Indicates if the stream has a scaling matrix | false |
|
|
||||||
| `hearingImpaired` | *Optional\<Boolean>* | :heavy_minus_sign: | N/A | false |
|
|
||||||
| `closedCaptions` | *Optional\<Boolean>* | :heavy_minus_sign: | N/A | false |
|
|
||||||
| `embeddedInVideo` | *Optional\<String>* | :heavy_minus_sign: | N/A | 1 |
|
|
||||||
| `height` | *Optional\<Long>* | :heavy_minus_sign: | The height of the video stream | 1080 |
|
|
||||||
| `level` | *Optional\<Long>* | :heavy_minus_sign: | The level of the video codec | 40 |
|
|
||||||
| `profile` | *Optional\<String>* | :heavy_minus_sign: | The profile of the video codec | main |
|
|
||||||
| `refFrames` | *Optional\<Long>* | :heavy_minus_sign: | Number of reference frames | 4 |
|
|
||||||
| `scanType` | *Optional\<String>* | :heavy_minus_sign: | The scan type (progressive or interlaced) | progressive |
|
|
||||||
| `width` | *Optional\<Long>* | :heavy_minus_sign: | The width of the video stream | 1920 |
|
|
||||||
| `displayTitle` | *Optional\<String>* | :heavy_minus_sign: | Display title of the stream | 1080p (H.264) |
|
|
||||||
| `extendedDisplayTitle` | *Optional\<String>* | :heavy_minus_sign: | Extended display title of the stream | 1080p (H.264) |
|
|
||||||
| `channels` | *Optional\<Long>* | :heavy_minus_sign: | Number of audio channels (for audio streams) | 2 |
|
|
||||||
| `language` | *Optional\<String>* | :heavy_minus_sign: | The language of the stream (for audio/subtitle streams) | English |
|
|
||||||
| `languageTag` | *Optional\<String>* | :heavy_minus_sign: | Language tag of the stream | en |
|
|
||||||
| `languageCode` | *Optional\<String>* | :heavy_minus_sign: | Language code of the stream | eng |
|
|
||||||
| `audioChannelLayout` | *Optional\<String>* | :heavy_minus_sign: | The audio channel layout | stereo |
|
|
||||||
| `samplingRate` | *Optional\<Long>* | :heavy_minus_sign: | Sampling rate of the audio stream in Hz | 48000 |
|
|
||||||
| `title` | *Optional\<String>* | :heavy_minus_sign: | Title of the subtitle track (for subtitle streams) | English |
|
|
||||||
| `canAutoSync` | *Optional\<Boolean>* | :heavy_minus_sign: | Indicates if the subtitle stream can auto-sync | false |
|
|
||||||
@@ -1,15 +1,20 @@
|
|||||||
# GetLibraryItemsType
|
# GetLibraryItemsType
|
||||||
|
|
||||||
|
The type of media content in the Plex library. This can represent videos, music, or photos.
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
|
||||||
| -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- |
|
## Values
|
||||||
| `key` | *String* | :heavy_check_mark: | N/A | /library/sections/2/all?type=2 |
|
|
||||||
| `type` | *String* | :heavy_check_mark: | N/A | filter |
|
| Name | Value |
|
||||||
| `subtype` | *Optional\<String>* | :heavy_minus_sign: | N/A | clip |
|
| ------------ | ------------ |
|
||||||
| `title` | *String* | :heavy_check_mark: | N/A | TV Shows |
|
| `Movie` | movie |
|
||||||
| `active` | *boolean* | :heavy_check_mark: | N/A | false |
|
| `TvShow` | show |
|
||||||
| `filter` | List\<[GetLibraryItemsFilter](../../models/operations/GetLibraryItemsFilter.md)> | :heavy_minus_sign: | N/A | |
|
| `Season` | season |
|
||||||
| `sort` | List\<[GetLibraryItemsSort](../../models/operations/GetLibraryItemsSort.md)> | :heavy_minus_sign: | N/A | |
|
| `Episode` | episode |
|
||||||
| `field` | List\<[GetLibraryItemsField](../../models/operations/GetLibraryItemsField.md)> | :heavy_minus_sign: | N/A | |
|
| `Artist` | artist |
|
||||||
|
| `Album` | album |
|
||||||
|
| `Track` | track |
|
||||||
|
| `PhotoAlbum` | photoalbum |
|
||||||
|
| `Photo` | photo |
|
||||||
|
| `Collection` | collection |
|
||||||
@@ -3,6 +3,8 @@
|
|||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
| Field | Type | Required | Description | Example |
|
||||||
| ------------------- | ------------------- | ------------------- | ------------------- | ------------------- |
|
| ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- |
|
||||||
| `tag` | *Optional\<String>* | :heavy_minus_sign: | N/A | James Cameron |
|
| `id` | *int* | :heavy_check_mark: | Unique identifier for the writer. | 126522 |
|
||||||
|
| `tag` | *String* | :heavy_check_mark: | The role of Writer | Jamie P. Hanson |
|
||||||
|
| `thumb` | *Optional\<String>* | :heavy_minus_sign: | The absolute URL of the thumbnail image for the writer. | https://metadata-static.plex.tv/8/people/8d65fa96804802e08f2de09fe014408e.jpg |
|
||||||
@@ -1,4 +1,4 @@
|
|||||||
# GetAllMediaLibraryActiveDirection
|
# GetLibrarySectionsAllActiveDirection
|
||||||
|
|
||||||
The direction of the sort. Can be either `asc` or `desc`.
|
The direction of the sort. Can be either `asc` or `desc`.
|
||||||
|
|
||||||
@@ -1,4 +1,4 @@
|
|||||||
# GetAllMediaLibraryCollection
|
# GetLibrarySectionsAllCollection
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
@@ -1,4 +1,4 @@
|
|||||||
# GetAllMediaLibraryCountry
|
# GetLibrarySectionsAllCountry
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
@@ -1,4 +1,4 @@
|
|||||||
# GetLibraryItemsLibraryActiveDirection
|
# GetLibrarySectionsAllDefaultDirection
|
||||||
|
|
||||||
The direction of the sort. Can be either `asc` or `desc`.
|
The direction of the sort. Can be either `asc` or `desc`.
|
||||||
|
|
||||||
@@ -1,4 +1,4 @@
|
|||||||
# GetAllMediaLibraryDirector
|
# GetLibrarySectionsAllDirector
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
@@ -1,4 +1,4 @@
|
|||||||
# GetAllMediaLibraryField
|
# GetLibrarySectionsAllField
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
9
docs/models/operations/GetLibrarySectionsAllFieldType.md
Normal file
9
docs/models/operations/GetLibrarySectionsAllFieldType.md
Normal file
@@ -0,0 +1,9 @@
|
|||||||
|
# GetLibrarySectionsAllFieldType
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ |
|
||||||
|
| `type` | *String* | :heavy_check_mark: | N/A | tag |
|
||||||
|
| `operator` | List\<[GetLibrarySectionsAllOperator](../../models/operations/GetLibrarySectionsAllOperator.md)> | :heavy_check_mark: | N/A | |
|
||||||
@@ -1,4 +1,4 @@
|
|||||||
# GetAllMediaLibraryFilter
|
# GetLibrarySectionsAllFilter
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
8
docs/models/operations/GetLibrarySectionsAllGenre.md
Normal file
8
docs/models/operations/GetLibrarySectionsAllGenre.md
Normal file
@@ -0,0 +1,8 @@
|
|||||||
|
# GetLibrarySectionsAllGenre
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ---------------------------------- | ---------------------------------- | ---------------------------------- | ---------------------------------- | ---------------------------------- |
|
||||||
|
| `tag` | *String* | :heavy_check_mark: | The genre name of this media-item<br/> | Crime |
|
||||||
8
docs/models/operations/GetLibrarySectionsAllGuids.md
Normal file
8
docs/models/operations/GetLibrarySectionsAllGuids.md
Normal file
@@ -0,0 +1,8 @@
|
|||||||
|
# GetLibrarySectionsAllGuids
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||||
|
| `id` | *String* | :heavy_check_mark: | The unique identifier for the Guid. Can be prefixed with imdb://, tmdb://, tvdb://<br/> | {<br/>"imdbExample": {<br/>"summary": "IMDB example",<br/>"value": "imdb://tt13015952"<br/>},<br/>"tmdbExample": {<br/>"summary": "TMDB example",<br/>"value": "tmdb://2434012"<br/>},<br/>"tvdbExample": {<br/>"summary": "TVDB example",<br/>"value": "tvdb://7945991"<br/>}<br/>} |
|
||||||
@@ -1,4 +1,4 @@
|
|||||||
# GetAllMediaLibraryHasThumbnail
|
# GetLibrarySectionsAllHasThumbnail
|
||||||
|
|
||||||
Indicates if the part has a thumbnail.
|
Indicates if the part has a thumbnail.
|
||||||
|
|
||||||
10
docs/models/operations/GetLibrarySectionsAllImage.md
Normal file
10
docs/models/operations/GetLibrarySectionsAllImage.md
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
# GetLibrarySectionsAllImage
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| --------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- |
|
||||||
|
| `alt` | *String* | :heavy_check_mark: | N/A | Episode 1 |
|
||||||
|
| `type` | [GetLibrarySectionsAllLibraryResponseType](../../models/operations/GetLibrarySectionsAllLibraryResponseType.md) | :heavy_check_mark: | N/A | background |
|
||||||
|
| `url` | *String* | :heavy_check_mark: | N/A | /library/metadata/45521/thumb/1644710589 |
|
||||||
@@ -0,0 +1,4 @@
|
|||||||
|
# GetLibrarySectionsAllLibraryOptimizedForStreaming
|
||||||
|
|
||||||
|
Has this media been optimized for streaming. NOTE: This can be 0, 1, false or true
|
||||||
|
|
||||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user