mirror of
https://github.com/LukeHagar/plexjava.git
synced 2025-12-06 12:37:47 +00:00
Compare commits
5 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
aa85c1813b | ||
|
|
84fb18428a | ||
|
|
37569715a6 | ||
|
|
c0e915da8b | ||
|
|
0077561a6a |
2
.gitignore
vendored
2
.gitignore
vendored
@@ -1,3 +1,5 @@
|
|||||||
|
**/.speakeasy/temp/
|
||||||
|
**/.speakeasy/logs/
|
||||||
.speakeasy/reports
|
.speakeasy/reports
|
||||||
# Ignore Gradle project-specific cache directory
|
# Ignore Gradle project-specific cache directory
|
||||||
.gradle
|
.gradle
|
||||||
|
|||||||
File diff suppressed because one or more lines are too long
@@ -4,6 +4,7 @@ generation:
|
|||||||
maintainOpenAPIOrder: true
|
maintainOpenAPIOrder: true
|
||||||
usageSnippets:
|
usageSnippets:
|
||||||
optionalPropertyRendering: withExample
|
optionalPropertyRendering: withExample
|
||||||
|
sdkInitStyle: constructor
|
||||||
useClassNamesForArrayFields: true
|
useClassNamesForArrayFields: true
|
||||||
fixes:
|
fixes:
|
||||||
nameResolutionDec2023: true
|
nameResolutionDec2023: true
|
||||||
@@ -11,14 +12,16 @@ generation:
|
|||||||
parameterOrderingFeb2024: true
|
parameterOrderingFeb2024: true
|
||||||
requestResponseComponentNamesFeb2024: true
|
requestResponseComponentNamesFeb2024: true
|
||||||
securityFeb2025: false
|
securityFeb2025: false
|
||||||
|
sharedErrorComponentsApr2025: false
|
||||||
auth:
|
auth:
|
||||||
oAuth2ClientCredentialsEnabled: true
|
oAuth2ClientCredentialsEnabled: true
|
||||||
oAuth2PasswordEnabled: false
|
oAuth2PasswordEnabled: false
|
||||||
java:
|
java:
|
||||||
version: 0.15.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.531.4
|
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:db75a06885b897418dcb580679b5f744348573ad317155172346d32442420e5e
|
sourceRevisionDigest: sha256:dafcc1192236829b85bc924e0462432c0eb7318a17c542f46e3dd05a9a6265df
|
||||||
sourceBlobDigest: sha256:ac0a3c3a6df002378b3522325c2330ba4309fbbbfa503a04b8267398f20033f5
|
sourceBlobDigest: sha256:bc072115d585e1695cb8393db901a3d36be1dcd57a69bad2b91a1ba7ac3c9c4b
|
||||||
tags:
|
tags:
|
||||||
- latest
|
- latest
|
||||||
- speakeasy-sdk-regen-1744590653
|
- speakeasy-sdk-regen-1749429180
|
||||||
targets:
|
targets:
|
||||||
plexjava:
|
plexjava:
|
||||||
source: plexapi
|
source: plexapi
|
||||||
sourceNamespace: plexapi
|
sourceNamespace: plexapi
|
||||||
sourceRevisionDigest: sha256:db75a06885b897418dcb580679b5f744348573ad317155172346d32442420e5e
|
sourceRevisionDigest: sha256:dafcc1192236829b85bc924e0462432c0eb7318a17c542f46e3dd05a9a6265df
|
||||||
sourceBlobDigest: sha256:ac0a3c3a6df002378b3522325c2330ba4309fbbbfa503a04b8267398f20033f5
|
sourceBlobDigest: sha256:bc072115d585e1695cb8393db901a3d36be1dcd57a69bad2b91a1ba7ac3c9c4b
|
||||||
codeSamplesNamespace: code-samples-java-plexjava
|
codeSamplesNamespace: code-samples-java-plexjava
|
||||||
codeSamplesRevisionDigest: sha256:da1aba30a925f7fffb273f3f1f7d25920debd20e62c974ad4a6904a98697c8db
|
codeSamplesRevisionDigest: sha256:9a3449eb22007686202d7d579803f2444900048695cc795361b72f801f88a98a
|
||||||
workflow:
|
workflow:
|
||||||
workflowVersion: 1.0.0
|
workflowVersion: 1.0.0
|
||||||
speakeasyVersion: latest
|
speakeasyVersion: latest
|
||||||
|
|||||||
10
README.md
10
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.15.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.15.0</version>
|
<version>0.17.1</version>
|
||||||
</dependency>
|
</dependency>
|
||||||
```
|
```
|
||||||
|
|
||||||
@@ -192,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
|
||||||
@@ -371,8 +371,8 @@ public class Application {
|
|||||||
|
|
||||||
PlexAPI sdk = PlexAPI.builder()
|
PlexAPI sdk = PlexAPI.builder()
|
||||||
.protocol(ServerProtocol.HTTPS)
|
.protocol(ServerProtocol.HTTPS)
|
||||||
.ip("e0c3:bcc0:6bac:dccc:c4ec:34b1:ca98:4cb9")
|
.ip("4982:bc2a:b4f8:efb5:2394:5bc3:ab4f:0e6d")
|
||||||
.port("40311")
|
.port("44765")
|
||||||
.accessToken("<YOUR_API_KEY_HERE>")
|
.accessToken("<YOUR_API_KEY_HERE>")
|
||||||
.build();
|
.build();
|
||||||
|
|
||||||
|
|||||||
52
RELEASES.md
52
RELEASES.md
@@ -318,4 +318,54 @@ Based on:
|
|||||||
### Generated
|
### Generated
|
||||||
- [java v0.15.0] .
|
- [java v0.15.0] .
|
||||||
### Releases
|
### Releases
|
||||||
- [Maven Central v0.15.0] https://central.sonatype.com/artifact/dev.plexapi/plexapi/0.15.0 - .
|
- [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 - .
|
||||||
@@ -103,7 +103,7 @@ publishing {
|
|||||||
// https://github.com/gradle/gradle/issues/18619
|
// https://github.com/gradle/gradle/issues/18619
|
||||||
groupId = "dev.plexapi"
|
groupId = "dev.plexapi"
|
||||||
artifactId = "plexapi"
|
artifactId = "plexapi"
|
||||||
version = "0.15.0"
|
version = "0.17.1"
|
||||||
|
|
||||||
from components.java
|
from components.java
|
||||||
|
|
||||||
|
|||||||
@@ -363,7 +363,7 @@ actions:
|
|||||||
.build();
|
.build();
|
||||||
|
|
||||||
StopTaskResponse res = sdk.butler().stopTask()
|
StopTaskResponse res = sdk.butler().stopTask()
|
||||||
.taskName(PathParamTaskName.BACKUP_DATABASE)
|
.taskName(PathParamTaskName.CLEAN_OLD_CACHE_FILES)
|
||||||
.call();
|
.call();
|
||||||
|
|
||||||
// handle response
|
// handle response
|
||||||
@@ -393,7 +393,7 @@ actions:
|
|||||||
.build();
|
.build();
|
||||||
|
|
||||||
StartTaskResponse res = sdk.butler().startTask()
|
StartTaskResponse res = sdk.butler().startTask()
|
||||||
.taskName(TaskName.CLEAN_OLD_BUNDLES)
|
.taskName(TaskName.REFRESH_PERIODIC_METADATA)
|
||||||
.call();
|
.call();
|
||||||
|
|
||||||
// handle response
|
// handle response
|
||||||
@@ -629,9 +629,10 @@ actions:
|
|||||||
.build();
|
.build();
|
||||||
|
|
||||||
GetRecentlyAddedRequest req = GetRecentlyAddedRequest.builder()
|
GetRecentlyAddedRequest req = GetRecentlyAddedRequest.builder()
|
||||||
.contentDirectoryID(470161L)
|
.contentDirectoryID(39486L)
|
||||||
.type(Type.TvShow)
|
.type(Type.TvShow)
|
||||||
.sectionID(2L)
|
.sectionID(2L)
|
||||||
|
.includeMeta(IncludeMeta.Enable)
|
||||||
.build();
|
.build();
|
||||||
|
|
||||||
GetRecentlyAddedResponse res = sdk.hubs().getRecentlyAdded()
|
GetRecentlyAddedResponse res = sdk.hubs().getRecentlyAdded()
|
||||||
@@ -666,7 +667,8 @@ actions:
|
|||||||
.build();
|
.build();
|
||||||
|
|
||||||
PerformSearchResponse res = sdk.search().performSearch()
|
PerformSearchResponse res = sdk.search().performSearch()
|
||||||
.query("dylan")
|
.query("arnold")
|
||||||
|
.limit(5)
|
||||||
.call();
|
.call();
|
||||||
|
|
||||||
// handle response
|
// handle response
|
||||||
@@ -696,6 +698,7 @@ actions:
|
|||||||
|
|
||||||
PerformVoiceSearchResponse res = sdk.search().performVoiceSearch()
|
PerformVoiceSearchResponse res = sdk.search().performVoiceSearch()
|
||||||
.query("dead+poop")
|
.query("dead+poop")
|
||||||
|
.limit(5)
|
||||||
.call();
|
.call();
|
||||||
|
|
||||||
// handle response
|
// handle response
|
||||||
@@ -724,7 +727,7 @@ actions:
|
|||||||
.build();
|
.build();
|
||||||
|
|
||||||
GetLibraryHubsResponse res = sdk.hubs().getLibraryHubs()
|
GetLibraryHubsResponse res = sdk.hubs().getLibraryHubs()
|
||||||
.sectionId(6728.76)
|
.sectionId(492.74)
|
||||||
.call();
|
.call();
|
||||||
|
|
||||||
if (res.object().isPresent()) {
|
if (res.object().isPresent()) {
|
||||||
@@ -771,8 +774,7 @@ actions:
|
|||||||
import dev.plexapi.sdk.PlexAPI;
|
import dev.plexapi.sdk.PlexAPI;
|
||||||
import dev.plexapi.sdk.models.errors.GetTopWatchedContentBadRequest;
|
import dev.plexapi.sdk.models.errors.GetTopWatchedContentBadRequest;
|
||||||
import dev.plexapi.sdk.models.errors.GetTopWatchedContentUnauthorized;
|
import dev.plexapi.sdk.models.errors.GetTopWatchedContentUnauthorized;
|
||||||
import dev.plexapi.sdk.models.operations.GetTopWatchedContentQueryParamType;
|
import dev.plexapi.sdk.models.operations.*;
|
||||||
import dev.plexapi.sdk.models.operations.GetTopWatchedContentResponse;
|
|
||||||
import java.lang.Exception;
|
import java.lang.Exception;
|
||||||
|
|
||||||
public class Application {
|
public class Application {
|
||||||
@@ -784,8 +786,8 @@ actions:
|
|||||||
.build();
|
.build();
|
||||||
|
|
||||||
GetTopWatchedContentResponse res = sdk.library().getTopWatchedContent()
|
GetTopWatchedContentResponse res = sdk.library().getTopWatchedContent()
|
||||||
.includeGuids(1L)
|
|
||||||
.type(GetTopWatchedContentQueryParamType.TvShow)
|
.type(GetTopWatchedContentQueryParamType.TvShow)
|
||||||
|
.includeGuids(GetTopWatchedContentQueryParamIncludeGuids.Enable)
|
||||||
.call();
|
.call();
|
||||||
|
|
||||||
if (res.object().isPresent()) {
|
if (res.object().isPresent()) {
|
||||||
@@ -846,7 +848,7 @@ actions:
|
|||||||
.build();
|
.build();
|
||||||
|
|
||||||
GetMediaMetaDataRequest req = GetMediaMetaDataRequest.builder()
|
GetMediaMetaDataRequest req = GetMediaMetaDataRequest.builder()
|
||||||
.ratingKey(9518L)
|
.ratingKey("21119,21617")
|
||||||
.includeConcerts(true)
|
.includeConcerts(true)
|
||||||
.includeExtras(true)
|
.includeExtras(true)
|
||||||
.includeOnDeck(true)
|
.includeOnDeck(true)
|
||||||
@@ -992,7 +994,7 @@ actions:
|
|||||||
.build();
|
.build();
|
||||||
|
|
||||||
GetMetadataChildrenResponse res = sdk.library().getMetadataChildren()
|
GetMetadataChildrenResponse res = sdk.library().getMetadataChildren()
|
||||||
.ratingKey(1539.14)
|
.ratingKey(2403.67)
|
||||||
.includeElements("Stream")
|
.includeElements("Stream")
|
||||||
.call();
|
.call();
|
||||||
|
|
||||||
@@ -1139,6 +1141,7 @@ actions:
|
|||||||
16L,
|
16L,
|
||||||
17L))
|
17L))
|
||||||
.sectionID(2L)
|
.sectionID(2L)
|
||||||
|
.includeMeta(QueryParamIncludeMeta.Enable)
|
||||||
.build();
|
.build();
|
||||||
|
|
||||||
GetRecentlyAddedLibraryResponse res = sdk.library().getRecentlyAddedLibrary()
|
GetRecentlyAddedLibraryResponse res = sdk.library().getRecentlyAddedLibrary()
|
||||||
@@ -1178,6 +1181,8 @@ actions:
|
|||||||
.clientID("3381b62b-9ab7-4e37-827b-203e9809eb58")
|
.clientID("3381b62b-9ab7-4e37-827b-203e9809eb58")
|
||||||
.searchTypes(List.of(
|
.searchTypes(List.of(
|
||||||
SearchTypes.PEOPLE))
|
SearchTypes.PEOPLE))
|
||||||
|
.includeCollections(GetSearchAllLibrariesQueryParamIncludeCollections.Enable)
|
||||||
|
.includeExternalMedia(GetSearchAllLibrariesQueryParamIncludeExternalMedia.Enable)
|
||||||
.build();
|
.build();
|
||||||
|
|
||||||
GetSearchAllLibrariesResponse res = sdk.library().getSearchAllLibraries()
|
GetSearchAllLibrariesResponse res = sdk.library().getSearchAllLibraries()
|
||||||
@@ -1242,7 +1247,7 @@ actions:
|
|||||||
.build();
|
.build();
|
||||||
|
|
||||||
GetWatchListRequest req = GetWatchListRequest.builder()
|
GetWatchListRequest req = GetWatchListRequest.builder()
|
||||||
.filter(Filter.AVAILABLE)
|
.filter(Filter.RELEASED)
|
||||||
.xPlexToken("CV5xoxjTpFKUzBTShsaf")
|
.xPlexToken("CV5xoxjTpFKUzBTShsaf")
|
||||||
.build();
|
.build();
|
||||||
|
|
||||||
@@ -1296,6 +1301,7 @@ actions:
|
|||||||
import dev.plexapi.sdk.models.errors.GetLibraryDetailsBadRequest;
|
import dev.plexapi.sdk.models.errors.GetLibraryDetailsBadRequest;
|
||||||
import dev.plexapi.sdk.models.errors.GetLibraryDetailsUnauthorized;
|
import dev.plexapi.sdk.models.errors.GetLibraryDetailsUnauthorized;
|
||||||
import dev.plexapi.sdk.models.operations.GetLibraryDetailsResponse;
|
import dev.plexapi.sdk.models.operations.GetLibraryDetailsResponse;
|
||||||
|
import dev.plexapi.sdk.models.operations.IncludeDetails;
|
||||||
import java.lang.Exception;
|
import java.lang.Exception;
|
||||||
|
|
||||||
public class Application {
|
public class Application {
|
||||||
@@ -1307,6 +1313,7 @@ actions:
|
|||||||
.build();
|
.build();
|
||||||
|
|
||||||
GetLibraryDetailsResponse res = sdk.library().getLibraryDetails()
|
GetLibraryDetailsResponse res = sdk.library().getLibraryDetails()
|
||||||
|
.includeDetails(IncludeDetails.ZERO)
|
||||||
.sectionKey(9518)
|
.sectionKey(9518)
|
||||||
.call();
|
.call();
|
||||||
|
|
||||||
@@ -1357,25 +1364,30 @@ actions:
|
|||||||
package hello.world;
|
package hello.world;
|
||||||
|
|
||||||
import dev.plexapi.sdk.PlexAPI;
|
import dev.plexapi.sdk.PlexAPI;
|
||||||
import dev.plexapi.sdk.models.errors.GetAllMediaLibraryBadRequest;
|
import dev.plexapi.sdk.models.errors.GetLibrarySectionsAllBadRequest;
|
||||||
import dev.plexapi.sdk.models.errors.GetAllMediaLibraryUnauthorized;
|
import dev.plexapi.sdk.models.errors.GetLibrarySectionsAllUnauthorized;
|
||||||
import dev.plexapi.sdk.models.operations.*;
|
import dev.plexapi.sdk.models.operations.*;
|
||||||
import java.lang.Exception;
|
import java.lang.Exception;
|
||||||
|
|
||||||
public class Application {
|
public class Application {
|
||||||
|
|
||||||
public static void main(String[] args) throws GetAllMediaLibraryBadRequest, GetAllMediaLibraryUnauthorized, Exception {
|
public static void main(String[] args) throws GetLibrarySectionsAllBadRequest, GetLibrarySectionsAllUnauthorized, Exception {
|
||||||
|
|
||||||
PlexAPI sdk = PlexAPI.builder()
|
PlexAPI sdk = PlexAPI.builder()
|
||||||
.accessToken("<YOUR_API_KEY_HERE>")
|
.accessToken("<YOUR_API_KEY_HERE>")
|
||||||
.build();
|
.build();
|
||||||
|
|
||||||
GetAllMediaLibraryRequest req = GetAllMediaLibraryRequest.builder()
|
GetLibrarySectionsAllRequest req = GetLibrarySectionsAllRequest.builder()
|
||||||
.sectionKey(9518)
|
.sectionKey(9518)
|
||||||
.type(GetAllMediaLibraryQueryParamType.TvShow)
|
.type(GetLibrarySectionsAllQueryParamType.TvShow)
|
||||||
|
.includeMeta(GetLibrarySectionsAllQueryParamIncludeMeta.Enable)
|
||||||
|
.includeGuids(QueryParamIncludeGuids.Enable)
|
||||||
|
.includeAdvanced(IncludeAdvanced.Enable)
|
||||||
|
.includeCollections(QueryParamIncludeCollections.Enable)
|
||||||
|
.includeExternalMedia(QueryParamIncludeExternalMedia.Enable)
|
||||||
.build();
|
.build();
|
||||||
|
|
||||||
GetAllMediaLibraryResponse res = sdk.library().getAllMediaLibrary()
|
GetLibrarySectionsAllResponse res = sdk.library().getLibrarySectionsAll()
|
||||||
.request(req)
|
.request(req)
|
||||||
.call();
|
.call();
|
||||||
|
|
||||||
@@ -1474,7 +1486,7 @@ actions:
|
|||||||
.build();
|
.build();
|
||||||
|
|
||||||
GetRefreshLibraryMetadataResponse res = sdk.library().getRefreshLibraryMetadata()
|
GetRefreshLibraryMetadataResponse res = sdk.library().getRefreshLibraryMetadata()
|
||||||
.force(Force.ONE)
|
.force(Force.ZERO)
|
||||||
.sectionKey(9518)
|
.sectionKey(9518)
|
||||||
.call();
|
.call();
|
||||||
|
|
||||||
@@ -1537,9 +1549,11 @@ actions:
|
|||||||
.build();
|
.build();
|
||||||
|
|
||||||
GetLibraryItemsRequest req = GetLibraryItemsRequest.builder()
|
GetLibraryItemsRequest req = GetLibraryItemsRequest.builder()
|
||||||
.tag(Tag.EDITION)
|
.tag(Tag.NEWEST)
|
||||||
.type(GetLibraryItemsQueryParamType.TvShow)
|
.type(GetLibraryItemsQueryParamType.TvShow)
|
||||||
.sectionKey(9518)
|
.sectionKey(9518)
|
||||||
|
.includeGuids(IncludeGuids.Enable)
|
||||||
|
.includeMeta(GetLibraryItemsQueryParamIncludeMeta.Enable)
|
||||||
.build();
|
.build();
|
||||||
|
|
||||||
GetLibraryItemsResponse res = sdk.library().getLibraryItems()
|
GetLibraryItemsResponse res = sdk.library().getLibraryItems()
|
||||||
@@ -1731,8 +1745,8 @@ actions:
|
|||||||
.height(165)
|
.height(165)
|
||||||
.opacity(100L)
|
.opacity(100L)
|
||||||
.blur(0)
|
.blur(0)
|
||||||
.minSize(MinSize.ONE)
|
.minSize(MinSize.ZERO)
|
||||||
.upscale(Upscale.ONE)
|
.upscale(Upscale.ZERO)
|
||||||
.url("/library/metadata/49564/thumb/1654258204")
|
.url("/library/metadata/49564/thumb/1654258204")
|
||||||
.build();
|
.build();
|
||||||
|
|
||||||
@@ -1804,7 +1818,7 @@ actions:
|
|||||||
.build();
|
.build();
|
||||||
|
|
||||||
GetTokenByPinIdRequest req = GetTokenByPinIdRequest.builder()
|
GetTokenByPinIdRequest req = GetTokenByPinIdRequest.builder()
|
||||||
.pinID(408895L)
|
.pinID(232248L)
|
||||||
.clientID("3381b62b-9ab7-4e37-827b-203e9809eb58")
|
.clientID("3381b62b-9ab7-4e37-827b-203e9809eb58")
|
||||||
.clientName("Plex for Roku")
|
.clientName("Plex for Roku")
|
||||||
.deviceNickname("Roku 3")
|
.deviceNickname("Roku 3")
|
||||||
@@ -1875,9 +1889,9 @@ actions:
|
|||||||
|
|
||||||
CreatePlaylistRequest req = CreatePlaylistRequest.builder()
|
CreatePlaylistRequest req = CreatePlaylistRequest.builder()
|
||||||
.title("<value>")
|
.title("<value>")
|
||||||
.type(CreatePlaylistQueryParamType.PHOTO)
|
.type(CreatePlaylistQueryParamType.AUDIO)
|
||||||
.smart(Smart.ONE)
|
.smart(Smart.ONE)
|
||||||
.uri("https://hoarse-testing.info/")
|
.uri("https://short-term-disconnection.name/")
|
||||||
.build();
|
.build();
|
||||||
|
|
||||||
CreatePlaylistResponse res = sdk.playlists().createPlaylist()
|
CreatePlaylistResponse res = sdk.playlists().createPlaylist()
|
||||||
@@ -1914,7 +1928,7 @@ actions:
|
|||||||
|
|
||||||
UploadPlaylistResponse res = sdk.playlists().uploadPlaylist()
|
UploadPlaylistResponse res = sdk.playlists().uploadPlaylist()
|
||||||
.path("/home/barkley/playlist.m3u")
|
.path("/home/barkley/playlist.m3u")
|
||||||
.force(QueryParamForce.ZERO)
|
.force(QueryParamForce.ONE)
|
||||||
.sectionID(1L)
|
.sectionID(1L)
|
||||||
.call();
|
.call();
|
||||||
|
|
||||||
@@ -1944,7 +1958,7 @@ actions:
|
|||||||
.build();
|
.build();
|
||||||
|
|
||||||
DeletePlaylistResponse res = sdk.playlists().deletePlaylist()
|
DeletePlaylistResponse res = sdk.playlists().deletePlaylist()
|
||||||
.playlistID(216.22)
|
.playlistID(3432.93)
|
||||||
.call();
|
.call();
|
||||||
|
|
||||||
// handle response
|
// handle response
|
||||||
@@ -1973,7 +1987,7 @@ actions:
|
|||||||
.build();
|
.build();
|
||||||
|
|
||||||
GetPlaylistResponse res = sdk.playlists().getPlaylist()
|
GetPlaylistResponse res = sdk.playlists().getPlaylist()
|
||||||
.playlistID(4109.48)
|
.playlistID(8419.53)
|
||||||
.call();
|
.call();
|
||||||
|
|
||||||
if (res.object().isPresent()) {
|
if (res.object().isPresent()) {
|
||||||
@@ -2004,7 +2018,7 @@ actions:
|
|||||||
.build();
|
.build();
|
||||||
|
|
||||||
UpdatePlaylistResponse res = sdk.playlists().updatePlaylist()
|
UpdatePlaylistResponse res = sdk.playlists().updatePlaylist()
|
||||||
.playlistID(3915)
|
.playlistID(1579.66)
|
||||||
.call();
|
.call();
|
||||||
|
|
||||||
// handle response
|
// handle response
|
||||||
@@ -2033,7 +2047,7 @@ actions:
|
|||||||
.build();
|
.build();
|
||||||
|
|
||||||
ClearPlaylistContentsResponse res = sdk.playlists().clearPlaylistContents()
|
ClearPlaylistContentsResponse res = sdk.playlists().clearPlaylistContents()
|
||||||
.playlistID(1893.18)
|
.playlistID(4137.37)
|
||||||
.call();
|
.call();
|
||||||
|
|
||||||
// handle response
|
// handle response
|
||||||
@@ -2063,7 +2077,7 @@ actions:
|
|||||||
.build();
|
.build();
|
||||||
|
|
||||||
GetPlaylistContentsResponse res = sdk.playlists().getPlaylistContents()
|
GetPlaylistContentsResponse res = sdk.playlists().getPlaylistContents()
|
||||||
.playlistID(5004.46)
|
.playlistID(5535.42)
|
||||||
.type(GetPlaylistContentsQueryParamType.TvShow)
|
.type(GetPlaylistContentsQueryParamType.TvShow)
|
||||||
.call();
|
.call();
|
||||||
|
|
||||||
@@ -2095,7 +2109,7 @@ actions:
|
|||||||
.build();
|
.build();
|
||||||
|
|
||||||
AddPlaylistContentsResponse res = sdk.playlists().addPlaylistContents()
|
AddPlaylistContentsResponse res = sdk.playlists().addPlaylistContents()
|
||||||
.playlistID(8502.01)
|
.playlistID(7013.44)
|
||||||
.uri("server://12345/com.plexapp.plugins.library/library/metadata/1")
|
.uri("server://12345/com.plexapp.plugins.library/library/metadata/1")
|
||||||
.playQueueID(123)
|
.playQueueID(123)
|
||||||
.call();
|
.call();
|
||||||
@@ -2116,7 +2130,7 @@ actions:
|
|||||||
import dev.plexapi.sdk.PlexAPI;
|
import dev.plexapi.sdk.PlexAPI;
|
||||||
import dev.plexapi.sdk.models.errors.GetServerResourcesBadRequest;
|
import dev.plexapi.sdk.models.errors.GetServerResourcesBadRequest;
|
||||||
import dev.plexapi.sdk.models.errors.GetServerResourcesUnauthorized;
|
import dev.plexapi.sdk.models.errors.GetServerResourcesUnauthorized;
|
||||||
import dev.plexapi.sdk.models.operations.GetServerResourcesResponse;
|
import dev.plexapi.sdk.models.operations.*;
|
||||||
import java.lang.Exception;
|
import java.lang.Exception;
|
||||||
|
|
||||||
public class Application {
|
public class Application {
|
||||||
@@ -2128,6 +2142,9 @@ actions:
|
|||||||
.build();
|
.build();
|
||||||
|
|
||||||
GetServerResourcesResponse res = sdk.plex().getServerResources()
|
GetServerResourcesResponse res = sdk.plex().getServerResources()
|
||||||
|
.includeHttps(IncludeHttps.Enable)
|
||||||
|
.includeRelay(IncludeRelay.Enable)
|
||||||
|
.includeIPv6(IncludeIPv6.Enable)
|
||||||
.clientID("3381b62b-9ab7-4e37-827b-203e9809eb58")
|
.clientID("3381b62b-9ab7-4e37-827b-203e9809eb58")
|
||||||
.call();
|
.call();
|
||||||
|
|
||||||
@@ -2190,7 +2207,7 @@ actions:
|
|||||||
.build();
|
.build();
|
||||||
|
|
||||||
GetSourceConnectionInformationResponse res = sdk.authentication().getSourceConnectionInformation()
|
GetSourceConnectionInformationResponse res = sdk.authentication().getSourceConnectionInformation()
|
||||||
.source("provider://provider-identifier")
|
.source("server://client-identifier")
|
||||||
.call();
|
.call();
|
||||||
|
|
||||||
// handle response
|
// handle response
|
||||||
|
|||||||
@@ -1,4 +1,4 @@
|
|||||||
# GetAllMediaLibraryBadRequest
|
# GetLibrarySectionsAllBadRequest
|
||||||
|
|
||||||
Bad Request - A parameter was not specified, or was specified incorrectly.
|
Bad Request - A parameter was not specified, or was specified incorrectly.
|
||||||
|
|
||||||
@@ -7,5 +7,5 @@ Bad Request - A parameter was not specified, or was specified incorrectly.
|
|||||||
|
|
||||||
| Field | Type | Required | Description |
|
| Field | Type | Required | Description |
|
||||||
| ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ |
|
| ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ |
|
||||||
| `errors` | List\<[GetAllMediaLibraryErrors](../../models/errors/GetAllMediaLibraryErrors.md)> | :heavy_minus_sign: | N/A |
|
| `errors` | List\<[GetLibrarySectionsAllErrors](../../models/errors/GetLibrarySectionsAllErrors.md)> | :heavy_minus_sign: | N/A |
|
||||||
| `rawResponse` | [HttpResponse\<InputStream>](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
| `rawResponse` | [HttpResponse\<InputStream>](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
||||||
@@ -1,4 +1,4 @@
|
|||||||
# GetAllMediaLibraryErrors
|
# GetLibrarySectionsAllErrors
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
@@ -1,4 +1,4 @@
|
|||||||
# GetAllMediaLibraryLibraryErrors
|
# GetLibrarySectionsAllLibraryErrors
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
@@ -1,4 +1,4 @@
|
|||||||
# GetAllMediaLibraryUnauthorized
|
# GetLibrarySectionsAllUnauthorized
|
||||||
|
|
||||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||||
|
|
||||||
@@ -7,5 +7,5 @@ Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
|||||||
|
|
||||||
| Field | Type | Required | Description |
|
| Field | Type | Required | Description |
|
||||||
| ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ |
|
| ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ |
|
||||||
| `errors` | List\<[GetAllMediaLibraryLibraryErrors](../../models/errors/GetAllMediaLibraryLibraryErrors.md)> | :heavy_minus_sign: | N/A |
|
| `errors` | List\<[GetLibrarySectionsAllLibraryErrors](../../models/errors/GetLibrarySectionsAllLibraryErrors.md)> | :heavy_minus_sign: | N/A |
|
||||||
| `rawResponse` | [HttpResponse\<InputStream>](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
| `rawResponse` | [HttpResponse\<InputStream>](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
||||||
11
docs/models/operations/Attributes.md
Normal file
11
docs/models/operations/Attributes.md
Normal file
@@ -0,0 +1,11 @@
|
|||||||
|
# Attributes
|
||||||
|
|
||||||
|
Attributes associated with the marker.
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| -------------------------------------------- | -------------------------------------------- | -------------------------------------------- | -------------------------------------------- | -------------------------------------------- |
|
||||||
|
| `id` | *long* | :heavy_check_mark: | The identifier for the attributes. | 306970 |
|
||||||
|
| `version` | *Optional\<Long>* | :heavy_minus_sign: | The version number of the marker attributes. | 4 |
|
||||||
15
docs/models/operations/Chapter.md
Normal file
15
docs/models/operations/Chapter.md
Normal file
@@ -0,0 +1,15 @@
|
|||||||
|
# Chapter
|
||||||
|
|
||||||
|
The thumbnail for the chapter
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ |
|
||||||
|
| `id` | *long* | :heavy_check_mark: | N/A | 4 |
|
||||||
|
| `filter` | *String* | :heavy_check_mark: | N/A | thumb=4 |
|
||||||
|
| `index` | *long* | :heavy_check_mark: | N/A | 1 |
|
||||||
|
| `startTimeOffset` | *long* | :heavy_check_mark: | N/A | 0 |
|
||||||
|
| `endTimeOffset` | *long* | :heavy_check_mark: | N/A | 100100 |
|
||||||
|
| `thumb` | *String* | :heavy_check_mark: | N/A | /library/media/46883/chapterImages/1 |
|
||||||
@@ -5,8 +5,8 @@ The filter query string for country media items.
|
|||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
| Field | Type | Required | Description | Example |
|
||||||
| ---------------------------------------- | ---------------------------------------- | ---------------------------------------- | ---------------------------------------- | ---------------------------------------- |
|
| ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- |
|
||||||
| `id` | *long* | :heavy_check_mark: | N/A | 259 |
|
| `id` | *int* | :heavy_check_mark: | The unique identifier for the country.<br/>NOTE: This is different for each Plex server and is not globally unique.<br/> | 259 |
|
||||||
| `tag` | *String* | :heavy_check_mark: | The country of origin of this media item | United States of America |
|
| `tag` | *String* | :heavy_check_mark: | The country of origin of this media item | United States of America |
|
||||||
| `filter` | *Optional\<String>* | :heavy_minus_sign: | N/A | country=19 |
|
| `filter` | *String* | :heavy_check_mark: | N/A | country=19 |
|
||||||
@@ -3,6 +3,10 @@
|
|||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
| Field | Type | Required | Description | Example |
|
||||||
| -------------------- | -------------------- | -------------------- | -------------------- | -------------------- |
|
| ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- |
|
||||||
| `tag` | *String* | :heavy_check_mark: | The role of Director | Danny Boyle |
|
| `id` | *int* | :heavy_check_mark: | Unique identifier for the director. | 126522 |
|
||||||
|
| `filter` | *String* | :heavy_check_mark: | The filter string used to query this director. | director=235876 |
|
||||||
|
| `tag` | *String* | :heavy_check_mark: | The role of Director | Danny Boyle |
|
||||||
|
| `tagKey` | *String* | :heavy_check_mark: | A unique 24-character hexadecimal key associated with the director's tag, used for internal identification. | 5d776831151a60001f24d031 |
|
||||||
|
| `thumb` | *Optional\<String>* | :heavy_minus_sign: | The absolute URL of the thumbnail image for the director. | https://metadata-static.plex.tv/8/people/8d65fa96804802e08f2de09fe014408e.jpg |
|
||||||
@@ -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 |
|
||||||
|
|||||||
@@ -5,8 +5,8 @@ The filter query string for similar items.
|
|||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
| Field | Type | Required | Description | Example |
|
||||||
| ---------------------------------- | ---------------------------------- | ---------------------------------- | ---------------------------------- | ---------------------------------- |
|
| -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- |
|
||||||
| `id` | *long* | :heavy_check_mark: | N/A | 259 |
|
| `id` | *int* | :heavy_check_mark: | The unique identifier for the genre.<br/>NOTE: This is different for each Plex server and is not globally unique.<br/> | 259 |
|
||||||
| `filter` | *String* | :heavy_check_mark: | N/A | genre=19 |
|
| `filter` | *String* | :heavy_check_mark: | N/A | genre=19 |
|
||||||
| `tag` | *String* | :heavy_check_mark: | The genre name of this media-item<br/> | Crime |
|
| `tag` | *String* | :heavy_check_mark: | The genre name of this media-item<br/> | Crime |
|
||||||
@@ -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 |
|
||||||
@@ -24,5 +24,5 @@
|
|||||||
| `content` | *boolean* | :heavy_check_mark: | UNKNOWN | true |
|
| `content` | *boolean* | :heavy_check_mark: | UNKNOWN | true |
|
||||||
| `directory` | *boolean* | :heavy_check_mark: | UNKNOWN | true |
|
| `directory` | *boolean* | :heavy_check_mark: | UNKNOWN | true |
|
||||||
| `contentChangedAt` | *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 |
|
| `contentChangedAt` | *long* | :heavy_check_mark: | Timestamp (in seconds) representing the last time the content was modified.<br/>NOTE: Some Plex server have some absurd values for this field, like 8457612157633039800 so it should be int64<br/> | 9173960 |
|
||||||
| `hidden` | [Optional\<Hidden>](../../models/operations/Hidden.md) | :heavy_minus_sign: | N/A | 1 |
|
| `hidden` | [Optional\<Hidden>](../../models/operations/Hidden.md) | :heavy_minus_sign: | The Plex library visibility setting | 1 |
|
||||||
| `location` | List\<[GetAllLibrariesLocation](../../models/operations/GetAllLibrariesLocation.md)> | :heavy_check_mark: | N/A | |
|
| `location` | List\<[GetAllLibrariesLocation](../../models/operations/GetAllLibrariesLocation.md)> | :heavy_check_mark: | N/A | |
|
||||||
@@ -5,11 +5,15 @@ The library type
|
|||||||
|
|
||||||
## Values
|
## Values
|
||||||
|
|
||||||
| Name | Value |
|
| Name | Value |
|
||||||
| --------- | --------- |
|
| ------------ | ------------ |
|
||||||
| `Movie` | movie |
|
| `Movie` | movie |
|
||||||
| `TvShow` | show |
|
| `TvShow` | show |
|
||||||
| `Season` | season |
|
| `Season` | season |
|
||||||
| `Episode` | episode |
|
| `Episode` | episode |
|
||||||
| `Artist` | artist |
|
| `Artist` | artist |
|
||||||
| `Album` | album |
|
| `Album` | album |
|
||||||
|
| `Track` | track |
|
||||||
|
| `PhotoAlbum` | photoalbum |
|
||||||
|
| `Photo` | photo |
|
||||||
|
| `Collection` | collection |
|
||||||
@@ -1,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,8 +0,0 @@
|
|||||||
# GetAllMediaLibraryGuids
|
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
|
||||||
| -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- |
|
|
||||||
| `id` | *Optional\<String>* | :heavy_minus_sign: | The unique identifier for the Guid. Can be imdb://tt0286347, tmdb://1763, tvdb://2337<br/> | tvdb://2337 |
|
|
||||||
@@ -1,10 +0,0 @@
|
|||||||
# GetAllMediaLibraryImage
|
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
|
||||||
| --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- |
|
|
||||||
| `alt` | *String* | :heavy_check_mark: | N/A | Episode 1 |
|
|
||||||
| `type` | [GetAllMediaLibraryLibraryResponseType](../../models/operations/GetAllMediaLibraryLibraryResponseType.md) | :heavy_check_mark: | N/A | background |
|
|
||||||
| `url` | *String* | :heavy_check_mark: | N/A | /library/metadata/45521/thumb/1644710589 |
|
|
||||||
@@ -1,16 +0,0 @@
|
|||||||
# GetAllMediaLibraryLibraryType
|
|
||||||
|
|
||||||
The type of media content
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## Values
|
|
||||||
|
|
||||||
| Name | Value |
|
|
||||||
| --------- | --------- |
|
|
||||||
| `Movie` | movie |
|
|
||||||
| `TvShow` | show |
|
|
||||||
| `Season` | season |
|
|
||||||
| `Episode` | episode |
|
|
||||||
| `Artist` | artist |
|
|
||||||
| `Album` | album |
|
|
||||||
@@ -1,26 +0,0 @@
|
|||||||
# GetAllMediaLibraryMedia
|
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
|
||||||
| ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ |
|
|
||||||
| `id` | *long* | :heavy_check_mark: | Unique media identifier. | 387322 |
|
|
||||||
| `duration` | *Optional\<Integer>* | :heavy_minus_sign: | Duration of the media in milliseconds. | 9610350 |
|
|
||||||
| `bitrate` | *Optional\<Integer>* | :heavy_minus_sign: | Bitrate in bits per second. | 25512 |
|
|
||||||
| `width` | *Optional\<Integer>* | :heavy_minus_sign: | Video width in pixels. | 3840 |
|
|
||||||
| `height` | *Optional\<Integer>* | :heavy_minus_sign: | Video height in pixels. | 1602 |
|
|
||||||
| `aspectRatio` | *Optional\<Float>* | :heavy_minus_sign: | Aspect ratio of the video. | 2.35 |
|
|
||||||
| `audioChannels` | *Optional\<Integer>* | :heavy_minus_sign: | Number of audio channels. | 6 |
|
|
||||||
| `displayOffset` | *Optional\<Integer>* | :heavy_minus_sign: | N/A | 50 |
|
|
||||||
| `audioCodec` | *Optional\<String>* | :heavy_minus_sign: | Audio codec used. | eac3 |
|
|
||||||
| `videoCodec` | *Optional\<String>* | :heavy_minus_sign: | Video codec used. | hevc |
|
|
||||||
| `videoResolution` | *Optional\<String>* | :heavy_minus_sign: | Video resolution (e.g., 4k). | 4k |
|
|
||||||
| `container` | *Optional\<String>* | :heavy_minus_sign: | File container type. | mkv |
|
|
||||||
| `videoFrameRate` | *Optional\<String>* | :heavy_minus_sign: | Frame rate of the video. Values found include NTSC, PAL, 24p<br/> | 24p |
|
|
||||||
| `videoProfile` | *Optional\<String>* | :heavy_minus_sign: | Video profile (e.g., main 10). | main 10 |
|
|
||||||
| `hasVoiceActivity` | *Optional\<Boolean>* | :heavy_minus_sign: | Indicates whether voice activity is detected. | false |
|
|
||||||
| `audioProfile` | *Optional\<String>* | :heavy_minus_sign: | The audio profile used for the media (e.g., DTS, Dolby Digital, etc.). | dts |
|
|
||||||
| `optimizedForStreaming` | [Optional\<GetAllMediaLibraryOptimizedForStreaming>](../../models/operations/GetAllMediaLibraryOptimizedForStreaming.md) | :heavy_minus_sign: | Has this media been optimized for streaming. NOTE: This can be 0, 1, false or true | |
|
|
||||||
| `has64bitOffsets` | *Optional\<Boolean>* | :heavy_minus_sign: | N/A | false |
|
|
||||||
| `part` | List\<[GetAllMediaLibraryPart](../../models/operations/GetAllMediaLibraryPart.md)> | :heavy_minus_sign: | An array of parts for this media item. | |
|
|
||||||
@@ -1,26 +0,0 @@
|
|||||||
# GetAllMediaLibraryMediaContainer
|
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
|
||||||
| ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- |
|
|
||||||
| `size` | *int* | :heavy_check_mark: | Number of media items returned in this response. | 50 |
|
|
||||||
| `totalSize` | *int* | :heavy_check_mark: | Total number of media items in the library. | 50 |
|
|
||||||
| `offset` | *long* | :heavy_check_mark: | Offset value for pagination. | 0 |
|
|
||||||
| `allowSync` | *boolean* | :heavy_check_mark: | Indicates whether syncing is allowed. | false |
|
|
||||||
| `art` | *String* | :heavy_check_mark: | URL for the background artwork of the media container. | /:/resources/show-fanart.jpg |
|
|
||||||
| `content` | *String* | :heavy_check_mark: | The content type or mode. | secondary |
|
|
||||||
| `identifier` | *String* | :heavy_check_mark: | An plugin identifier for the media container. | com.plexapp.plugins.library |
|
|
||||||
| `librarySectionID` | *long* | :heavy_check_mark: | The unique identifier for the library section. | 2 |
|
|
||||||
| `librarySectionTitle` | *String* | :heavy_check_mark: | The title of the library section. | TV Series |
|
|
||||||
| `librarySectionUUID` | *Optional\<String>* | :heavy_minus_sign: | The universally unique identifier for the library section. | e69655a2-ef48-4aba-bb19-0cc34d1e7d36 |
|
|
||||||
| `mediaTagPrefix` | *String* | :heavy_check_mark: | The prefix used for media tag resource paths. | /system/bundle/media/flags/ |
|
|
||||||
| `mediaTagVersion` | *long* | :heavy_check_mark: | The version number for media tags. | 1734362201 |
|
|
||||||
| `thumb` | *String* | :heavy_check_mark: | URL for the thumbnail image of the media container. | /:/resources/show.png |
|
|
||||||
| `nocache` | *boolean* | :heavy_check_mark: | Specifies whether caching is disabled. | true |
|
|
||||||
| `title1` | *String* | :heavy_check_mark: | The primary title of the media container. | TV Series |
|
|
||||||
| `title2` | *String* | :heavy_check_mark: | The secondary title of the media container. | By Starring Actor |
|
|
||||||
| `viewGroup` | *String* | :heavy_check_mark: | Identifier for the view group layout. | secondary |
|
|
||||||
| `meta` | [Optional\<GetAllMediaLibraryMeta>](../../models/operations/GetAllMediaLibraryMeta.md) | :heavy_minus_sign: | The Meta object is only included in the response if the `includeMeta` parameter is set to `1`.<br/> | |
|
|
||||||
| `metadata` | List\<[GetAllMediaLibraryMetadata](../../models/operations/GetAllMediaLibraryMetadata.md)> | :heavy_minus_sign: | An array of metadata items. | |
|
|
||||||
@@ -1,12 +0,0 @@
|
|||||||
# GetAllMediaLibraryMeta
|
|
||||||
|
|
||||||
The Meta object is only included in the response if the `includeMeta` parameter is set to `1`.
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description |
|
|
||||||
| -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- |
|
|
||||||
| `type` | List\<[GetAllMediaLibraryType](../../models/operations/GetAllMediaLibraryType.md)> | :heavy_minus_sign: | N/A |
|
|
||||||
| `fieldType` | List\<[GetAllMediaLibraryFieldType](../../models/operations/GetAllMediaLibraryFieldType.md)> | :heavy_minus_sign: | N/A |
|
|
||||||
@@ -1,23 +0,0 @@
|
|||||||
# GetAllMediaLibraryPart
|
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
|
||||||
| -------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- |
|
|
||||||
| `accessible` | *Optional\<Boolean>* | :heavy_minus_sign: | Indicates if the part is accessible. | true |
|
|
||||||
| `exists` | *Optional\<Boolean>* | :heavy_minus_sign: | Indicates if the part exists. | true |
|
|
||||||
| `id` | *long* | :heavy_check_mark: | Unique part identifier. | 418385 |
|
|
||||||
| `key` | *String* | :heavy_check_mark: | Key to access this part. | /library/parts/418385/1735864239/file.mkv |
|
|
||||||
| `indexes` | *Optional\<String>* | :heavy_minus_sign: | N/A | sd |
|
|
||||||
| `duration` | *Optional\<Integer>* | :heavy_minus_sign: | Duration of the part in milliseconds. | 9610350 |
|
|
||||||
| `file` | *String* | :heavy_check_mark: | File path for the part. | /mnt/Movies_1/W/Wicked (2024).mkv |
|
|
||||||
| `size` | *long* | :heavy_check_mark: | File size in bytes. | 30649952104 |
|
|
||||||
| `packetLength` | *Optional\<Integer>* | :heavy_minus_sign: | N/A | 188 |
|
|
||||||
| `container` | *Optional\<String>* | :heavy_minus_sign: | Container format of the part. | mkv |
|
|
||||||
| `videoProfile` | *Optional\<String>* | :heavy_minus_sign: | Video profile for the part. | main 10 |
|
|
||||||
| `audioProfile` | *Optional\<String>* | :heavy_minus_sign: | The audio profile used for the media (e.g., DTS, Dolby Digital, etc.). | dts |
|
|
||||||
| `has64bitOffsets` | *Optional\<Boolean>* | :heavy_minus_sign: | N/A | false |
|
|
||||||
| `optimizedForStreaming` | [Optional\<GetAllMediaLibraryLibraryOptimizedForStreaming>](../../models/operations/GetAllMediaLibraryLibraryOptimizedForStreaming.md) | :heavy_minus_sign: | Has this media been optimized for streaming. NOTE: This can be 0, 1, false or true | |
|
|
||||||
| `hasThumbnail` | [Optional\<GetAllMediaLibraryHasThumbnail>](../../models/operations/GetAllMediaLibraryHasThumbnail.md) | :heavy_minus_sign: | N/A | 1 |
|
|
||||||
| `stream` | List\<[GetAllMediaLibraryStream](../../models/operations/GetAllMediaLibraryStream.md)> | :heavy_minus_sign: | An array of streams for this part. | |
|
|
||||||
@@ -1,22 +0,0 @@
|
|||||||
# GetAllMediaLibraryQueryParamType
|
|
||||||
|
|
||||||
The type of media to retrieve or filter by.
|
|
||||||
1 = movie
|
|
||||||
2 = show
|
|
||||||
3 = season
|
|
||||||
4 = episode
|
|
||||||
E.g. A movie library will not return anything with type 3 as there are no seasons for movie libraries
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## Values
|
|
||||||
|
|
||||||
| Name | Value |
|
|
||||||
| --------- | --------- |
|
|
||||||
| `Movie` | 1 |
|
|
||||||
| `TvShow` | 2 |
|
|
||||||
| `Season` | 3 |
|
|
||||||
| `Episode` | 4 |
|
|
||||||
| `Audio` | 8 |
|
|
||||||
| `Album` | 9 |
|
|
||||||
| `Track` | 10 |
|
|
||||||
@@ -1,10 +0,0 @@
|
|||||||
# GetAllMediaLibraryResponseBody
|
|
||||||
|
|
||||||
Successful response containing media container data.
|
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description |
|
|
||||||
| ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- |
|
|
||||||
| `mediaContainer` | [Optional\<GetAllMediaLibraryMediaContainer>](../../models/operations/GetAllMediaLibraryMediaContainer.md) | :heavy_minus_sign: | N/A |
|
|
||||||
@@ -1,15 +0,0 @@
|
|||||||
# GetAllMediaLibrarySort
|
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
|
||||||
| -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- |
|
|
||||||
| `default_` | *Optional\<String>* | :heavy_minus_sign: | N/A | asc |
|
|
||||||
| `active` | *Optional\<Boolean>* | :heavy_minus_sign: | N/A | false |
|
|
||||||
| `activeDirection` | [Optional\<GetAllMediaLibraryActiveDirection>](../../models/operations/GetAllMediaLibraryActiveDirection.md) | :heavy_minus_sign: | The direction of the sort. Can be either `asc` or `desc`.<br/> | asc |
|
|
||||||
| `defaultDirection` | [Optional\<GetAllMediaLibraryDefaultDirection>](../../models/operations/GetAllMediaLibraryDefaultDirection.md) | :heavy_minus_sign: | The direction of the sort. Can be either `asc` or `desc`.<br/> | asc |
|
|
||||||
| `descKey` | *Optional\<String>* | :heavy_minus_sign: | N/A | titleSort:desc |
|
|
||||||
| `firstCharacterKey` | *Optional\<String>* | :heavy_minus_sign: | N/A | /library/sections/2/firstCharacter |
|
|
||||||
| `key` | *String* | :heavy_check_mark: | N/A | titleSort |
|
|
||||||
| `title` | *String* | :heavy_check_mark: | N/A | Title |
|
|
||||||
@@ -1,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 |
|
||||||
@@ -9,5 +9,4 @@
|
|||||||
| `filterType` | *String* | :heavy_check_mark: | N/A | string |
|
| `filterType` | *String* | :heavy_check_mark: | N/A | string |
|
||||||
| `key` | *String* | :heavy_check_mark: | N/A | /library/sections/2/genre?type=2 |
|
| `key` | *String* | :heavy_check_mark: | N/A | /library/sections/2/genre?type=2 |
|
||||||
| `title` | *String* | :heavy_check_mark: | N/A | Genre |
|
| `title` | *String* | :heavy_check_mark: | N/A | Genre |
|
||||||
| `type` | *String* | :heavy_check_mark: | N/A | filter |
|
| `type` | *String* | :heavy_check_mark: | N/A | filter |
|
||||||
| `advanced` | *Optional\<Boolean>* | :heavy_minus_sign: | N/A | true |
|
|
||||||
@@ -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/> | |
|
||||||
@@ -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,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\<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). | 1 |
|
| `index` | *int* | :heavy_check_mark: | The index position of the media item. | 1 |
|
||||||
| `episodeSort` | [Optional\<EpisodeSort>](../../models/operations/EpisodeSort.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\<EnableCreditsMarkerGeneration>](../../models/operations/EnableCreditsMarkerGeneration.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\<ShowOrdering>](../../models/operations/ShowOrdering.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\<[MediaGuid](../../models/operations/MediaGuid.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\<[MetaDataRating](../../models/operations/MetaDataRating.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 |
|
|
||||||
10
docs/models/operations/GetLibraryItemsSimilar.md
Normal file
10
docs/models/operations/GetLibraryItemsSimilar.md
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
# GetLibraryItemsSimilar
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ---------------------------------------- | ---------------------------------------- | ---------------------------------------- | ---------------------------------------- | ---------------------------------------- |
|
||||||
|
| `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
|
||||||
@@ -1,4 +1,4 @@
|
|||||||
# GetAllMediaLibraryGenre
|
# GetLibrarySectionsAllGenre
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
8
docs/models/operations/GetLibrarySectionsAllGuids.md
Normal file
8
docs/models/operations/GetLibrarySectionsAllGuids.md
Normal file
@@ -0,0 +1,8 @@
|
|||||||
|
# GetLibrarySectionsAllGuids
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||||
|
| `id` | *String* | :heavy_check_mark: | The unique identifier for the Guid. Can be prefixed with imdb://, tmdb://, tvdb://<br/> | {<br/>"imdbExample": {<br/>"summary": "IMDB example",<br/>"value": "imdb://tt13015952"<br/>},<br/>"tmdbExample": {<br/>"summary": "TMDB example",<br/>"value": "tmdb://2434012"<br/>},<br/>"tvdbExample": {<br/>"summary": "TVDB example",<br/>"value": "tvdb://7945991"<br/>}<br/>} |
|
||||||
@@ -1,4 +1,4 @@
|
|||||||
# GetAllMediaLibraryHasThumbnail
|
# GetLibrarySectionsAllHasThumbnail
|
||||||
|
|
||||||
Indicates if the part has a thumbnail.
|
Indicates if the part has a thumbnail.
|
||||||
|
|
||||||
10
docs/models/operations/GetLibrarySectionsAllImage.md
Normal file
10
docs/models/operations/GetLibrarySectionsAllImage.md
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
# GetLibrarySectionsAllImage
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| --------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- |
|
||||||
|
| `alt` | *String* | :heavy_check_mark: | N/A | Episode 1 |
|
||||||
|
| `type` | [GetLibrarySectionsAllLibraryResponseType](../../models/operations/GetLibrarySectionsAllLibraryResponseType.md) | :heavy_check_mark: | N/A | background |
|
||||||
|
| `url` | *String* | :heavy_check_mark: | N/A | /library/metadata/45521/thumb/1644710589 |
|
||||||
@@ -0,0 +1,4 @@
|
|||||||
|
# GetLibrarySectionsAllLibraryOptimizedForStreaming
|
||||||
|
|
||||||
|
Has this media been optimized for streaming. NOTE: This can be 0, 1, false or true
|
||||||
|
|
||||||
@@ -1,4 +1,4 @@
|
|||||||
# GetLibraryItemsLibraryResponse200Type
|
# GetLibrarySectionsAllLibraryResponseType
|
||||||
|
|
||||||
|
|
||||||
## Values
|
## Values
|
||||||
20
docs/models/operations/GetLibrarySectionsAllLibraryType.md
Normal file
20
docs/models/operations/GetLibrarySectionsAllLibraryType.md
Normal file
@@ -0,0 +1,20 @@
|
|||||||
|
# GetLibrarySectionsAllLibraryType
|
||||||
|
|
||||||
|
The type of media content in the Plex library. This can represent videos, music, or photos.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
## Values
|
||||||
|
|
||||||
|
| Name | Value |
|
||||||
|
| ------------ | ------------ |
|
||||||
|
| `Movie` | movie |
|
||||||
|
| `TvShow` | show |
|
||||||
|
| `Season` | season |
|
||||||
|
| `Episode` | episode |
|
||||||
|
| `Artist` | artist |
|
||||||
|
| `Album` | album |
|
||||||
|
| `Track` | track |
|
||||||
|
| `PhotoAlbum` | photoalbum |
|
||||||
|
| `Photo` | photo |
|
||||||
|
| `Collection` | collection |
|
||||||
26
docs/models/operations/GetLibrarySectionsAllMedia.md
Normal file
26
docs/models/operations/GetLibrarySectionsAllMedia.md
Normal file
@@ -0,0 +1,26 @@
|
|||||||
|
# GetLibrarySectionsAllMedia
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ |
|
||||||
|
| `id` | *long* | :heavy_check_mark: | Unique media identifier. | 387322 |
|
||||||
|
| `duration` | *Optional\<Integer>* | :heavy_minus_sign: | Duration of the media in milliseconds. | 9610350 |
|
||||||
|
| `bitrate` | *Optional\<Integer>* | :heavy_minus_sign: | Bitrate in bits per second. | 25512 |
|
||||||
|
| `width` | *Optional\<Integer>* | :heavy_minus_sign: | Video width in pixels. | 3840 |
|
||||||
|
| `height` | *Optional\<Integer>* | :heavy_minus_sign: | Video height in pixels. | 1602 |
|
||||||
|
| `aspectRatio` | *Optional\<Float>* | :heavy_minus_sign: | Aspect ratio of the video. | 2.35 |
|
||||||
|
| `audioChannels` | *Optional\<Integer>* | :heavy_minus_sign: | Number of audio channels. | 6 |
|
||||||
|
| `displayOffset` | *Optional\<Integer>* | :heavy_minus_sign: | N/A | 50 |
|
||||||
|
| `audioCodec` | *Optional\<String>* | :heavy_minus_sign: | Audio codec used. | eac3 |
|
||||||
|
| `videoCodec` | *Optional\<String>* | :heavy_minus_sign: | Video codec used. | hevc |
|
||||||
|
| `videoResolution` | *Optional\<String>* | :heavy_minus_sign: | Video resolution (e.g., 4k). | 4k |
|
||||||
|
| `container` | *Optional\<String>* | :heavy_minus_sign: | File container type. | mkv |
|
||||||
|
| `videoFrameRate` | *Optional\<String>* | :heavy_minus_sign: | Frame rate of the video. Values found include NTSC, PAL, 24p<br/> | 24p |
|
||||||
|
| `videoProfile` | *Optional\<String>* | :heavy_minus_sign: | Video profile (e.g., main 10). | main 10 |
|
||||||
|
| `hasVoiceActivity` | *Optional\<Boolean>* | :heavy_minus_sign: | Indicates whether voice activity is detected. | false |
|
||||||
|
| `audioProfile` | *Optional\<String>* | :heavy_minus_sign: | The audio profile used for the media (e.g., DTS, Dolby Digital, etc.). | dts |
|
||||||
|
| `optimizedForStreaming` | [Optional\<GetLibrarySectionsAllOptimizedForStreaming>](../../models/operations/GetLibrarySectionsAllOptimizedForStreaming.md) | :heavy_minus_sign: | Has this media been optimized for streaming. NOTE: This can be 0, 1, false or true | |
|
||||||
|
| `has64bitOffsets` | *Optional\<Boolean>* | :heavy_minus_sign: | N/A | false |
|
||||||
|
| `part` | List\<[GetLibrarySectionsAllPart](../../models/operations/GetLibrarySectionsAllPart.md)> | :heavy_minus_sign: | An array of parts for this media item. | |
|
||||||
@@ -0,0 +1,26 @@
|
|||||||
|
# GetLibrarySectionsAllMediaContainer
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ |
|
||||||
|
| `size` | *int* | :heavy_check_mark: | Number of media items returned in this response. | 50 |
|
||||||
|
| `totalSize` | *int* | :heavy_check_mark: | Total number of media items in the library. | 50 |
|
||||||
|
| `offset` | *long* | :heavy_check_mark: | Offset value for pagination. | 0 |
|
||||||
|
| `allowSync` | *boolean* | :heavy_check_mark: | Indicates whether syncing is allowed. | false |
|
||||||
|
| `art` | *String* | :heavy_check_mark: | URL for the background artwork of the media container. | /:/resources/show-fanart.jpg |
|
||||||
|
| `content` | *String* | :heavy_check_mark: | The content type or mode. | secondary |
|
||||||
|
| `identifier` | *String* | :heavy_check_mark: | An plugin identifier for the media container. | com.plexapp.plugins.library |
|
||||||
|
| `librarySectionID` | *Optional\<Long>* | :heavy_minus_sign: | The unique identifier for the library section. | 2 |
|
||||||
|
| `librarySectionTitle` | *Optional\<String>* | :heavy_minus_sign: | The title of the library section. | TV Series |
|
||||||
|
| `librarySectionUUID` | *Optional\<String>* | :heavy_minus_sign: | The universally unique identifier for the library section. | e69655a2-ef48-4aba-bb19-0cc34d1e7d36 |
|
||||||
|
| `mediaTagPrefix` | *String* | :heavy_check_mark: | The prefix used for media tag resource paths. | /system/bundle/media/flags/ |
|
||||||
|
| `mediaTagVersion` | *long* | :heavy_check_mark: | The version number for media tags. | 1734362201 |
|
||||||
|
| `thumb` | *String* | :heavy_check_mark: | URL for the thumbnail image of the media container. | /:/resources/show.png |
|
||||||
|
| `nocache` | *boolean* | :heavy_check_mark: | Specifies whether caching is disabled. | true |
|
||||||
|
| `title1` | *String* | :heavy_check_mark: | The primary title of the media container. | TV Series |
|
||||||
|
| `title2` | *String* | :heavy_check_mark: | The secondary title of the media container. | By Starring Actor |
|
||||||
|
| `viewGroup` | *String* | :heavy_check_mark: | Identifier for the view group layout. | secondary |
|
||||||
|
| `meta` | [Optional\<GetLibrarySectionsAllMeta>](../../models/operations/GetLibrarySectionsAllMeta.md) | :heavy_minus_sign: | The Meta object is only included in the response if the `includeMeta` parameter is set to `1`.<br/> | |
|
||||||
|
| `metadata` | List\<[GetLibrarySectionsAllMetadata](../../models/operations/GetLibrarySectionsAllMetadata.md)> | :heavy_minus_sign: | An array of metadata items. | |
|
||||||
@@ -1,9 +1,12 @@
|
|||||||
# GetLibraryItemsLibraryFieldType
|
# GetLibrarySectionsAllMeta
|
||||||
|
|
||||||
|
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 |
|
||||||
| -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- |
|
| -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- |
|
||||||
| `type` | *String* | :heavy_check_mark: | N/A | tag |
|
| `type` | List\<[GetLibrarySectionsAllType](../../models/operations/GetLibrarySectionsAllType.md)> | :heavy_minus_sign: | N/A |
|
||||||
| `operator` | List\<[GetLibraryItemsLibraryOperator](../../models/operations/GetLibraryItemsLibraryOperator.md)> | :heavy_check_mark: | N/A | |
|
| `fieldType` | List\<[GetLibrarySectionsAllFieldType](../../models/operations/GetLibrarySectionsAllFieldType.md)> | :heavy_minus_sign: | N/A |
|
||||||
@@ -1,4 +1,4 @@
|
|||||||
# GetAllMediaLibraryMetadata
|
# GetLibrarySectionsAllMetadata
|
||||||
|
|
||||||
Unknown
|
Unknown
|
||||||
|
|
||||||
@@ -13,7 +13,7 @@ Unknown
|
|||||||
| `guid` | *String* | :heavy_check_mark: | The globally unique identifier for the media item. | plex://movie/5d7768ba96b655001fdc0408 |
|
| `guid` | *String* | :heavy_check_mark: | The globally unique identifier for the media item. | plex://movie/5d7768ba96b655001fdc0408 |
|
||||||
| `slug` | *String* | :heavy_check_mark: | A URL‐friendly version of the media title. | 4-for-texas |
|
| `slug` | *String* | :heavy_check_mark: | A URL‐friendly version of the media title. | 4-for-texas |
|
||||||
| `studio` | *Optional\<String>* | :heavy_minus_sign: | The studio that produced the media item. | 20th Century Studios |
|
| `studio` | *Optional\<String>* | :heavy_minus_sign: | The studio that produced the media item. | 20th Century Studios |
|
||||||
| `type` | [GetAllMediaLibraryLibraryType](../../models/operations/GetAllMediaLibraryLibraryType.md) | :heavy_check_mark: | N/A | movie |
|
| `type` | [GetLibrarySectionsAllLibraryType](../../models/operations/GetLibrarySectionsAllLibraryType.md) | :heavy_check_mark: | N/A | movie |
|
||||||
| `title` | *String* | :heavy_check_mark: | The title of the media item. | Avatar: The Way of Water |
|
| `title` | *String* | :heavy_check_mark: | The title of the media item. | Avatar: The Way of Water |
|
||||||
| `titleSort` | *String* | :heavy_check_mark: | The sort title used for ordering media items. | Whale |
|
| `titleSort` | *String* | :heavy_check_mark: | The sort title used for ordering media items. | Whale |
|
||||||
| `contentRating` | *Optional\<String>* | :heavy_minus_sign: | The content rating for the media item. | PG-13 |
|
| `contentRating` | *Optional\<String>* | :heavy_minus_sign: | The content rating for the media item. | PG-13 |
|
||||||
@@ -31,7 +31,7 @@ Unknown
|
|||||||
| `childCount` | *int* | :heavy_check_mark: | The number of child items associated with this media item. | 1 |
|
| `childCount` | *int* | :heavy_check_mark: | The number of child items associated with this media item. | 1 |
|
||||||
| `seasonCount` | *int* | :heavy_check_mark: | The total number of seasons (for TV shows). | 2022 |
|
| `seasonCount` | *int* | :heavy_check_mark: | The total number of seasons (for TV shows). | 2022 |
|
||||||
| `duration` | *int* | :heavy_check_mark: | The duration of the media item in milliseconds. | 11558112 |
|
| `duration` | *int* | :heavy_check_mark: | The duration of the media item in milliseconds. | 11558112 |
|
||||||
| `originallyAvailableAt` | [LocalDate](https://docs.oracle.com/javase/8/docs/api/java/time/LocalDate.html) | :heavy_check_mark: | The original release date of the media item. | 2022-12-14 |
|
| `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 |
|
||||||
| `addedAt` | *long* | :heavy_check_mark: | N/A | 1556281940 |
|
| `addedAt` | *long* | :heavy_check_mark: | N/A | 1556281940 |
|
||||||
| `updatedAt` | *Optional\<Long>* | :heavy_minus_sign: | Unix epoch datetime in seconds | 1556281940 |
|
| `updatedAt` | *Optional\<Long>* | :heavy_minus_sign: | Unix epoch datetime in seconds | 1556281940 |
|
||||||
| `audienceRatingImage` | *Optional\<String>* | :heavy_minus_sign: | The URL for the audience rating image. | rottentomatoes://image.rating.upright |
|
| `audienceRatingImage` | *Optional\<String>* | :heavy_minus_sign: | The URL for the audience rating image. | rottentomatoes://image.rating.upright |
|
||||||
@@ -62,13 +62,13 @@ Unknown
|
|||||||
| `createdAtTZOffset` | *Optional\<String>* | :heavy_minus_sign: | The time zone offset for the creation timestamp, represented as a string. This offset indicates the difference from UTC. | 0 |
|
| `createdAtTZOffset` | *Optional\<String>* | :heavy_minus_sign: | The time zone offset for the creation timestamp, represented as a string. This offset indicates the difference from UTC. | 0 |
|
||||||
| `lastViewedAt` | *Optional\<Integer>* | :heavy_minus_sign: | Unix timestamp for when the media item was last viewed. | 1682752242 |
|
| `lastViewedAt` | *Optional\<Integer>* | :heavy_minus_sign: | Unix timestamp for when the media item was last viewed. | 1682752242 |
|
||||||
| `userRating` | *Optional\<Float>* | :heavy_minus_sign: | The rating provided by a user for the item. This value is expressed as a decimal number. | 10 |
|
| `userRating` | *Optional\<Float>* | :heavy_minus_sign: | The rating provided by a user for the item. This value is expressed as a decimal number. | 10 |
|
||||||
| `image` | List\<[GetAllMediaLibraryImage](../../models/operations/GetAllMediaLibraryImage.md)> | :heavy_minus_sign: | N/A | |
|
| `image` | List\<[GetLibrarySectionsAllImage](../../models/operations/GetLibrarySectionsAllImage.md)> | :heavy_minus_sign: | N/A | |
|
||||||
| `ultraBlurColors` | [Optional\<GetAllMediaLibraryUltraBlurColors>](../../models/operations/GetAllMediaLibraryUltraBlurColors.md) | :heavy_minus_sign: | N/A | |
|
| `ultraBlurColors` | [Optional\<GetLibrarySectionsAllUltraBlurColors>](../../models/operations/GetLibrarySectionsAllUltraBlurColors.md) | :heavy_minus_sign: | N/A | |
|
||||||
| `media` | List\<[GetAllMediaLibraryMedia](../../models/operations/GetAllMediaLibraryMedia.md)> | :heavy_minus_sign: | N/A | |
|
| `guids` | List\<[GetLibrarySectionsAllGuids](../../models/operations/GetLibrarySectionsAllGuids.md)> | :heavy_minus_sign: | N/A | |
|
||||||
| `genre` | List\<[GetAllMediaLibraryGenre](../../models/operations/GetAllMediaLibraryGenre.md)> | :heavy_minus_sign: | N/A | |
|
| `media` | List\<[GetLibrarySectionsAllMedia](../../models/operations/GetLibrarySectionsAllMedia.md)> | :heavy_minus_sign: | N/A | |
|
||||||
| `country` | List\<[GetAllMediaLibraryCountry](../../models/operations/GetAllMediaLibraryCountry.md)> | :heavy_minus_sign: | N/A | |
|
| `genre` | List\<[GetLibrarySectionsAllGenre](../../models/operations/GetLibrarySectionsAllGenre.md)> | :heavy_minus_sign: | N/A | |
|
||||||
| `director` | List\<[GetAllMediaLibraryDirector](../../models/operations/GetAllMediaLibraryDirector.md)> | :heavy_minus_sign: | N/A | |
|
| `country` | List\<[GetLibrarySectionsAllCountry](../../models/operations/GetLibrarySectionsAllCountry.md)> | :heavy_minus_sign: | N/A | |
|
||||||
| `writer` | List\<[GetAllMediaLibraryWriter](../../models/operations/GetAllMediaLibraryWriter.md)> | :heavy_minus_sign: | N/A | |
|
| `director` | List\<[GetLibrarySectionsAllDirector](../../models/operations/GetLibrarySectionsAllDirector.md)> | :heavy_minus_sign: | N/A | |
|
||||||
| `role` | List\<[GetAllMediaLibraryRole](../../models/operations/GetAllMediaLibraryRole.md)> | :heavy_minus_sign: | N/A | |
|
| `writer` | List\<[GetLibrarySectionsAllWriter](../../models/operations/GetLibrarySectionsAllWriter.md)> | :heavy_minus_sign: | N/A | |
|
||||||
| `guids` | List\<[GetAllMediaLibraryGuids](../../models/operations/GetAllMediaLibraryGuids.md)> | :heavy_minus_sign: | N/A | |
|
| `role` | List\<[GetLibrarySectionsAllRole](../../models/operations/GetLibrarySectionsAllRole.md)> | :heavy_minus_sign: | N/A | |
|
||||||
| `collection` | List\<[GetAllMediaLibraryCollection](../../models/operations/GetAllMediaLibraryCollection.md)> | :heavy_minus_sign: | N/A | |
|
| `collection` | List\<[GetLibrarySectionsAllCollection](../../models/operations/GetLibrarySectionsAllCollection.md)> | :heavy_minus_sign: | N/A | |
|
||||||
@@ -1,4 +1,4 @@
|
|||||||
# GetAllMediaLibraryOperator
|
# GetLibrarySectionsAllOperator
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
@@ -1,4 +1,4 @@
|
|||||||
# GetAllMediaLibraryOptimizedForStreaming
|
# GetLibrarySectionsAllOptimizedForStreaming
|
||||||
|
|
||||||
Has this media been optimized for streaming. NOTE: This can be 0, 1, false or true
|
Has this media been optimized for streaming. NOTE: This can be 0, 1, false or true
|
||||||
|
|
||||||
@@ -0,0 +1,9 @@
|
|||||||
|
# GetLibrarySectionsAllOptimizedForStreaming1
|
||||||
|
|
||||||
|
|
||||||
|
## Values
|
||||||
|
|
||||||
|
| Name | Value |
|
||||||
|
| ------ | ------ |
|
||||||
|
| `ZERO` | 0 |
|
||||||
|
| `ONE` | 1 |
|
||||||
@@ -0,0 +1,9 @@
|
|||||||
|
# GetLibrarySectionsAllOptimizedForStreamingLibrary1
|
||||||
|
|
||||||
|
|
||||||
|
## Values
|
||||||
|
|
||||||
|
| Name | Value |
|
||||||
|
| ------ | ------ |
|
||||||
|
| `ZERO` | 0 |
|
||||||
|
| `ONE` | 1 |
|
||||||
23
docs/models/operations/GetLibrarySectionsAllPart.md
Normal file
23
docs/models/operations/GetLibrarySectionsAllPart.md
Normal file
@@ -0,0 +1,23 @@
|
|||||||
|
# GetLibrarySectionsAllPart
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| -------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||||
|
| `accessible` | *Optional\<Boolean>* | :heavy_minus_sign: | Indicates if the part is accessible. | true |
|
||||||
|
| `exists` | *Optional\<Boolean>* | :heavy_minus_sign: | Indicates if the part exists. | true |
|
||||||
|
| `id` | *long* | :heavy_check_mark: | Unique part identifier. | 418385 |
|
||||||
|
| `key` | *String* | :heavy_check_mark: | Key to access this part. | /library/parts/418385/1735864239/file.mkv |
|
||||||
|
| `indexes` | *Optional\<String>* | :heavy_minus_sign: | N/A | sd |
|
||||||
|
| `duration` | *Optional\<Integer>* | :heavy_minus_sign: | Duration of the part in milliseconds. | 9610350 |
|
||||||
|
| `file` | *String* | :heavy_check_mark: | File path for the part. | /mnt/Movies_1/W/Wicked (2024).mkv |
|
||||||
|
| `size` | *long* | :heavy_check_mark: | File size in bytes. | 30649952104 |
|
||||||
|
| `packetLength` | *Optional\<Integer>* | :heavy_minus_sign: | N/A | 188 |
|
||||||
|
| `container` | *Optional\<String>* | :heavy_minus_sign: | Container format of the part. | mkv |
|
||||||
|
| `videoProfile` | *Optional\<String>* | :heavy_minus_sign: | Video profile for the part. | main 10 |
|
||||||
|
| `audioProfile` | *Optional\<String>* | :heavy_minus_sign: | The audio profile used for the media (e.g., DTS, Dolby Digital, etc.). | dts |
|
||||||
|
| `has64bitOffsets` | *Optional\<Boolean>* | :heavy_minus_sign: | N/A | false |
|
||||||
|
| `optimizedForStreaming` | [Optional\<GetLibrarySectionsAllLibraryOptimizedForStreaming>](../../models/operations/GetLibrarySectionsAllLibraryOptimizedForStreaming.md) | :heavy_minus_sign: | Has this media been optimized for streaming. NOTE: This can be 0, 1, false or true | |
|
||||||
|
| `hasThumbnail` | [Optional\<GetLibrarySectionsAllHasThumbnail>](../../models/operations/GetLibrarySectionsAllHasThumbnail.md) | :heavy_minus_sign: | N/A | 1 |
|
||||||
|
| `stream` | List\<[GetLibrarySectionsAllStream](../../models/operations/GetLibrarySectionsAllStream.md)> | :heavy_minus_sign: | An array of streams for this part. | |
|
||||||
@@ -1,4 +1,4 @@
|
|||||||
# GetAllMediaLibraryQueryParamIncludeMeta
|
# GetLibrarySectionsAllQueryParamIncludeMeta
|
||||||
|
|
||||||
Adds the Meta object to the response
|
Adds the Meta object to the response
|
||||||
|
|
||||||
@@ -0,0 +1,24 @@
|
|||||||
|
# GetLibrarySectionsAllQueryParamType
|
||||||
|
|
||||||
|
The type of media to retrieve or filter by.
|
||||||
|
1 = movie
|
||||||
|
2 = show
|
||||||
|
3 = season
|
||||||
|
4 = episode
|
||||||
|
E.g. A movie library will not return anything with type 3 as there are no seasons for movie libraries
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
## Values
|
||||||
|
|
||||||
|
| Name | Value |
|
||||||
|
| ------------ | ------------ |
|
||||||
|
| `Movie` | 1 |
|
||||||
|
| `TvShow` | 2 |
|
||||||
|
| `Season` | 3 |
|
||||||
|
| `Episode` | 4 |
|
||||||
|
| `Artist` | 5 |
|
||||||
|
| `Album` | 6 |
|
||||||
|
| `Track` | 7 |
|
||||||
|
| `PhotoAlbum` | 8 |
|
||||||
|
| `Photo` | 9 |
|
||||||
@@ -1,4 +1,4 @@
|
|||||||
# GetAllMediaLibraryRequest
|
# GetLibrarySectionsAllRequest
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
@@ -6,8 +6,8 @@
|
|||||||
| Field | Type | Required | Description | Example |
|
| Field | Type | Required | Description | Example |
|
||||||
| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||||
| `sectionKey` | *int* | :heavy_check_mark: | The unique key of the Plex library. <br/>Note: This is unique in the context of the Plex server.<br/> | 9518 |
|
| `sectionKey` | *int* | :heavy_check_mark: | The unique key of the Plex library. <br/>Note: This is unique in the context of the Plex server.<br/> | 9518 |
|
||||||
| `type` | [GetAllMediaLibraryQueryParamType](../../models/operations/GetAllMediaLibraryQueryParamType.md) | :heavy_check_mark: | The type of media to retrieve or filter by.<br/>1 = movie<br/>2 = show<br/>3 = season<br/>4 = episode<br/>E.g. A movie library will not return anything with type 3 as there are no seasons for movie libraries<br/> | 2 |
|
| `type` | [GetLibrarySectionsAllQueryParamType](../../models/operations/GetLibrarySectionsAllQueryParamType.md) | :heavy_check_mark: | The type of media to retrieve or filter by.<br/>1 = movie<br/>2 = show<br/>3 = season<br/>4 = episode<br/>E.g. A movie library will not return anything with type 3 as there are no seasons for movie libraries<br/> | 2 |
|
||||||
| `includeMeta` | [Optional\<GetAllMediaLibraryQueryParamIncludeMeta>](../../models/operations/GetAllMediaLibraryQueryParamIncludeMeta.md) | :heavy_minus_sign: | Adds the Meta object to the response<br/> | 1 |
|
| `includeMeta` | [Optional\<GetLibrarySectionsAllQueryParamIncludeMeta>](../../models/operations/GetLibrarySectionsAllQueryParamIncludeMeta.md) | :heavy_minus_sign: | Adds the Meta object to the response<br/> | 1 |
|
||||||
| `includeGuids` | [Optional\<QueryParamIncludeGuids>](../../models/operations/QueryParamIncludeGuids.md) | :heavy_minus_sign: | Adds the Guid object to the response<br/> | 1 |
|
| `includeGuids` | [Optional\<QueryParamIncludeGuids>](../../models/operations/QueryParamIncludeGuids.md) | :heavy_minus_sign: | Adds the Guid object to the response<br/> | 1 |
|
||||||
| `includeAdvanced` | [Optional\<IncludeAdvanced>](../../models/operations/IncludeAdvanced.md) | :heavy_minus_sign: | N/A | 1 |
|
| `includeAdvanced` | [Optional\<IncludeAdvanced>](../../models/operations/IncludeAdvanced.md) | :heavy_minus_sign: | N/A | 1 |
|
||||||
| `includeCollections` | [Optional\<QueryParamIncludeCollections>](../../models/operations/QueryParamIncludeCollections.md) | :heavy_minus_sign: | N/A | 1 |
|
| `includeCollections` | [Optional\<QueryParamIncludeCollections>](../../models/operations/QueryParamIncludeCollections.md) | :heavy_minus_sign: | N/A | 1 |
|
||||||
@@ -1,4 +1,4 @@
|
|||||||
# GetAllMediaLibraryResponse
|
# GetLibrarySectionsAllResponse
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
@@ -8,4 +8,4 @@
|
|||||||
| `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation |
|
| `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation |
|
||||||
| `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation |
|
| `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation |
|
||||||
| `rawResponse` | [HttpResponse\<InputStream>](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
|
| `rawResponse` | [HttpResponse\<InputStream>](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
|
||||||
| `object` | [Optional\<GetAllMediaLibraryResponseBody>](../../models/operations/GetAllMediaLibraryResponseBody.md) | :heavy_minus_sign: | Successful response containing media container data. |
|
| `object` | [Optional\<GetLibrarySectionsAllResponseBody>](../../models/operations/GetLibrarySectionsAllResponseBody.md) | :heavy_minus_sign: | Successful response containing media container data. |
|
||||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user