mirror of
https://github.com/LukeHagar/plexjs.git
synced 2025-12-06 12:37:46 +00:00
35 lines
7.6 KiB
Markdown
35 lines
7.6 KiB
Markdown
# IngestTransientItemRequest
|
|
|
|
## Example Usage
|
|
|
|
```typescript
|
|
import { IngestTransientItemRequest } from "@lukehagar/plexjs/models/operations";
|
|
import { BoolInt } from "@lukehagar/plexjs/models/shared";
|
|
|
|
let value: IngestTransientItemRequest = {
|
|
url: "file:///storage%2Femulated%2F0%2FArcher-S01E01.mkv",
|
|
virtualFilePath: "/Avatar.mkv",
|
|
computeHashes: BoolInt.True,
|
|
ingestNonMatches: BoolInt.True,
|
|
};
|
|
```
|
|
|
|
## Fields
|
|
|
|
| Field | Type | Required | Description | Example |
|
|
| ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- |
|
|
| `accepts` | [shared.Accepts](../../models/shared/accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
|
|
| `clientIdentifier` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
|
|
| `product` | *string* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
|
|
| `version` | *string* | :heavy_minus_sign: | The version of the client application | 2.4.1 |
|
|
| `platform` | *string* | :heavy_minus_sign: | The platform of the client | Roku |
|
|
| `platformVersion` | *string* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
|
|
| `device` | *string* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
|
|
| `model` | *string* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
|
|
| `deviceVendor` | *string* | :heavy_minus_sign: | The device vendor | Roku |
|
|
| `deviceName` | *string* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
|
|
| `marketplace` | *string* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay |
|
|
| `url` | *string* | :heavy_minus_sign: | The file of the file to ingest. | file:///storage%2Femulated%2F0%2FArcher-S01E01.mkv |
|
|
| `virtualFilePath` | *string* | :heavy_minus_sign: | A virtual path to use when the url is opaque. | /Avatar.mkv |
|
|
| `computeHashes` | [shared.BoolInt](../../models/shared/boolint.md) | :heavy_minus_sign: | Whether or not to compute Plex and OpenSubtitle hashes for the file. Defaults to 0. | 1 |
|
|
| `ingestNonMatches` | [shared.BoolInt](../../models/shared/boolint.md) | :heavy_minus_sign: | Whether or not non matching media should be stored. Defaults to 0. | 1 | |