LukeParke/plexjava
1
0
Fork 0
mirror of https://github.com/LukeHagar/plexjava.git synced 2025-12-09 12:37:47 +00:00
Code Issues Packages Projects Releases Wiki Activity

regerated and working on publishing

Browse Source
This commit is contained in:
Luke Hagar
2024-09-08 02:40:34 +00:00
parent 02ce124a6b
commit ac5716c20d
1312 changed files with 65980 additions and 37728 deletions
Download Patch File Download Diff File Expand all files Collapse all files

233
docs/sdks/media/README.md
View File

@@ -11,6 +11,8 @@ API Calls interacting with Plex Media Server Media
* [markPlayed](#markplayed) - Mark Media Played
* [markUnplayed](#markunplayed) - Mark Media Unplayed
* [updatePlayProgress](#updateplayprogress) - Update Media Play Progress
* [getBannerImage](#getbannerimage) - Get Banner Image
* [getThumbImage](#getthumbimage) - Get Thumb Image
## markPlayed
@@ -21,19 +23,10 @@ This will mark the provided media key as Played.
```java
package hello.world;
import java.math.BigDecimal;
import java.math.BigDecimal;
import java.math.BigInteger;
import java.time.LocalDate;
import java.time.OffsetDateTime;
import java.util.Optional;
import lukehagar.plexapi.plexapi.PlexAPI;
import lukehagar.plexapi.plexapi.models.operations.*;
import lukehagar.plexapi.plexapi.models.shared.*;
import lukehagar.plexapi.plexapi.models.shared.Security;
import lukehagar.plexapi.plexapi.utils.EventStream;
import org.openapitools.jackson.nullable.JsonNullable;
import static java.util.Map.entry;
import dev.plexapi.sdk.PlexAPI;
import dev.plexapi.sdk.models.errors.SDKError;
import dev.plexapi.sdk.models.operations.MarkPlayedResponse;
import java.lang.Exception;
public class Application {
@@ -41,7 +34,7 @@ public class Application {
try {
PlexAPI sdk = PlexAPI.builder()
.accessToken("<YOUR_API_KEY_HERE>")
.xPlexClientIdentifier("Postman")
.xPlexClientIdentifier("gcgzw5rz2xovp84b4vha3a40")
.build();
MarkPlayedResponse res = sdk.media().markPlayed()
@@ -49,10 +42,10 @@ public class Application {
.call();
// handle response
} catch (lukehagar.plexapi.plexapi.models.errors.MarkPlayedResponseBody e) {
} catch (dev.plexapi.sdk.models.errors.MarkPlayedResponseBody e) {
// handle exception
throw e;
} catch (lukehagar.plexapi.plexapi.models.errors.SDKError e) {
} catch (SDKError e) {
// handle exception
throw e;
} catch (Exception e) {
@@ -70,10 +63,10 @@ public class Application {
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
| `key` | *double* | :heavy_check_mark: | The media key to mark as played | 59398 |
### Response
**[lukehagar.plexapi.plexapi.models.operations.MarkPlayedResponse](../../models/operations/MarkPlayedResponse.md)**
**[MarkPlayedResponse](../../models/operations/MarkPlayedResponse.md)**
### Errors
| Error Object | Status Code | Content Type |
@@ -81,6 +74,7 @@ public class Application {
| models/errors/MarkPlayedResponseBody | 401 | application/json |
| models/errors/SDKError | 4xx-5xx | \*\/* |
## markUnplayed
This will mark the provided media key as Unplayed.
@@ -90,19 +84,10 @@ This will mark the provided media key as Unplayed.
```java
package hello.world;
import java.math.BigDecimal;
import java.math.BigDecimal;
import java.math.BigInteger;
import java.time.LocalDate;
import java.time.OffsetDateTime;
import java.util.Optional;
import lukehagar.plexapi.plexapi.PlexAPI;
import lukehagar.plexapi.plexapi.models.operations.*;
import lukehagar.plexapi.plexapi.models.shared.*;
import lukehagar.plexapi.plexapi.models.shared.Security;
import lukehagar.plexapi.plexapi.utils.EventStream;
import org.openapitools.jackson.nullable.JsonNullable;
import static java.util.Map.entry;
import dev.plexapi.sdk.PlexAPI;
import dev.plexapi.sdk.models.errors.SDKError;
import dev.plexapi.sdk.models.operations.MarkUnplayedResponse;
import java.lang.Exception;
public class Application {
@@ -110,7 +95,7 @@ public class Application {
try {
PlexAPI sdk = PlexAPI.builder()
.accessToken("<YOUR_API_KEY_HERE>")
.xPlexClientIdentifier("Postman")
.xPlexClientIdentifier("gcgzw5rz2xovp84b4vha3a40")
.build();
MarkUnplayedResponse res = sdk.media().markUnplayed()
@@ -118,10 +103,10 @@ public class Application {
.call();
// handle response
} catch (lukehagar.plexapi.plexapi.models.errors.MarkUnplayedResponseBody e) {
} catch (dev.plexapi.sdk.models.errors.MarkUnplayedResponseBody e) {
// handle exception
throw e;
} catch (lukehagar.plexapi.plexapi.models.errors.SDKError e) {
} catch (SDKError e) {
// handle exception
throw e;
} catch (Exception e) {
@@ -139,10 +124,10 @@ public class Application {
| --------------------------------- | --------------------------------- | --------------------------------- | --------------------------------- | --------------------------------- |
| `key` | *double* | :heavy_check_mark: | The media key to mark as Unplayed | 59398 |
### Response
**[lukehagar.plexapi.plexapi.models.operations.MarkUnplayedResponse](../../models/operations/MarkUnplayedResponse.md)**
**[MarkUnplayedResponse](../../models/operations/MarkUnplayedResponse.md)**
### Errors
| Error Object | Status Code | Content Type |
@@ -150,6 +135,7 @@ public class Application {
| models/errors/MarkUnplayedResponseBody | 401 | application/json |
| models/errors/SDKError | 4xx-5xx | \*\/* |
## updatePlayProgress
This API command can be used to update the play progress of a media item.
@@ -160,19 +146,10 @@ This API command can be used to update the play progress of a media item.
```java
package hello.world;
import java.math.BigDecimal;
import java.math.BigDecimal;
import java.math.BigInteger;
import java.time.LocalDate;
import java.time.OffsetDateTime;
import java.util.Optional;
import lukehagar.plexapi.plexapi.PlexAPI;
import lukehagar.plexapi.plexapi.models.operations.*;
import lukehagar.plexapi.plexapi.models.shared.*;
import lukehagar.plexapi.plexapi.models.shared.Security;
import lukehagar.plexapi.plexapi.utils.EventStream;
import org.openapitools.jackson.nullable.JsonNullable;
import static java.util.Map.entry;
import dev.plexapi.sdk.PlexAPI;
import dev.plexapi.sdk.models.errors.SDKError;
import dev.plexapi.sdk.models.operations.UpdatePlayProgressResponse;
import java.lang.Exception;
public class Application {
@@ -180,20 +157,20 @@ public class Application {
try {
PlexAPI sdk = PlexAPI.builder()
.accessToken("<YOUR_API_KEY_HERE>")
.xPlexClientIdentifier("Postman")
.xPlexClientIdentifier("gcgzw5rz2xovp84b4vha3a40")
.build();
UpdatePlayProgressResponse res = sdk.media().updatePlayProgress()
.key("<value>")
.key("<key>")
.time(90000d)
.state("played")
.call();
// handle response
} catch (lukehagar.plexapi.plexapi.models.errors.UpdatePlayProgressResponseBody e) {
} catch (dev.plexapi.sdk.models.errors.UpdatePlayProgressResponseBody e) {
// handle exception
throw e;
} catch (lukehagar.plexapi.plexapi.models.errors.SDKError e) {
} catch (SDKError e) {
// handle exception
throw e;
} catch (Exception e) {
@@ -213,13 +190,159 @@ public class Application {
| `time` | *double* | :heavy_check_mark: | The time, in milliseconds, used to set the media playback progress. | 90000 |
| `state` | *String* | :heavy_check_mark: | The playback state of the media item. | played |
### Response
**[lukehagar.plexapi.plexapi.models.operations.UpdatePlayProgressResponse](../../models/operations/UpdatePlayProgressResponse.md)**
**[UpdatePlayProgressResponse](../../models/operations/UpdatePlayProgressResponse.md)**
### Errors
| Error Object | Status Code | Content Type |
| -------------------------------------------- | -------------------------------------------- | -------------------------------------------- |
| models/errors/UpdatePlayProgressResponseBody | 401 | application/json |
| models/errors/SDKError | 4xx-5xx | \*\/* |
## getBannerImage
Gets the banner image of the media item
### Example Usage
```java
package hello.world;
import dev.plexapi.sdk.PlexAPI;
import dev.plexapi.sdk.models.errors.SDKError;
import dev.plexapi.sdk.models.operations.GetBannerImageRequest;
import dev.plexapi.sdk.models.operations.GetBannerImageResponse;
import java.lang.Exception;
public class Application {
public static void main(String[] args) throws Exception {
try {
PlexAPI sdk = PlexAPI.builder()
.accessToken("<YOUR_API_KEY_HERE>")
.xPlexClientIdentifier("gcgzw5rz2xovp84b4vha3a40")
.build();
GetBannerImageRequest req = GetBannerImageRequest.builder()
.ratingKey(9518L)
.width(396L)
.height(396L)
.minSize(1L)
.upscale(1L)
.xPlexToken("CV5xoxjTpFKUzBTShsaf")
.build();
GetBannerImageResponse res = sdk.media().getBannerImage()
.request(req)
.call();
if (res.responseStream().isPresent()) {
// handle response
}
} catch (dev.plexapi.sdk.models.errors.GetBannerImageResponseBody e) {
// handle exception
throw e;
} catch (SDKError e) {
// handle exception
throw e;
} catch (Exception e) {
// handle exception
throw e;
}
}
}
```
### Parameters
| Parameter | Type | Required | Description |
| ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- |
| `request` | [GetBannerImageRequest](../../models/operations/GetBannerImageRequest.md) | :heavy_check_mark: | The request object to use for the request. |
### Response
**[GetBannerImageResponse](../../models/operations/GetBannerImageResponse.md)**
### Errors
| Error Object | Status Code | Content Type |
| ---------------------------------------- | ---------------------------------------- | ---------------------------------------- |
| models/errors/GetBannerImageResponseBody | 401 | application/json |
| models/errors/SDKError | 4xx-5xx | \*\/* |
## getThumbImage
Gets the thumbnail image of the media item
### Example Usage
```java
package hello.world;
import dev.plexapi.sdk.PlexAPI;
import dev.plexapi.sdk.models.errors.SDKError;
import dev.plexapi.sdk.models.operations.GetThumbImageRequest;
import dev.plexapi.sdk.models.operations.GetThumbImageResponse;
import java.lang.Exception;
public class Application {
public static void main(String[] args) throws Exception {
try {
PlexAPI sdk = PlexAPI.builder()
.accessToken("<YOUR_API_KEY_HERE>")
.xPlexClientIdentifier("gcgzw5rz2xovp84b4vha3a40")
.build();
GetThumbImageRequest req = GetThumbImageRequest.builder()
.ratingKey(9518L)
.width(396L)
.height(396L)
.minSize(1L)
.upscale(1L)
.xPlexToken("CV5xoxjTpFKUzBTShsaf")
.build();
GetThumbImageResponse res = sdk.media().getThumbImage()
.request(req)
.call();
if (res.responseStream().isPresent()) {
// handle response
}
} catch (dev.plexapi.sdk.models.errors.GetThumbImageResponseBody e) {
// handle exception
throw e;
} catch (SDKError e) {
// handle exception
throw e;
} catch (Exception e) {
// handle exception
throw e;
}
}
}
```
### Parameters
| Parameter | Type | Required | Description |
| ----------------------------------------------------------------------- | ----------------------------------------------------------------------- | ----------------------------------------------------------------------- | ----------------------------------------------------------------------- |
| `request` | [GetThumbImageRequest](../../models/operations/GetThumbImageRequest.md) | :heavy_check_mark: | The request object to use for the request. |
### Response
**[GetThumbImageResponse](../../models/operations/GetThumbImageResponse.md)**
### Errors
| Error Object | Status Code | Content Type |
| --------------------------------------- | --------------------------------------- | --------------------------------------- |
| models/errors/GetThumbImageResponseBody | 401 | application/json |
| models/errors/SDKError | 4xx-5xx | \*\/* |