mirror of
https://github.com/LukeHagar/plexjs.git
synced 2025-12-06 12:37:46 +00:00
35 lines
9.0 KiB
Markdown
35 lines
9.0 KiB
Markdown
# GetSonicallySimilarRequest
|
|
|
|
## Example Usage
|
|
|
|
```typescript
|
|
import { GetSonicallySimilarRequest } from "@lukehagar/plexjs/models/operations";
|
|
|
|
let value: GetSonicallySimilarRequest = {
|
|
sectionId: 363501,
|
|
values: [
|
|
962457,
|
|
],
|
|
};
|
|
```
|
|
|
|
## 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 |
|
|
| `sectionId` | *number* | :heavy_check_mark: | Section identifier | |
|
|
| `type` | *number* | :heavy_minus_sign: | The metadata type to fetch (should be 10 for audio track) | |
|
|
| `values` | *number*[] | :heavy_check_mark: | The music analysis to center the search. Typically obtained from the `musicAnalysis` of a track | |
|
|
| `limit` | *number* | :heavy_minus_sign: | The limit of the number of items to fetch; defaults to 50 | |
|
|
| `maxDistance` | *number* | :heavy_minus_sign: | The maximum distance to search, defaults to 0.25 | | |