mirror of
https://github.com/LukeHagar/plexjs.git
synced 2025-12-09 04:20:52 +00:00
38 lines
26 KiB
Markdown
38 lines
26 KiB
Markdown
# MyPlex
|
|
|
|
## Example Usage
|
|
|
|
```typescript
|
|
import { MyPlex } from "@lukehagar/plexjs/sdk/models/operations";
|
|
|
|
let value: MyPlex = {
|
|
authToken: "Z5v-PrNASDFpsaCi3CPK7",
|
|
username: "example.email@mail.com",
|
|
mappingState: "mapped",
|
|
signInState: "ok",
|
|
publicAddress: "140.20.68.140",
|
|
publicPort: 32400,
|
|
privateAddress: "10.10.10.47",
|
|
privatePort: 32400,
|
|
subscriptionFeatures:
|
|
"federated-auth,hardware_transcoding,home,hwtranscode,item_clusters,kevin-bacon,livetv,loudness,lyrics,music-analysis,music_videos,pass,photo_autotags,photos-v5,photosV6-edit,photosV6-tv-albums,premium_music_metadata,radio,server-manager,session_bandwidth_restrictions,session_kick,shared-radio,sync,trailers,tuner-sharing,type-first,unsupportedtuners,webhooks",
|
|
subscriptionState: "Active",
|
|
};
|
|
```
|
|
|
|
## Fields
|
|
|
|
| Field | Type | Required | Description | Example |
|
|
| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
| `authToken` | *string* | :heavy_minus_sign: | N/A | Z5v-PrNASDFpsaCi3CPK7 |
|
|
| `username` | *string* | :heavy_minus_sign: | N/A | example.email@mail.com |
|
|
| `mappingState` | *string* | :heavy_minus_sign: | N/A | mapped |
|
|
| `mappingError` | *string* | :heavy_minus_sign: | N/A | |
|
|
| `signInState` | *string* | :heavy_minus_sign: | N/A | ok |
|
|
| `publicAddress` | *string* | :heavy_minus_sign: | N/A | 140.20.68.140 |
|
|
| `publicPort` | *number* | :heavy_minus_sign: | N/A | 32400 |
|
|
| `privateAddress` | *string* | :heavy_minus_sign: | N/A | 10.10.10.47 |
|
|
| `privatePort` | *number* | :heavy_minus_sign: | N/A | 32400 |
|
|
| `subscriptionFeatures` | *string* | :heavy_minus_sign: | N/A | federated-auth,hardware_transcoding,home,hwtranscode,item_clusters,kevin-bacon,livetv,loudness,lyrics,music-analysis,music_videos,pass,photo_autotags,photos-v5,photosV6-edit,photosV6-tv-albums,premium_music_metadata,radio,server-manager,session_bandwidth_restrictions,session_kick,shared-radio,sync,trailers,tuner-sharing,type-first,unsupportedtuners,webhooks |
|
|
| `subscriptionActive` | *boolean* | :heavy_minus_sign: | N/A | |
|
|
| `subscriptionState` | *string* | :heavy_minus_sign: | N/A | Active | |