mirror of
https://github.com/LukeHagar/plexgo.git
synced 2025-12-07 12:37:45 +00:00
ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.558.1
This commit is contained in:
File diff suppressed because one or more lines are too long
@@ -17,9 +17,10 @@ generation:
|
|||||||
oAuth2ClientCredentialsEnabled: true
|
oAuth2ClientCredentialsEnabled: true
|
||||||
oAuth2PasswordEnabled: false
|
oAuth2PasswordEnabled: false
|
||||||
go:
|
go:
|
||||||
version: 0.22.0
|
version: 0.23.0
|
||||||
additionalDependencies: {}
|
additionalDependencies: {}
|
||||||
allowUnknownFieldsInWeakUnions: false
|
allowUnknownFieldsInWeakUnions: false
|
||||||
|
baseErrorName: PlexAPIError
|
||||||
clientServerStatusCodesAsErrors: true
|
clientServerStatusCodesAsErrors: true
|
||||||
defaultErrorName: SDKError
|
defaultErrorName: SDKError
|
||||||
flattenGlobalSecurity: true
|
flattenGlobalSecurity: true
|
||||||
|
|||||||
@@ -1,4 +1,4 @@
|
|||||||
speakeasyVersion: 1.555.3
|
speakeasyVersion: 1.558.1
|
||||||
sources:
|
sources:
|
||||||
my-source:
|
my-source:
|
||||||
sourceNamespace: my-source
|
sourceNamespace: my-source
|
||||||
@@ -9,19 +9,19 @@ sources:
|
|||||||
- main
|
- main
|
||||||
plexapi:
|
plexapi:
|
||||||
sourceNamespace: plexapi
|
sourceNamespace: plexapi
|
||||||
sourceRevisionDigest: sha256:78d07ad78ff60d0e9918696208d8c68a562e170d4e9c431797c02995fb8816d0
|
sourceRevisionDigest: sha256:dafcc1192236829b85bc924e0462432c0eb7318a17c542f46e3dd05a9a6265df
|
||||||
sourceBlobDigest: sha256:d38dd2a36c1b2fd73409267f7b30c2d5d45d709616141803ea01db424ec68ae4
|
sourceBlobDigest: sha256:bc072115d585e1695cb8393db901a3d36be1dcd57a69bad2b91a1ba7ac3c9c4b
|
||||||
tags:
|
tags:
|
||||||
- latest
|
- latest
|
||||||
- speakeasy-sdk-regen-1749082259
|
- speakeasy-sdk-regen-1749514263
|
||||||
targets:
|
targets:
|
||||||
plexgo:
|
plexgo:
|
||||||
source: plexapi
|
source: plexapi
|
||||||
sourceNamespace: plexapi
|
sourceNamespace: plexapi
|
||||||
sourceRevisionDigest: sha256:78d07ad78ff60d0e9918696208d8c68a562e170d4e9c431797c02995fb8816d0
|
sourceRevisionDigest: sha256:dafcc1192236829b85bc924e0462432c0eb7318a17c542f46e3dd05a9a6265df
|
||||||
sourceBlobDigest: sha256:d38dd2a36c1b2fd73409267f7b30c2d5d45d709616141803ea01db424ec68ae4
|
sourceBlobDigest: sha256:bc072115d585e1695cb8393db901a3d36be1dcd57a69bad2b91a1ba7ac3c9c4b
|
||||||
codeSamplesNamespace: code-samples-go-plexgo
|
codeSamplesNamespace: code-samples-go-plexgo
|
||||||
codeSamplesRevisionDigest: sha256:92b1cc82ef36c033e0829db07006a9d1fd240244dd846ed236c51115a902001a
|
codeSamplesRevisionDigest: sha256:3b03148d4d6862182c93ca6cb369128309b007a961711d86509a555a2c5d813d
|
||||||
workflow:
|
workflow:
|
||||||
workflowVersion: 1.0.0
|
workflowVersion: 1.0.0
|
||||||
speakeasyVersion: latest
|
speakeasyVersion: latest
|
||||||
|
|||||||
10
RELEASES.md
10
RELEASES.md
@@ -1163,3 +1163,13 @@ Based on:
|
|||||||
- [go v0.22.0] .
|
- [go v0.22.0] .
|
||||||
### Releases
|
### Releases
|
||||||
- [Go v0.22.0] https://github.com/LukeHagar/plexgo/releases/tag/v0.22.0 - .
|
- [Go v0.22.0] https://github.com/LukeHagar/plexgo/releases/tag/v0.22.0 - .
|
||||||
|
|
||||||
|
## 2025-06-10 00:10:47
|
||||||
|
### Changes
|
||||||
|
Based on:
|
||||||
|
- OpenAPI Doc
|
||||||
|
- Speakeasy CLI 1.558.1 (2.623.4) https://github.com/speakeasy-api/speakeasy
|
||||||
|
### Generated
|
||||||
|
- [go v0.23.0] .
|
||||||
|
### Releases
|
||||||
|
- [Go v0.23.0] https://github.com/LukeHagar/plexgo/releases/tag/v0.23.0 - .
|
||||||
@@ -1,11 +0,0 @@
|
|||||||
# EnableCreditsMarkerGeneration
|
|
||||||
|
|
||||||
Setting that indicates if credits markers detection is enabled. (-1 = Library default, 0 = Disabled).
|
|
||||||
|
|
||||||
|
|
||||||
## Values
|
|
||||||
|
|
||||||
| Name | Value |
|
|
||||||
| --------------------------------------------- | --------------------------------------------- |
|
|
||||||
| `EnableCreditsMarkerGenerationLibraryDefault` | -1 |
|
|
||||||
| `EnableCreditsMarkerGenerationDisabled` | 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 |
|
|
||||||
| --------------------------- | --------------------------- |
|
|
||||||
| `EpisodeSortLibraryDefault` | -1 |
|
|
||||||
| `EpisodeSortOldestFirst` | 0 |
|
|
||||||
| `EpisodeSortNewestFirst` | 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 |
|
||||||
|
|||||||
@@ -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` | **string* | :heavy_minus_sign: | Identifier for the view mode. | 131131 |
|
||||||
| `Directory` | [][operations.GetActorsLibraryDirectory](../../models/operations/getactorslibrarydirectory.md) | :heavy_minus_sign: | An array of actor entries for media items. | |
|
| `Directory` | [][operations.GetActorsLibraryDirectory](../../models/operations/getactorslibrarydirectory.md) | :heavy_minus_sign: | An array of actor entries for media items. | |
|
||||||
@@ -4,5 +4,5 @@
|
|||||||
## Fields
|
## Fields
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
| Field | Type | Required | Description | Example |
|
||||||
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
|
| --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- |
|
||||||
| `Tag` | **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 |
|
||||||
@@ -4,5 +4,6 @@
|
|||||||
## Fields
|
## Fields
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
| Field | Type | Required | Description | Example |
|
||||||
| ------------------------ | ------------------------ | ------------------------ | ------------------------ | ------------------------ |
|
| ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- |
|
||||||
| `Tag` | **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 |
|
||||||
@@ -4,5 +4,7 @@
|
|||||||
## Fields
|
## Fields
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
| Field | Type | Required | Description | Example |
|
||||||
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
|
| ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- |
|
||||||
| `Tag` | **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` | **string* | :heavy_minus_sign: | The absolute URL of the thumbnail image for the director. | https://metadata-static.plex.tv/8/people/8d65fa96804802e08f2de09fe014408e.jpg |
|
||||||
@@ -10,4 +10,3 @@
|
|||||||
| `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` | **bool* | :heavy_minus_sign: | N/A | true |
|
|
||||||
@@ -4,5 +4,6 @@
|
|||||||
## Fields
|
## Fields
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
| Field | Type | Required | Description | Example |
|
||||||
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
|
| -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- |
|
||||||
| `Tag` | **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
|
||||||
|
|
||||||
|
|||||||
@@ -4,7 +4,7 @@
|
|||||||
## 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` | [operations.GetLibraryItemsLibraryResponse200Type](../../models/operations/getlibraryitemslibraryresponse200type.md) | :heavy_check_mark: | N/A | background |
|
| `Type` | [operations.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 |
|
|
||||||
| -------------------------------------------------- | -------------------------------------------------- |
|
|
||||||
| `GetLibraryItemsLibraryDefaultDirectionAscending` | asc |
|
|
||||||
| `GetLibraryItemsLibraryDefaultDirectionDescending` | 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` | **string* | :heavy_minus_sign: | N/A | rating |
|
|
||||||
@@ -1,9 +0,0 @@
|
|||||||
# GetLibraryItemsLibraryFieldType
|
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
|
||||||
| -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- |
|
|
||||||
| `Type` | *string* | :heavy_check_mark: | N/A | tag |
|
|
||||||
| `Operator` | [][operations.GetLibraryItemsLibraryOperator](../../models/operations/getlibraryitemslibraryoperator.md) | :heavy_check_mark: | N/A | |
|
|
||||||
@@ -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 |
|
|
||||||
@@ -0,0 +1,20 @@
|
|||||||
|
# GetLibraryItemsLibraryOptimizedForStreaming
|
||||||
|
|
||||||
|
Has this media been optimized for streaming. NOTE: This can be 0, 1, false or true
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
## Supported Types
|
||||||
|
|
||||||
|
### GetLibraryItemsOptimizedForStreaming1
|
||||||
|
|
||||||
|
```go
|
||||||
|
getLibraryItemsLibraryOptimizedForStreaming := operations.CreateGetLibraryItemsLibraryOptimizedForStreamingGetLibraryItemsOptimizedForStreaming1(operations.GetLibraryItemsOptimizedForStreaming1{/* values here */})
|
||||||
|
```
|
||||||
|
|
||||||
|
###
|
||||||
|
|
||||||
|
```go
|
||||||
|
getLibraryItemsLibraryOptimizedForStreaming := operations.CreateGetLibraryItemsLibraryOptimizedForStreamingBoolean(bool{/* values here */})
|
||||||
|
```
|
||||||
|
|
||||||
@@ -1,11 +0,0 @@
|
|||||||
# GetLibraryItemsLibraryResponse200Type
|
|
||||||
|
|
||||||
|
|
||||||
## Values
|
|
||||||
|
|
||||||
| Name | Value |
|
|
||||||
| -------------------------------------------------- | -------------------------------------------------- |
|
|
||||||
| `GetLibraryItemsLibraryResponse200TypeCoverPoster` | coverPoster |
|
|
||||||
| `GetLibraryItemsLibraryResponse200TypeBackground` | background |
|
|
||||||
| `GetLibraryItemsLibraryResponse200TypeSnapshot` | snapshot |
|
|
||||||
| `GetLibraryItemsLibraryResponse200TypeClearLogo` | clearLogo |
|
|
||||||
@@ -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 |
|
| `GetLibraryItemsLibraryResponseTypeCoverPoster` | coverPoster |
|
||||||
| `Type` | *string* | :heavy_check_mark: | N/A | show |
|
| `GetLibraryItemsLibraryResponseTypeBackground` | background |
|
||||||
| `Title` | *string* | :heavy_check_mark: | N/A | TV Shows |
|
| `GetLibraryItemsLibraryResponseTypeSnapshot` | snapshot |
|
||||||
| `Active` | *bool* | :heavy_check_mark: | N/A | false |
|
| `GetLibraryItemsLibraryResponseTypeClearLogo` | clearLogo |
|
||||||
| `Filter` | [][operations.GetLibraryItemsLibraryFilter](../../models/operations/getlibraryitemslibraryfilter.md) | :heavy_minus_sign: | N/A | |
|
|
||||||
| `Sort` | [][operations.GetLibraryItemsLibrarySort](../../models/operations/getlibraryitemslibrarysort.md) | :heavy_minus_sign: | N/A | |
|
|
||||||
| `Field` | [][operations.GetLibraryItemsLibraryField](../../models/operations/getlibraryitemslibraryfield.md) | :heavy_minus_sign: | N/A | |
|
|
||||||
@@ -1,15 +0,0 @@
|
|||||||
# GetLibraryItemsLibrarySort
|
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
|
||||||
| ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- |
|
|
||||||
| `Default` | **string* | :heavy_minus_sign: | N/A | asc |
|
|
||||||
| `Active` | **bool* | :heavy_minus_sign: | N/A | false |
|
|
||||||
| `ActiveDirection` | [*operations.GetLibraryItemsLibraryActiveDirection](../../models/operations/getlibraryitemslibraryactivedirection.md) | :heavy_minus_sign: | The direction of the sort. Can be either `asc` or `desc`.<br/> | asc |
|
|
||||||
| `DefaultDirection` | [*operations.GetLibraryItemsLibraryDefaultDirection](../../models/operations/getlibraryitemslibrarydefaultdirection.md) | :heavy_minus_sign: | The direction of the sort. Can be either `asc` or `desc`.<br/> | asc |
|
|
||||||
| `DescKey` | **string* | :heavy_minus_sign: | N/A | titleSort:desc |
|
|
||||||
| `FirstCharacterKey` | **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,20 +1,14 @@
|
|||||||
# GetLibraryItemsLibraryType
|
# GetLibraryItemsLibraryType
|
||||||
|
|
||||||
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 |
|
||||||
| Name | Value |
|
| `Type` | *string* | :heavy_check_mark: | N/A | show |
|
||||||
| -------------------------------------- | -------------------------------------- |
|
| `Title` | *string* | :heavy_check_mark: | N/A | TV Shows |
|
||||||
| `GetLibraryItemsLibraryTypeMovie` | movie |
|
| `Active` | *bool* | :heavy_check_mark: | N/A | false |
|
||||||
| `GetLibraryItemsLibraryTypeTvShow` | show |
|
| `Filter` | [][operations.GetLibraryItemsFilter](../../models/operations/getlibraryitemsfilter.md) | :heavy_minus_sign: | N/A | |
|
||||||
| `GetLibraryItemsLibraryTypeSeason` | season |
|
| `Sort` | [][operations.GetLibraryItemsSort](../../models/operations/getlibraryitemssort.md) | :heavy_minus_sign: | N/A | |
|
||||||
| `GetLibraryItemsLibraryTypeEpisode` | episode |
|
| `Field` | [][operations.GetLibraryItemsField](../../models/operations/getlibraryitemsfield.md) | :heavy_minus_sign: | N/A | |
|
||||||
| `GetLibraryItemsLibraryTypeArtist` | artist |
|
|
||||||
| `GetLibraryItemsLibraryTypeAlbum` | album |
|
|
||||||
| `GetLibraryItemsLibraryTypeTrack` | track |
|
|
||||||
| `GetLibraryItemsLibraryTypePhotoAlbum` | photoalbum |
|
|
||||||
| `GetLibraryItemsLibraryTypePhoto` | photo |
|
|
||||||
| `GetLibraryItemsLibraryTypeCollection` | collection |
|
|
||||||
@@ -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` | **string* | :heavy_minus_sign: | N/A | /TV Shows/House |
|
| `Path` | *string* | :heavy_check_mark: | N/A | /TV Shows/Clarkson's Farm |
|
||||||
@@ -4,22 +4,23 @@
|
|||||||
## Fields
|
## Fields
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
| Field | Type | Required | Description | Example |
|
||||||
| ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- |
|
| -------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||||
| `ID` | *int* | :heavy_check_mark: | N/A | 119534 |
|
| `ID` | *int64* | :heavy_check_mark: | Unique media identifier. | 387322 |
|
||||||
| `Duration` | **int* | :heavy_minus_sign: | N/A | 11558112 |
|
| `Duration` | **int* | :heavy_minus_sign: | Duration of the media in milliseconds. | 9610350 |
|
||||||
| `Bitrate` | **int* | :heavy_minus_sign: | N/A | 25025 |
|
| `Bitrate` | **int* | :heavy_minus_sign: | Bitrate in bits per second. | 25512 |
|
||||||
| `Width` | **int* | :heavy_minus_sign: | N/A | 3840 |
|
| `Width` | **int* | :heavy_minus_sign: | Video width in pixels. | 3840 |
|
||||||
| `Height` | **int* | :heavy_minus_sign: | N/A | 2072 |
|
| `Height` | **int* | :heavy_minus_sign: | Video height in pixels. | 1602 |
|
||||||
| `AspectRatio` | **float64* | :heavy_minus_sign: | N/A | 1.85 |
|
| `AspectRatio` | **float32* | :heavy_minus_sign: | Aspect ratio of the video. | 2.35 |
|
||||||
| `AudioProfile` | **string* | :heavy_minus_sign: | N/A | dts |
|
| `AudioChannels` | **int* | :heavy_minus_sign: | Number of audio channels. | 6 |
|
||||||
| `AudioChannels` | **int* | :heavy_minus_sign: | N/A | 6 |
|
| `DisplayOffset` | **int* | :heavy_minus_sign: | N/A | 50 |
|
||||||
| `AudioCodec` | **string* | :heavy_minus_sign: | N/A | eac3 |
|
| `AudioCodec` | **string* | :heavy_minus_sign: | Audio codec used. | aac |
|
||||||
| `VideoCodec` | **string* | :heavy_minus_sign: | N/A | hevc |
|
| `VideoCodec` | **string* | :heavy_minus_sign: | Video codec used. | hevc |
|
||||||
| `VideoResolution` | **string* | :heavy_minus_sign: | N/A | 4k |
|
| `VideoResolution` | **string* | :heavy_minus_sign: | Video resolution (e.g., 4k). | 4k |
|
||||||
| `Container` | *string* | :heavy_check_mark: | N/A | mkv |
|
| `Container` | **string* | :heavy_minus_sign: | Container format of the media. | mp4 |
|
||||||
| `VideoFrameRate` | **string* | :heavy_minus_sign: | N/A | 24p |
|
| `VideoFrameRate` | **string* | :heavy_minus_sign: | Frame rate of the video. Values found include NTSC, PAL, 24p<br/> | 24p |
|
||||||
| `VideoProfile` | **string* | :heavy_minus_sign: | N/A | main 10 |
|
| `VideoProfile` | **string* | :heavy_minus_sign: | Video profile (e.g., main 10). | main 10 |
|
||||||
| `HasVoiceActivity` | **bool* | :heavy_minus_sign: | N/A | false |
|
| `HasVoiceActivity` | **bool* | :heavy_minus_sign: | Indicates whether voice activity is detected. | false |
|
||||||
| `OptimizedForStreaming` | [*operations.GetLibraryItemsOptimizedForStreaming](../../models/operations/getlibraryitemsoptimizedforstreaming.md) | :heavy_minus_sign: | N/A | 1 |
|
| `AudioProfile` | **string* | :heavy_minus_sign: | The audio profile used for the media (e.g., DTS, Dolby Digital, etc.). | dts |
|
||||||
| `Has64bitOffsets` | **bool* | :heavy_minus_sign: | N/A | false |
|
| `OptimizedForStreaming` | [*operations.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` | [][operations.GetLibraryItemsPart](../../models/operations/getlibraryitemspart.md) | :heavy_check_mark: | N/A | |
|
| `Has64bitOffsets` | **bool* | :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` | [][operations.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` | [][operations.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` | [][operations.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` | *int64* | :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` | *bool* | :heavy_check_mark: | Indicates whether syncing is allowed. | false |
|
||||||
| `Content` | *string* | :heavy_check_mark: | N/A | secondary |
|
| `Nocache` | *bool* | :heavy_check_mark: | Specifies whether caching is disabled. | true |
|
||||||
| `AllowSync` | *bool* | :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` | **bool* | :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` | **int64* | :heavy_minus_sign: | The unique identifier for the library section. | 2 |
|
||||||
| `Identifier` | *string* | :heavy_check_mark: | N/A | com.plexapp.plugins.library |
|
| `LibrarySectionTitle` | **string* | :heavy_minus_sign: | The title of the library section. | TV Series |
|
||||||
| `LibrarySectionID` | *int64* | :heavy_check_mark: | N/A | 1 |
|
| `LibrarySectionUUID` | **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` | *int64* | :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` | **string* | :heavy_minus_sign: | Identifier for the view mode. | 131131 |
|
||||||
| `ViewGroup` | *string* | :heavy_check_mark: | N/A | movie |
|
| `MixedParents` | **bool* | :heavy_minus_sign: | Indicates if the media container has mixed parents. | true |
|
||||||
| `ViewMode` | **int* | :heavy_minus_sign: | N/A | 65592 |
|
| `Metadata` | [][operations.GetLibraryItemsMetadata](../../models/operations/getlibraryitemsmetadata.md) | :heavy_check_mark: | An array of metadata items. | |
|
||||||
| `MixedParents` | **bool* | :heavy_minus_sign: | N/A | true |
|
|
||||||
| `Metadata` | [][operations.GetLibraryItemsMetadata](../../models/operations/getlibraryitemsmetadata.md) | :heavy_minus_sign: | N/A | |
|
|
||||||
| `Meta` | [*operations.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` | [*operations.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/> | |
|
||||||
@@ -7,6 +7,6 @@ The Meta object is only included in the response if the `includeMeta` parameter
|
|||||||
## Fields
|
## Fields
|
||||||
|
|
||||||
| Field | Type | Required | Description |
|
| Field | Type | Required | Description |
|
||||||
| ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- |
|
| ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ |
|
||||||
| `Type` | [][operations.GetLibraryItemsLibraryResponseType](../../models/operations/getlibraryitemslibraryresponsetype.md) | :heavy_minus_sign: | N/A |
|
| `Type` | [][operations.GetLibraryItemsLibraryType](../../models/operations/getlibraryitemslibrarytype.md) | :heavy_minus_sign: | N/A |
|
||||||
| `FieldType` | [][operations.GetLibraryItemsLibraryFieldType](../../models/operations/getlibraryitemslibraryfieldtype.md) | :heavy_minus_sign: | N/A |
|
| `FieldType` | [][operations.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` | **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` | **bool* | :heavy_minus_sign: | N/A | false |
|
| `Studio` | **string* | :heavy_minus_sign: | The studio that produced the media item. | 20th Century Studios |
|
||||||
| `LibrarySectionID` | **int64* | :heavy_minus_sign: | N/A | 1 |
|
| `Type` | [operations.GetLibraryItemsType](../../models/operations/getlibraryitemstype.md) | :heavy_check_mark: | N/A | movie |
|
||||||
| `LibrarySectionTitle` | **string* | :heavy_minus_sign: | N/A | Movies |
|
| `Title` | *string* | :heavy_check_mark: | The title of the media item. | Avatar: The Way of Water |
|
||||||
| `LibrarySectionKey` | **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` | [operations.GetLibraryItemsLibraryType](../../models/operations/getlibraryitemslibrarytype.md) | :heavy_check_mark: | The type of media content in the Plex library. This can represent videos, music, or photos.<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` | **string* | :heavy_minus_sign: | The content rating for the media item. | PG-13 |
|
||||||
| `Slug` | **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` | **string* | :heavy_minus_sign: | N/A | PG-13 |
|
| `Rating` | *float32* | :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` | *float64* | :heavy_check_mark: | The audience rating for the media item. | 9.2 |
|
||||||
| `Rating` | **float64* | :heavy_minus_sign: | N/A | 7.6 |
|
| `Year` | **int* | :heavy_minus_sign: | The release year of the media item. | 2022 |
|
||||||
| `AudienceRating` | **float64* | :heavy_minus_sign: | N/A | 9.2 |
|
| `Tagline` | *string* | :heavy_check_mark: | A brief tagline for the media item. | Return to Pandora. |
|
||||||
| `Year` | **int* | :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` | **int* | :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` | **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` | [*operations.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` | [*operations.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` | **int* | :heavy_minus_sign: | The number of leaf items (end nodes) under this media item. | 14 |
|
||||||
| `EnableCreditsMarkerGeneration` | [*operations.EnableCreditsMarkerGeneration](../../models/operations/enablecreditsmarkergeneration.md) | :heavy_minus_sign: | Setting that indicates if credits markers detection is enabled. (-1 = Library default, 0 = Disabled). | -1 |
|
| `ViewedLeafCount` | **int* | :heavy_minus_sign: | The number of leaf items that have been viewed. | 0 |
|
||||||
| `ShowOrdering` | [*operations.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` | **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` | **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` | **string* | :heavy_minus_sign: | N/A | /library/metadata/58683/banner/1703239236 |
|
| `OriginallyAvailableAt` | [*types.Date](../../types/date.md) | :heavy_minus_sign: | The original release date of the media item. | 2022-12-14 |
|
||||||
| `Duration` | **int* | :heavy_minus_sign: | N/A | 11558112 |
|
| `AddedAt` | *int64* | :heavy_check_mark: | N/A | 1556281940 |
|
||||||
| `OriginallyAvailableAt` | [*types.Date](../../types/date.md) | :heavy_minus_sign: | N/A | 2022-12-14 00:00:00 +0000 UTC |
|
|
||||||
| `AddedAt` | *int64* | :heavy_check_mark: | Unix epoch datetime in seconds | 1556281940 |
|
|
||||||
| `UpdatedAt` | **int64* | :heavy_minus_sign: | Unix epoch datetime in seconds | 1556281940 |
|
| `UpdatedAt` | **int64* | :heavy_minus_sign: | Unix epoch datetime in seconds | 1556281940 |
|
||||||
| `AudienceRatingImage` | **string* | :heavy_minus_sign: | N/A | rottentomatoes://image.rating.upright |
|
| `AudienceRatingImage` | **string* | :heavy_minus_sign: | The URL for the audience rating image. | rottentomatoes://image.rating.upright |
|
||||||
| `ChapterSource` | **string* | :heavy_minus_sign: | N/A | media |
|
| `ChapterSource` | **string* | :heavy_minus_sign: | The source from which chapter data is derived. | media |
|
||||||
| `PrimaryExtraKey` | **string* | :heavy_minus_sign: | N/A | /library/metadata/58684 |
|
| `PrimaryExtraKey` | **string* | :heavy_minus_sign: | The primary extra key associated with this media item. | /library/metadata/58684 |
|
||||||
| `RatingImage` | **string* | :heavy_minus_sign: | N/A | rottentomatoes://image.rating.ripe |
|
| `OriginalTitle` | **string* | :heavy_minus_sign: | The original title of the media item (if different). | 映画 ブラッククローバー 魔法帝の剣 |
|
||||||
| `GrandparentRatingKey` | **string* | :heavy_minus_sign: | N/A | 66 |
|
| `ParentRatingKey` | **string* | :heavy_minus_sign: | The rating key of the parent media item. | 66 |
|
||||||
| `GrandparentGUID` | **string* | :heavy_minus_sign: | N/A | plex://show/5d9c081b170e24001f2a7be4 |
|
| `GrandparentRatingKey` | **string* | :heavy_minus_sign: | The rating key of the grandparent media item. | 66 |
|
||||||
| `GrandparentKey` | **string* | :heavy_minus_sign: | N/A | /library/metadata/66 |
|
| `ParentGUID` | **string* | :heavy_minus_sign: | The GUID of the parent media item. | plex://show/5d9c081b170e24001f2a7be4 |
|
||||||
| `GrandparentTitle` | **string* | :heavy_minus_sign: | N/A | Caprica |
|
| `GrandparentGUID` | **string* | :heavy_minus_sign: | The GUID of the grandparent media item. | plex://show/5d9c081b170e24001f2a7be4 |
|
||||||
| `GrandparentThumb` | **string* | :heavy_minus_sign: | N/A | /library/metadata/66/thumb/1705716261 |
|
| `GrandparentSlug` | **string* | :heavy_minus_sign: | The slug for the grandparent media item. | alice-in-borderland-2020 |
|
||||||
| `ParentSlug` | **string* | :heavy_minus_sign: | N/A | alice-in-borderland-2020 |
|
| `GrandparentKey` | **string* | :heavy_minus_sign: | The key of the grandparent media item. | /library/metadata/66 |
|
||||||
| `GrandparentSlug` | **string* | :heavy_minus_sign: | N/A | alice-in-borderland-2020 |
|
| `ParentKey` | **string* | :heavy_minus_sign: | The key of the parent media item. | /library/metadata/66 |
|
||||||
| `GrandparentArt` | **string* | :heavy_minus_sign: | N/A | /library/metadata/66/art/1705716261 |
|
| `GrandparentTitle` | **string* | :heavy_minus_sign: | The title of the grandparent media item. | Caprica |
|
||||||
| `GrandparentTheme` | **string* | :heavy_minus_sign: | N/A | /library/metadata/66/theme/1705716261 |
|
| `GrandparentThumb` | **string* | :heavy_minus_sign: | The thumbnail URL for the grandparent media item. | /library/metadata/66/thumb/1705716261 |
|
||||||
| `Media` | [][operations.GetLibraryItemsMedia](../../models/operations/getlibraryitemsmedia.md) | :heavy_minus_sign: | The Media object is only included when type query is `4` or higher.<br/> | |
|
| `GrandparentTheme` | **string* | :heavy_minus_sign: | The theme URL for the grandparent media item. | /library/metadata/66/theme/1705716261 |
|
||||||
|
| `GrandparentArt` | **string* | :heavy_minus_sign: | The art URL for the grandparent media item. | /library/metadata/66/art/1705716261 |
|
||||||
|
| `ParentTitle` | **string* | :heavy_minus_sign: | The title of the parent media item. | Caprica |
|
||||||
|
| `ParentIndex` | **int* | :heavy_minus_sign: | The index position of the parent media item. | 1 |
|
||||||
|
| `ParentThumb` | **string* | :heavy_minus_sign: | The thumbnail URL for the parent media item. | /library/metadata/66/thumb/1705716261 |
|
||||||
|
| `RatingImage` | **string* | :heavy_minus_sign: | The URL for the rating image. | rottentomatoes://image.rating.ripe |
|
||||||
|
| `ViewCount` | **int* | :heavy_minus_sign: | The number of times this media item has been viewed. | 1 |
|
||||||
|
| `ViewOffset` | **int* | :heavy_minus_sign: | The current playback offset (in milliseconds). | 5222500 |
|
||||||
|
| `SkipCount` | **int* | :heavy_minus_sign: | The number of times this media item has been skipped. | 1 |
|
||||||
|
| `Subtype` | **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 |
|
||||||
|
| `LastRatedAt` | **int64* | :heavy_minus_sign: | The Unix timestamp representing the last time the item was rated. | 1721813113 |
|
||||||
|
| `CreatedAtAccuracy` | **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 |
|
||||||
|
| `CreatedAtTZOffset` | **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` | **int* | :heavy_minus_sign: | Unix timestamp for when the media item was last viewed. | 1682752242 |
|
||||||
|
| `UserRating` | **float32* | :heavy_minus_sign: | The rating provided by a user for the item. This value is expressed as a decimal number. | 10 |
|
||||||
|
| `Image` | [][operations.GetLibraryItemsImage](../../models/operations/getlibraryitemsimage.md) | :heavy_minus_sign: | N/A | |
|
||||||
|
| `UltraBlurColors` | [*operations.GetLibraryItemsUltraBlurColors](../../models/operations/getlibraryitemsultrablurcolors.md) | :heavy_minus_sign: | N/A | |
|
||||||
|
| `Guids` | [][operations.GetLibraryItemsGuids](../../models/operations/getlibraryitemsguids.md) | :heavy_minus_sign: | N/A | |
|
||||||
|
| `LibrarySectionID` | **int64* | :heavy_minus_sign: | The identifier for the library section. | 1 |
|
||||||
|
| `LibrarySectionTitle` | **string* | :heavy_minus_sign: | The title of the library section. | Movies |
|
||||||
|
| `LibrarySectionKey` | **string* | :heavy_minus_sign: | The key corresponding to the library section. | /library/sections/1 |
|
||||||
|
| `ShowOrdering` | [*operations.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 |
|
||||||
|
| `FlattenSeasons` | [*operations.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 |
|
||||||
|
| `SkipChildren` | **bool* | :heavy_minus_sign: | Indicates whether child items should be skipped. | false |
|
||||||
|
| `Media` | [][operations.GetLibraryItemsMedia](../../models/operations/getlibraryitemsmedia.md) | :heavy_minus_sign: | N/A | |
|
||||||
| `Genre` | [][operations.GetLibraryItemsGenre](../../models/operations/getlibraryitemsgenre.md) | :heavy_minus_sign: | N/A | |
|
| `Genre` | [][operations.GetLibraryItemsGenre](../../models/operations/getlibraryitemsgenre.md) | :heavy_minus_sign: | N/A | |
|
||||||
| `Country` | [][operations.GetLibraryItemsCountry](../../models/operations/getlibraryitemscountry.md) | :heavy_minus_sign: | N/A | |
|
| `Country` | [][operations.GetLibraryItemsCountry](../../models/operations/getlibraryitemscountry.md) | :heavy_minus_sign: | N/A | |
|
||||||
| `Director` | [][operations.GetLibraryItemsDirector](../../models/operations/getlibraryitemsdirector.md) | :heavy_minus_sign: | N/A | |
|
| `Director` | [][operations.GetLibraryItemsDirector](../../models/operations/getlibraryitemsdirector.md) | :heavy_minus_sign: | N/A | |
|
||||||
| `Writer` | [][operations.GetLibraryItemsWriter](../../models/operations/getlibraryitemswriter.md) | :heavy_minus_sign: | N/A | |
|
| `Writer` | [][operations.GetLibraryItemsWriter](../../models/operations/getlibraryitemswriter.md) | :heavy_minus_sign: | N/A | |
|
||||||
|
| `Producer` | [][operations.GetLibraryItemsProducer](../../models/operations/getlibraryitemsproducer.md) | :heavy_minus_sign: | N/A | |
|
||||||
| `Collection` | [][operations.GetLibraryItemsCollection](../../models/operations/getlibraryitemscollection.md) | :heavy_minus_sign: | N/A | |
|
| `Collection` | [][operations.GetLibraryItemsCollection](../../models/operations/getlibraryitemscollection.md) | :heavy_minus_sign: | N/A | |
|
||||||
| `Role` | [][operations.GetLibraryItemsRole](../../models/operations/getlibraryitemsrole.md) | :heavy_minus_sign: | N/A | |
|
| `Role` | [][operations.GetLibraryItemsRole](../../models/operations/getlibraryitemsrole.md) | :heavy_minus_sign: | N/A | |
|
||||||
|
| `Ratings` | [][operations.Ratings](../../models/operations/ratings.md) | :heavy_minus_sign: | N/A | |
|
||||||
|
| `Similar` | [][operations.GetLibraryItemsSimilar](../../models/operations/getlibraryitemssimilar.md) | :heavy_minus_sign: | N/A | |
|
||||||
| `Location` | [][operations.GetLibraryItemsLocation](../../models/operations/getlibraryitemslocation.md) | :heavy_minus_sign: | N/A | |
|
| `Location` | [][operations.GetLibraryItemsLocation](../../models/operations/getlibraryitemslocation.md) | :heavy_minus_sign: | N/A | |
|
||||||
| `MediaGUID` | [][operations.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/> | |
|
| `Chapter` | [][operations.Chapter](../../models/operations/chapter.md) | :heavy_minus_sign: | N/A | |
|
||||||
| `UltraBlurColors` | [*operations.GetLibraryItemsUltraBlurColors](../../models/operations/getlibraryitemsultrablurcolors.md) | :heavy_minus_sign: | N/A | |
|
| `Marker` | [][operations.Marker](../../models/operations/marker.md) | :heavy_minus_sign: | N/A | |
|
||||||
| `MetaDataRating` | [][operations.MetaDataRating](../../models/operations/metadatarating.md) | :heavy_minus_sign: | N/A | |
|
| `Extras` | [*operations.Extras](../../models/operations/extras.md) | :heavy_minus_sign: | N/A | |
|
||||||
| `Image` | [][operations.GetLibraryItemsImage](../../models/operations/getlibraryitemsimage.md) | :heavy_minus_sign: | N/A | |
|
|
||||||
| `TitleSort` | **string* | :heavy_minus_sign: | N/A | Whale |
|
|
||||||
| `ViewCount` | **int* | :heavy_minus_sign: | N/A | 1 |
|
|
||||||
| `LastViewedAt` | **int* | :heavy_minus_sign: | N/A | 1682752242 |
|
|
||||||
| `OriginalTitle` | **string* | :heavy_minus_sign: | N/A | 映画 ブラッククローバー 魔法帝の剣 |
|
|
||||||
| `ViewOffset` | **int* | :heavy_minus_sign: | N/A | 5222500 |
|
|
||||||
| `SkipCount` | **int* | :heavy_minus_sign: | N/A | 1 |
|
|
||||||
| `Index` | **int* | :heavy_minus_sign: | N/A | 1 |
|
|
||||||
| `Theme` | **string* | :heavy_minus_sign: | N/A | /library/metadata/1/theme/1705636920 |
|
|
||||||
| `LeafCount` | **int* | :heavy_minus_sign: | N/A | 14 |
|
|
||||||
| `ViewedLeafCount` | **int* | :heavy_minus_sign: | N/A | 0 |
|
|
||||||
| `ChildCount` | **int* | :heavy_minus_sign: | N/A | 1 |
|
|
||||||
| `HasPremiumExtras` | **string* | :heavy_minus_sign: | N/A | 1 |
|
|
||||||
| `HasPremiumPrimaryExtra` | **string* | :heavy_minus_sign: | N/A | 1 |
|
|
||||||
| `ParentRatingKey` | **string* | :heavy_minus_sign: | The rating key of the parent item.<br/> | 66 |
|
|
||||||
| `ParentGUID` | **string* | :heavy_minus_sign: | N/A | plex://show/5d9c081b170e24001f2a7be4 |
|
|
||||||
| `ParentStudio` | **string* | :heavy_minus_sign: | N/A | UCP |
|
|
||||||
| `ParentKey` | **string* | :heavy_minus_sign: | N/A | /library/metadata/66 |
|
|
||||||
| `ParentTitle` | **string* | :heavy_minus_sign: | N/A | Caprica |
|
|
||||||
| `ParentIndex` | **int* | :heavy_minus_sign: | N/A | 1 |
|
|
||||||
| `ParentYear` | **int* | :heavy_minus_sign: | N/A | 2010 |
|
|
||||||
| `ParentThumb` | **string* | :heavy_minus_sign: | N/A | /library/metadata/66/thumb/1705716261 |
|
|
||||||
| `ParentTheme` | **string* | :heavy_minus_sign: | N/A | /library/metadata/66/theme/1705716261 |
|
|
||||||
@@ -1,9 +1,19 @@
|
|||||||
# GetLibraryItemsOptimizedForStreaming
|
# GetLibraryItemsOptimizedForStreaming
|
||||||
|
|
||||||
|
Has this media been optimized for streaming. NOTE: This can be 0, 1, false or true
|
||||||
|
|
||||||
## Values
|
|
||||||
|
|
||||||
| Name | Value |
|
## Supported Types
|
||||||
| --------------------------------------------- | --------------------------------------------- |
|
|
||||||
| `GetLibraryItemsOptimizedForStreamingDisable` | 0 |
|
### OptimizedForStreaming1
|
||||||
| `GetLibraryItemsOptimizedForStreamingEnable` | 1 |
|
|
||||||
|
```go
|
||||||
|
getLibraryItemsOptimizedForStreaming := operations.CreateGetLibraryItemsOptimizedForStreamingOptimizedForStreaming1(operations.OptimizedForStreaming1{/* values here */})
|
||||||
|
```
|
||||||
|
|
||||||
|
###
|
||||||
|
|
||||||
|
```go
|
||||||
|
getLibraryItemsOptimizedForStreaming := operations.CreateGetLibraryItemsOptimizedForStreamingBoolean(bool{/* values here */})
|
||||||
|
```
|
||||||
|
|
||||||
|
|||||||
@@ -0,0 +1,9 @@
|
|||||||
|
# GetLibraryItemsOptimizedForStreaming1
|
||||||
|
|
||||||
|
|
||||||
|
## Values
|
||||||
|
|
||||||
|
| Name | Value |
|
||||||
|
| ------------------------------------------- | ------------------------------------------- |
|
||||||
|
| `GetLibraryItemsOptimizedForStreaming1Zero` | 0 |
|
||||||
|
| `GetLibraryItemsOptimizedForStreaming1One` | 1 |
|
||||||
@@ -4,17 +4,19 @@
|
|||||||
## Fields
|
## Fields
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
| Field | Type | Required | Description | Example |
|
||||||
| -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- |
|
| --------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- |
|
||||||
| `ID` | *int* | :heavy_check_mark: | N/A | 119542 |
|
| `Accessible` | **bool* | :heavy_minus_sign: | Indicates if the part is accessible. | true |
|
||||||
| `Key` | *string* | :heavy_check_mark: | N/A | /library/parts/119542/1680457526/file.mkv |
|
| `Exists` | **bool* | :heavy_minus_sign: | Indicates if the part exists. | true |
|
||||||
| `Duration` | **int* | :heavy_minus_sign: | N/A | 11558112 |
|
| `ID` | *int64* | :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` | **string* | :heavy_minus_sign: | Key to access this part. | /library/parts/418385/1735864239/file.mkv |
|
||||||
| `Size` | *int64* | :heavy_check_mark: | N/A | 36158371307 |
|
|
||||||
| `Container` | *string* | :heavy_check_mark: | The container format of the media file.<br/> | mkv |
|
|
||||||
| `AudioProfile` | **string* | :heavy_minus_sign: | N/A | dts |
|
|
||||||
| `Has64bitOffsets` | **bool* | :heavy_minus_sign: | N/A | false |
|
|
||||||
| `OptimizedForStreaming` | **bool* | :heavy_minus_sign: | N/A | false |
|
|
||||||
| `VideoProfile` | **string* | :heavy_minus_sign: | N/A | main 10 |
|
|
||||||
| `Indexes` | **string* | :heavy_minus_sign: | N/A | sd |
|
| `Indexes` | **string* | :heavy_minus_sign: | N/A | sd |
|
||||||
|
| `Duration` | **int* | :heavy_minus_sign: | Duration of the part in milliseconds. | 9610350 |
|
||||||
|
| `File` | **string* | :heavy_minus_sign: | File path for the part. | /mnt/Movies_1/W/Wicked (2024).mkv |
|
||||||
|
| `Size` | **int64* | :heavy_minus_sign: | File size in bytes. | 30649952104 |
|
||||||
|
| `PacketLength` | **int* | :heavy_minus_sign: | N/A | 188 |
|
||||||
|
| `Container` | **string* | :heavy_minus_sign: | Container format of the part. | mkv |
|
||||||
|
| `VideoProfile` | **string* | :heavy_minus_sign: | Video profile for the part. | main 10 |
|
||||||
|
| `AudioProfile` | **string* | :heavy_minus_sign: | The audio profile used for the media (e.g., DTS, Dolby Digital, etc.). | dts |
|
||||||
|
| `Has64bitOffsets` | **bool* | :heavy_minus_sign: | N/A | false |
|
||||||
|
| `OptimizedForStreaming` | [*operations.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` | [*operations.GetLibraryItemsHasThumbnail](../../models/operations/getlibraryitemshasthumbnail.md) | :heavy_minus_sign: | N/A | 1 |
|
| `HasThumbnail` | [*operations.GetLibraryItemsHasThumbnail](../../models/operations/getlibraryitemshasthumbnail.md) | :heavy_minus_sign: | N/A | 1 |
|
||||||
| `Stream` | [][operations.GetLibraryItemsStream](../../models/operations/getlibraryitemsstream.md) | :heavy_minus_sign: | N/A | |
|
|
||||||
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` | *int64* | :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` | **string* | :heavy_minus_sign: | The character name or role. | Jimmy McGill |
|
||||||
|
| `Thumb` | **string* | :heavy_minus_sign: | URL for the role thumbnail image. | https://metadata-static.plex.tv/f/people/f2ca7b474cc984efbdd5c503a096285a.jpg |
|
||||||
@@ -4,10 +4,8 @@
|
|||||||
## Fields
|
## Fields
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
| Field | Type | Required | Description | Example |
|
||||||
| ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- |
|
| ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- |
|
||||||
| `ID` | **int64* | :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` | **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` | **string* | :heavy_minus_sign: | The thumbnail of the actor | https://metadata-static.plex.tv/2/people/27b85844536c39f3f9ac943aaad46608.jpg |
|
| `Role` | **string* | :heavy_minus_sign: | The role played by the actor in the media item. | Self - Judge |
|
||||||
| `Tag` | **string* | :heavy_minus_sign: | The name of the tag or actor. | Mike Smith |
|
| `Thumb` | **string* | :heavy_minus_sign: | The absolute URL of the thumbnail image for the actor. | https://metadata-static.plex.tv/7/people/708568fd018d7aa8b1032dcf867747e8.jpg |
|
||||||
| `TagKey` | **string* | :heavy_minus_sign: | Unique identifier for the tag. | 668e7e7b22bcad9064350c91 |
|
|
||||||
| `Role` | **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` | *int64* | :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` | *int64* | :heavy_check_mark: | N/A | 272796 |
|
|
||||||
| `StreamType` | *int64* | :heavy_check_mark: | Type of stream (1 = video, 2 = audio, 3 = subtitle) | 1 |
|
|
||||||
| `Default` | **bool* | :heavy_minus_sign: | Indicates if this is the default stream | true |
|
|
||||||
| `Selected` | **bool* | :heavy_minus_sign: | Indicates if the stream is selected | true |
|
|
||||||
| `Codec` | *string* | :heavy_check_mark: | Codec used by the stream | h264 |
|
|
||||||
| `Index` | *int64* | :heavy_check_mark: | The index of the stream | 0 |
|
|
||||||
| `Bitrate` | **int64* | :heavy_minus_sign: | The bitrate of the stream in kbps | 6273 |
|
|
||||||
| `ColorPrimaries` | **string* | :heavy_minus_sign: | The color primaries of the video stream | bt709 |
|
|
||||||
| `ColorRange` | **string* | :heavy_minus_sign: | The color range of the video stream | tv |
|
|
||||||
| `ColorSpace` | **string* | :heavy_minus_sign: | The color space of the video stream | bt709 |
|
|
||||||
| `ColorTrc` | **string* | :heavy_minus_sign: | The transfer characteristics (TRC) of the video stream | bt709 |
|
|
||||||
| `BitDepth` | **int64* | :heavy_minus_sign: | The bit depth of the video stream | 8 |
|
|
||||||
| `ChromaLocation` | **string* | :heavy_minus_sign: | The chroma location of the video stream | left |
|
|
||||||
| `StreamIdentifier` | **string* | :heavy_minus_sign: | The identifier of the video stream | 2 |
|
|
||||||
| `ChromaSubsampling` | **string* | :heavy_minus_sign: | The chroma subsampling format | 4:2:0 |
|
|
||||||
| `CodedHeight` | **int64* | :heavy_minus_sign: | The coded height of the video stream | 1088 |
|
|
||||||
| `CodedWidth` | **int64* | :heavy_minus_sign: | The coded width of the video stream | 1920 |
|
|
||||||
| `FrameRate` | **float64* | :heavy_minus_sign: | The frame rate of the video stream | 29.97 |
|
|
||||||
| `HasScalingMatrix` | **bool* | :heavy_minus_sign: | Indicates if the stream has a scaling matrix | false |
|
|
||||||
| `HearingImpaired` | **bool* | :heavy_minus_sign: | N/A | false |
|
|
||||||
| `ClosedCaptions` | **bool* | :heavy_minus_sign: | N/A | false |
|
|
||||||
| `EmbeddedInVideo` | **string* | :heavy_minus_sign: | N/A | 1 |
|
|
||||||
| `Height` | **int64* | :heavy_minus_sign: | The height of the video stream | 1080 |
|
|
||||||
| `Level` | **int64* | :heavy_minus_sign: | The level of the video codec | 40 |
|
|
||||||
| `Profile` | **string* | :heavy_minus_sign: | The profile of the video codec | main |
|
|
||||||
| `RefFrames` | **int64* | :heavy_minus_sign: | Number of reference frames | 4 |
|
|
||||||
| `ScanType` | **string* | :heavy_minus_sign: | The scan type (progressive or interlaced) | progressive |
|
|
||||||
| `Width` | **int64* | :heavy_minus_sign: | The width of the video stream | 1920 |
|
|
||||||
| `DisplayTitle` | **string* | :heavy_minus_sign: | Display title of the stream | 1080p (H.264) |
|
|
||||||
| `ExtendedDisplayTitle` | **string* | :heavy_minus_sign: | Extended display title of the stream | 1080p (H.264) |
|
|
||||||
| `Channels` | **int64* | :heavy_minus_sign: | Number of audio channels (for audio streams) | 2 |
|
|
||||||
| `Language` | **string* | :heavy_minus_sign: | The language of the stream (for audio/subtitle streams) | English |
|
|
||||||
| `LanguageTag` | **string* | :heavy_minus_sign: | Language tag of the stream | en |
|
|
||||||
| `LanguageCode` | **string* | :heavy_minus_sign: | Language code of the stream | eng |
|
|
||||||
| `AudioChannelLayout` | **string* | :heavy_minus_sign: | The audio channel layout | stereo |
|
|
||||||
| `SamplingRate` | **int64* | :heavy_minus_sign: | Sampling rate of the audio stream in Hz | 48000 |
|
|
||||||
| `Title` | **string* | :heavy_minus_sign: | Title of the subtitle track (for subtitle streams) | English |
|
|
||||||
| `CanAutoSync` | **bool* | :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` | **string* | :heavy_minus_sign: | N/A | clip |
|
| ------------------------------- | ------------------------------- |
|
||||||
| `Title` | *string* | :heavy_check_mark: | N/A | TV Shows |
|
| `GetLibraryItemsTypeMovie` | movie |
|
||||||
| `Active` | *bool* | :heavy_check_mark: | N/A | false |
|
| `GetLibraryItemsTypeTvShow` | show |
|
||||||
| `Filter` | [][operations.GetLibraryItemsFilter](../../models/operations/getlibraryitemsfilter.md) | :heavy_minus_sign: | N/A | |
|
| `GetLibraryItemsTypeSeason` | season |
|
||||||
| `Sort` | [][operations.GetLibraryItemsSort](../../models/operations/getlibraryitemssort.md) | :heavy_minus_sign: | N/A | |
|
| `GetLibraryItemsTypeEpisode` | episode |
|
||||||
| `Field` | [][operations.GetLibraryItemsField](../../models/operations/getlibraryitemsfield.md) | :heavy_minus_sign: | N/A | |
|
| `GetLibraryItemsTypeArtist` | artist |
|
||||||
|
| `GetLibraryItemsTypeAlbum` | album |
|
||||||
|
| `GetLibraryItemsTypeTrack` | track |
|
||||||
|
| `GetLibraryItemsTypePhotoAlbum` | photoalbum |
|
||||||
|
| `GetLibraryItemsTypePhoto` | photo |
|
||||||
|
| `GetLibraryItemsTypeCollection` | collection |
|
||||||
@@ -4,5 +4,7 @@
|
|||||||
## Fields
|
## Fields
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
| Field | Type | Required | Description | Example |
|
||||||
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
|
| ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- |
|
||||||
| `Tag` | **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` | **string* | :heavy_minus_sign: | The absolute URL of the thumbnail image for the writer. | https://metadata-static.plex.tv/8/people/8d65fa96804802e08f2de09fe014408e.jpg |
|
||||||
@@ -5,10 +5,10 @@ Has this media been optimized for streaming. NOTE: This can be 0, 1, false or tr
|
|||||||
|
|
||||||
## Supported Types
|
## Supported Types
|
||||||
|
|
||||||
### GetLibrarySectionsAllOptimizedForStreaming1
|
### GetLibrarySectionsAllOptimizedForStreamingLibrary1
|
||||||
|
|
||||||
```go
|
```go
|
||||||
getLibrarySectionsAllLibraryOptimizedForStreaming := operations.CreateGetLibrarySectionsAllLibraryOptimizedForStreamingGetLibrarySectionsAllOptimizedForStreaming1(operations.GetLibrarySectionsAllOptimizedForStreaming1{/* values here */})
|
getLibrarySectionsAllLibraryOptimizedForStreaming := operations.CreateGetLibrarySectionsAllLibraryOptimizedForStreamingGetLibrarySectionsAllOptimizedForStreamingLibrary1(operations.GetLibrarySectionsAllOptimizedForStreamingLibrary1{/* values here */})
|
||||||
```
|
```
|
||||||
|
|
||||||
###
|
###
|
||||||
|
|||||||
@@ -12,8 +12,8 @@
|
|||||||
| `Art` | *string* | :heavy_check_mark: | URL for the background artwork of the media container. | /:/resources/show-fanart.jpg |
|
| `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 |
|
| `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 |
|
| `Identifier` | *string* | :heavy_check_mark: | An plugin identifier for the media container. | com.plexapp.plugins.library |
|
||||||
| `LibrarySectionID` | *int64* | :heavy_check_mark: | The unique identifier for the library section. | 2 |
|
| `LibrarySectionID` | **int64* | :heavy_minus_sign: | The unique identifier for the library section. | 2 |
|
||||||
| `LibrarySectionTitle` | *string* | :heavy_check_mark: | The title of the library section. | TV Series |
|
| `LibrarySectionTitle` | **string* | :heavy_minus_sign: | The title of the library section. | TV Series |
|
||||||
| `LibrarySectionUUID` | **string* | :heavy_minus_sign: | The universally unique identifier for the library section. | e69655a2-ef48-4aba-bb19-0cc34d1e7d36 |
|
| `LibrarySectionUUID` | **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/ |
|
| `MediaTagPrefix` | *string* | :heavy_check_mark: | The prefix used for media tag resource paths. | /system/bundle/media/flags/ |
|
||||||
| `MediaTagVersion` | *int64* | :heavy_check_mark: | The version number for media tags. | 1734362201 |
|
| `MediaTagVersion` | *int64* | :heavy_check_mark: | The version number for media tags. | 1734362201 |
|
||||||
|
|||||||
@@ -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` | [types.Date](../../types/date.md) | :heavy_check_mark: | The original release date of the media item. | 2022-12-14 |
|
| `OriginallyAvailableAt` | [*types.Date](../../types/date.md) | :heavy_minus_sign: | The original release date of the media item. | 2022-12-14 |
|
||||||
| `AddedAt` | *int64* | :heavy_check_mark: | N/A | 1556281940 |
|
| `AddedAt` | *int64* | :heavy_check_mark: | N/A | 1556281940 |
|
||||||
| `UpdatedAt` | **int64* | :heavy_minus_sign: | Unix epoch datetime in seconds | 1556281940 |
|
| `UpdatedAt` | **int64* | :heavy_minus_sign: | Unix epoch datetime in seconds | 1556281940 |
|
||||||
| `AudienceRatingImage` | **string* | :heavy_minus_sign: | The URL for the audience rating image. | rottentomatoes://image.rating.upright |
|
| `AudienceRatingImage` | **string* | :heavy_minus_sign: | The URL for the audience rating image. | rottentomatoes://image.rating.upright |
|
||||||
|
|||||||
@@ -5,10 +5,10 @@ Has this media been optimized for streaming. NOTE: This can be 0, 1, false or tr
|
|||||||
|
|
||||||
## Supported Types
|
## Supported Types
|
||||||
|
|
||||||
### OptimizedForStreaming1
|
### GetLibrarySectionsAllOptimizedForStreaming1
|
||||||
|
|
||||||
```go
|
```go
|
||||||
getLibrarySectionsAllOptimizedForStreaming := operations.CreateGetLibrarySectionsAllOptimizedForStreamingOptimizedForStreaming1(operations.OptimizedForStreaming1{/* values here */})
|
getLibrarySectionsAllOptimizedForStreaming := operations.CreateGetLibrarySectionsAllOptimizedForStreamingGetLibrarySectionsAllOptimizedForStreaming1(operations.GetLibrarySectionsAllOptimizedForStreaming1{/* values here */})
|
||||||
```
|
```
|
||||||
|
|
||||||
###
|
###
|
||||||
|
|||||||
@@ -0,0 +1,9 @@
|
|||||||
|
# GetLibrarySectionsAllOptimizedForStreamingLibrary1
|
||||||
|
|
||||||
|
|
||||||
|
## Values
|
||||||
|
|
||||||
|
| Name | Value |
|
||||||
|
| -------------------------------------------------------- | -------------------------------------------------------- |
|
||||||
|
| `GetLibrarySectionsAllOptimizedForStreamingLibrary1Zero` | 0 |
|
||||||
|
| `GetLibrarySectionsAllOptimizedForStreamingLibrary1One` | 1 |
|
||||||
@@ -4,9 +4,9 @@
|
|||||||
## Fields
|
## Fields
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
| Field | Type | Required | Description | Example |
|
||||||
| -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- |
|
| -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- |
|
||||||
| `ID` | *int64* | :heavy_check_mark: | Unique stream identifier. | 1002625 |
|
| `ID` | *int64* | :heavy_check_mark: | Unique stream identifier. | 1002625 |
|
||||||
| `StreamType` | [operations.GetLibrarySectionsAllStreamType](../../models/operations/getlibrarysectionsallstreamtype.md) | :heavy_check_mark: | Stream type:<br/> - 1 = video<br/> - 2 = audio<br/> - 3 = subtitle<br/> | 1 |
|
| `StreamType` | *int64* | :heavy_check_mark: | Stream type:<br/> - VIDEO = 1<br/> - AUDIO = 2<br/> - SUBTITLE = 3<br/> | |
|
||||||
| `Format` | **string* | :heavy_minus_sign: | Format of the stream (e.g., srt). | srt |
|
| `Format` | **string* | :heavy_minus_sign: | Format of the stream (e.g., srt). | srt |
|
||||||
| `Default` | **bool* | :heavy_minus_sign: | Indicates if this stream is default. | true |
|
| `Default` | **bool* | :heavy_minus_sign: | Indicates if this stream is default. | true |
|
||||||
| `Codec` | *string* | :heavy_check_mark: | Codec used by the stream. | hevc |
|
| `Codec` | *string* | :heavy_check_mark: | Codec used by the stream. | hevc |
|
||||||
|
|||||||
@@ -1,16 +0,0 @@
|
|||||||
# GetLibrarySectionsAllStreamType
|
|
||||||
|
|
||||||
Stream type:
|
|
||||||
- 1 = video
|
|
||||||
- 2 = audio
|
|
||||||
- 3 = subtitle
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## Values
|
|
||||||
|
|
||||||
| Name | Value |
|
|
||||||
| ----------------------------------------- | ----------------------------------------- |
|
|
||||||
| `GetLibrarySectionsAllStreamTypeVideo` | 1 |
|
|
||||||
| `GetLibrarySectionsAllStreamTypeAudio` | 2 |
|
|
||||||
| `GetLibrarySectionsAllStreamTypeSubtitle` | 3 |
|
|
||||||
11
docs/models/operations/getmediametadataattributes.md
Normal file
11
docs/models/operations/getmediametadataattributes.md
Normal file
@@ -0,0 +1,11 @@
|
|||||||
|
# GetMediaMetaDataAttributes
|
||||||
|
|
||||||
|
Attributes associated with the marker.
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| -------------------------------------------- | -------------------------------------------- | -------------------------------------------- | -------------------------------------------- | -------------------------------------------- |
|
||||||
|
| `ID` | *int64* | :heavy_check_mark: | The identifier for the attributes. | 306970 |
|
||||||
|
| `Version` | **int64* | :heavy_minus_sign: | The version number of the marker attributes. | 4 |
|
||||||
15
docs/models/operations/getmediametadatachapter.md
Normal file
15
docs/models/operations/getmediametadatachapter.md
Normal file
@@ -0,0 +1,15 @@
|
|||||||
|
# GetMediaMetaDataChapter
|
||||||
|
|
||||||
|
The thumbnail for the chapter
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ |
|
||||||
|
| `ID` | *int64* | :heavy_check_mark: | N/A | 4 |
|
||||||
|
| `Filter` | *string* | :heavy_check_mark: | N/A | thumb=4 |
|
||||||
|
| `Index` | *int64* | :heavy_check_mark: | N/A | 1 |
|
||||||
|
| `StartTimeOffset` | *int64* | :heavy_check_mark: | N/A | 0 |
|
||||||
|
| `EndTimeOffset` | *int64* | :heavy_check_mark: | N/A | 100100 |
|
||||||
|
| `Thumb` | *string* | :heavy_check_mark: | N/A | /library/media/46883/chapterImages/1 |
|
||||||
8
docs/models/operations/getmediametadataextras.md
Normal file
8
docs/models/operations/getmediametadataextras.md
Normal file
@@ -0,0 +1,8 @@
|
|||||||
|
# GetMediaMetaDataExtras
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ----------------------- | ----------------------- | ----------------------- | ----------------------- | ----------------------- |
|
||||||
|
| `Size` | **int64* | :heavy_minus_sign: | The size of the extras. | 1 |
|
||||||
@@ -3,6 +3,7 @@
|
|||||||
Indicates if the part has a thumbnail.
|
Indicates if the part has a thumbnail.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## Values
|
## Values
|
||||||
|
|
||||||
| Name | Value |
|
| Name | Value |
|
||||||
|
|||||||
@@ -3,6 +3,7 @@
|
|||||||
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
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## Supported Types
|
## Supported Types
|
||||||
|
|
||||||
### GetMediaMetaDataOptimizedForStreamingLibrary1
|
### GetMediaMetaDataOptimizedForStreamingLibrary1
|
||||||
|
|||||||
15
docs/models/operations/getmediametadatamarker.md
Normal file
15
docs/models/operations/getmediametadatamarker.md
Normal file
@@ -0,0 +1,15 @@
|
|||||||
|
# GetMediaMetaDataMarker
|
||||||
|
|
||||||
|
The final status of the marker
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- |
|
||||||
|
| `ID` | *int64* | :heavy_check_mark: | N/A | 306970 |
|
||||||
|
| `Type` | *string* | :heavy_check_mark: | N/A | credits |
|
||||||
|
| `StartTimeOffset` | *int64* | :heavy_check_mark: | N/A | 4176050 |
|
||||||
|
| `EndTimeOffset` | *int64* | :heavy_check_mark: | N/A | 4393389 |
|
||||||
|
| `Final` | **bool* | :heavy_minus_sign: | N/A | true |
|
||||||
|
| `Attributes` | [*operations.GetMediaMetaDataAttributes](../../models/operations/getmediametadataattributes.md) | :heavy_minus_sign: | Attributes associated with the marker. | |
|
||||||
@@ -4,7 +4,7 @@
|
|||||||
## Fields
|
## Fields
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
| Field | Type | Required | Description | Example |
|
||||||
| --------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- |
|
| -------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||||
| `ID` | *int64* | :heavy_check_mark: | Unique media identifier. | 387322 |
|
| `ID` | *int64* | :heavy_check_mark: | Unique media identifier. | 387322 |
|
||||||
| `Duration` | **int* | :heavy_minus_sign: | Duration of the media in milliseconds. | 9610350 |
|
| `Duration` | **int* | :heavy_minus_sign: | Duration of the media in milliseconds. | 9610350 |
|
||||||
| `Bitrate` | **int* | :heavy_minus_sign: | Bitrate in bits per second. | 25512 |
|
| `Bitrate` | **int* | :heavy_minus_sign: | Bitrate in bits per second. | 25512 |
|
||||||
@@ -13,14 +13,14 @@
|
|||||||
| `AspectRatio` | **float32* | :heavy_minus_sign: | Aspect ratio of the video. | 2.35 |
|
| `AspectRatio` | **float32* | :heavy_minus_sign: | Aspect ratio of the video. | 2.35 |
|
||||||
| `AudioChannels` | **int* | :heavy_minus_sign: | Number of audio channels. | 6 |
|
| `AudioChannels` | **int* | :heavy_minus_sign: | Number of audio channels. | 6 |
|
||||||
| `DisplayOffset` | **int* | :heavy_minus_sign: | N/A | 50 |
|
| `DisplayOffset` | **int* | :heavy_minus_sign: | N/A | 50 |
|
||||||
| `AudioCodec` | **string* | :heavy_minus_sign: | Audio codec used. | eac3 |
|
| `AudioCodec` | **string* | :heavy_minus_sign: | Audio codec used. | aac |
|
||||||
| `VideoCodec` | **string* | :heavy_minus_sign: | Video codec used. | hevc |
|
| `VideoCodec` | **string* | :heavy_minus_sign: | Video codec used. | hevc |
|
||||||
| `VideoResolution` | **string* | :heavy_minus_sign: | Video resolution (e.g., 4k). | 4k |
|
| `VideoResolution` | **string* | :heavy_minus_sign: | Video resolution (e.g., 4k). | 4k |
|
||||||
| `Container` | **string* | :heavy_minus_sign: | File container type. | mkv |
|
| `Container` | **string* | :heavy_minus_sign: | Container format of the media. | mp4 |
|
||||||
| `VideoFrameRate` | **string* | :heavy_minus_sign: | Frame rate of the video. Values found include NTSC, PAL, 24p<br/> | 24p |
|
| `VideoFrameRate` | **string* | :heavy_minus_sign: | Frame rate of the video. Values found include NTSC, PAL, 24p<br/> | 24p |
|
||||||
| `VideoProfile` | **string* | :heavy_minus_sign: | Video profile (e.g., main 10). | main 10 |
|
| `VideoProfile` | **string* | :heavy_minus_sign: | Video profile (e.g., main 10). | main 10 |
|
||||||
| `HasVoiceActivity` | **bool* | :heavy_minus_sign: | Indicates whether voice activity is detected. | false |
|
| `HasVoiceActivity` | **bool* | :heavy_minus_sign: | Indicates whether voice activity is detected. | false |
|
||||||
| `AudioProfile` | **string* | :heavy_minus_sign: | The audio profile used for the media (e.g., DTS, Dolby Digital, etc.). | dts |
|
| `AudioProfile` | **string* | :heavy_minus_sign: | The audio profile used for the media (e.g., DTS, Dolby Digital, etc.). | dts |
|
||||||
| `OptimizedForStreaming` | [*operations.GetMediaMetaDataOptimizedForStreaming](../../models/operations/getmediametadataoptimizedforstreaming.md) | :heavy_minus_sign: | Has this media been optimized for streaming. NOTE: This can be 0, 1, false or true | |
|
| `OptimizedForStreaming` | [*operations.GetMediaMetaDataOptimizedForStreaming](../../models/operations/getmediametadataoptimizedforstreaming.md) | :heavy_minus_sign: | Has this media been optimized for streaming. NOTE: This can be 0, 1, false or true | |
|
||||||
| `Has64bitOffsets` | **bool* | :heavy_minus_sign: | N/A | false |
|
| `Has64bitOffsets` | **bool* | :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` | [][operations.GetMediaMetaDataPart](../../models/operations/getmediametadatapart.md) | :heavy_minus_sign: | An array of parts for this media item. | |
|
| `Part` | [][operations.GetMediaMetaDataPart](../../models/operations/getmediametadatapart.md) | :heavy_minus_sign: | N/A | |
|
||||||
@@ -8,8 +8,8 @@
|
|||||||
| `Size` | *int* | :heavy_check_mark: | Number of media items returned in this response. | 50 |
|
| `Size` | *int* | :heavy_check_mark: | Number of media items returned in this response. | 50 |
|
||||||
| `AllowSync` | *bool* | :heavy_check_mark: | Indicates whether syncing is allowed. | false |
|
| `AllowSync` | *bool* | :heavy_check_mark: | Indicates whether syncing is allowed. | false |
|
||||||
| `Identifier` | *string* | :heavy_check_mark: | An plugin identifier for the media container. | com.plexapp.plugins.library |
|
| `Identifier` | *string* | :heavy_check_mark: | An plugin identifier for the media container. | com.plexapp.plugins.library |
|
||||||
| `LibrarySectionID` | *int64* | :heavy_check_mark: | The unique identifier for the library section. | 2 |
|
| `LibrarySectionID` | **int64* | :heavy_minus_sign: | The unique identifier for the library section. | 2 |
|
||||||
| `LibrarySectionTitle` | *string* | :heavy_check_mark: | The title of the library section. | TV Series |
|
| `LibrarySectionTitle` | **string* | :heavy_minus_sign: | The title of the library section. | TV Series |
|
||||||
| `LibrarySectionUUID` | **string* | :heavy_minus_sign: | The universally unique identifier for the library section. | e69655a2-ef48-4aba-bb19-0cc34d1e7d36 |
|
| `LibrarySectionUUID` | **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/ |
|
| `MediaTagPrefix` | *string* | :heavy_check_mark: | The prefix used for media tag resource paths. | /system/bundle/media/flags/ |
|
||||||
| `MediaTagVersion` | *int64* | :heavy_check_mark: | The version number for media tags. | 1734362201 |
|
| `MediaTagVersion` | *int64* | :heavy_check_mark: | The version number for media tags. | 1734362201 |
|
||||||
|
|||||||
@@ -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` | [types.Date](../../types/date.md) | :heavy_check_mark: | The original release date of the media item. | 2022-12-14 |
|
| `OriginallyAvailableAt` | [*types.Date](../../types/date.md) | :heavy_minus_sign: | The original release date of the media item. | 2022-12-14 |
|
||||||
| `AddedAt` | *int64* | :heavy_check_mark: | N/A | 1556281940 |
|
| `AddedAt` | *int64* | :heavy_check_mark: | N/A | 1556281940 |
|
||||||
| `UpdatedAt` | **int64* | :heavy_minus_sign: | Unix epoch datetime in seconds | 1556281940 |
|
| `UpdatedAt` | **int64* | :heavy_minus_sign: | Unix epoch datetime in seconds | 1556281940 |
|
||||||
| `AudienceRatingImage` | **string* | :heavy_minus_sign: | The URL for the audience rating image. | rottentomatoes://image.rating.upright |
|
| `AudienceRatingImage` | **string* | :heavy_minus_sign: | The URL for the audience rating image. | rottentomatoes://image.rating.upright |
|
||||||
@@ -64,9 +64,9 @@ Unknown
|
|||||||
| `UserRating` | **float32* | :heavy_minus_sign: | The rating provided by a user for the item. This value is expressed as a decimal number. | 10 |
|
| `UserRating` | **float32* | :heavy_minus_sign: | The rating provided by a user for the item. This value is expressed as a decimal number. | 10 |
|
||||||
| `Image` | [][operations.GetMediaMetaDataImage](../../models/operations/getmediametadataimage.md) | :heavy_minus_sign: | N/A | |
|
| `Image` | [][operations.GetMediaMetaDataImage](../../models/operations/getmediametadataimage.md) | :heavy_minus_sign: | N/A | |
|
||||||
| `UltraBlurColors` | [*operations.GetMediaMetaDataUltraBlurColors](../../models/operations/getmediametadataultrablurcolors.md) | :heavy_minus_sign: | N/A | |
|
| `UltraBlurColors` | [*operations.GetMediaMetaDataUltraBlurColors](../../models/operations/getmediametadataultrablurcolors.md) | :heavy_minus_sign: | N/A | |
|
||||||
| `LibrarySectionID` | *int64* | :heavy_check_mark: | The identifier for the library section. | 1 |
|
| `LibrarySectionID` | **int64* | :heavy_minus_sign: | The identifier for the library section. | 1 |
|
||||||
| `LibrarySectionTitle` | *string* | :heavy_check_mark: | The title of the library section. | Movies |
|
| `LibrarySectionTitle` | **string* | :heavy_minus_sign: | The title of the library section. | Movies |
|
||||||
| `LibrarySectionKey` | *string* | :heavy_check_mark: | The key corresponding to the library section. | /library/sections/1 |
|
| `LibrarySectionKey` | **string* | :heavy_minus_sign: | The key corresponding to the library section. | /library/sections/1 |
|
||||||
| `Guids` | [][operations.GetMediaMetaDataGuids](../../models/operations/getmediametadataguids.md) | :heavy_minus_sign: | N/A | |
|
| `Guids` | [][operations.GetMediaMetaDataGuids](../../models/operations/getmediametadataguids.md) | :heavy_minus_sign: | N/A | |
|
||||||
| `Media` | [][operations.GetMediaMetaDataMedia](../../models/operations/getmediametadatamedia.md) | :heavy_minus_sign: | N/A | |
|
| `Media` | [][operations.GetMediaMetaDataMedia](../../models/operations/getmediametadatamedia.md) | :heavy_minus_sign: | N/A | |
|
||||||
| `Genre` | [][operations.GetMediaMetaDataGenre](../../models/operations/getmediametadatagenre.md) | :heavy_minus_sign: | N/A | |
|
| `Genre` | [][operations.GetMediaMetaDataGenre](../../models/operations/getmediametadatagenre.md) | :heavy_minus_sign: | N/A | |
|
||||||
@@ -75,9 +75,9 @@ Unknown
|
|||||||
| `Writer` | [][operations.GetMediaMetaDataWriter](../../models/operations/getmediametadatawriter.md) | :heavy_minus_sign: | N/A | |
|
| `Writer` | [][operations.GetMediaMetaDataWriter](../../models/operations/getmediametadatawriter.md) | :heavy_minus_sign: | N/A | |
|
||||||
| `Producer` | [][operations.GetMediaMetaDataProducer](../../models/operations/getmediametadataproducer.md) | :heavy_minus_sign: | N/A | |
|
| `Producer` | [][operations.GetMediaMetaDataProducer](../../models/operations/getmediametadataproducer.md) | :heavy_minus_sign: | N/A | |
|
||||||
| `Role` | [][operations.GetMediaMetaDataRole](../../models/operations/getmediametadatarole.md) | :heavy_minus_sign: | N/A | |
|
| `Role` | [][operations.GetMediaMetaDataRole](../../models/operations/getmediametadatarole.md) | :heavy_minus_sign: | N/A | |
|
||||||
| `Ratings` | [][operations.Ratings](../../models/operations/ratings.md) | :heavy_minus_sign: | N/A | |
|
| `Ratings` | [][operations.GetMediaMetaDataRatings](../../models/operations/getmediametadataratings.md) | :heavy_minus_sign: | N/A | |
|
||||||
| `Similar` | [][operations.GetMediaMetaDataSimilar](../../models/operations/getmediametadatasimilar.md) | :heavy_minus_sign: | N/A | |
|
| `Similar` | [][operations.GetMediaMetaDataSimilar](../../models/operations/getmediametadatasimilar.md) | :heavy_minus_sign: | N/A | |
|
||||||
| `Location` | [][operations.GetMediaMetaDataLocation](../../models/operations/getmediametadatalocation.md) | :heavy_minus_sign: | N/A | |
|
| `Location` | [][operations.GetMediaMetaDataLocation](../../models/operations/getmediametadatalocation.md) | :heavy_minus_sign: | N/A | |
|
||||||
| `Chapter` | [][operations.Chapter](../../models/operations/chapter.md) | :heavy_minus_sign: | N/A | |
|
| `Chapter` | [][operations.GetMediaMetaDataChapter](../../models/operations/getmediametadatachapter.md) | :heavy_minus_sign: | N/A | |
|
||||||
| `Marker` | [][operations.Marker](../../models/operations/marker.md) | :heavy_minus_sign: | N/A | |
|
| `Marker` | [][operations.GetMediaMetaDataMarker](../../models/operations/getmediametadatamarker.md) | :heavy_minus_sign: | N/A | |
|
||||||
| `Extras` | [*operations.Extras](../../models/operations/extras.md) | :heavy_minus_sign: | N/A | |
|
| `Extras` | [*operations.GetMediaMetaDataExtras](../../models/operations/getmediametadataextras.md) | :heavy_minus_sign: | N/A | |
|
||||||
@@ -8,16 +8,16 @@
|
|||||||
| `Accessible` | **bool* | :heavy_minus_sign: | Indicates if the part is accessible. | true |
|
| `Accessible` | **bool* | :heavy_minus_sign: | Indicates if the part is accessible. | true |
|
||||||
| `Exists` | **bool* | :heavy_minus_sign: | Indicates if the part exists. | true |
|
| `Exists` | **bool* | :heavy_minus_sign: | Indicates if the part exists. | true |
|
||||||
| `ID` | *int64* | :heavy_check_mark: | Unique part identifier. | 418385 |
|
| `ID` | *int64* | :heavy_check_mark: | Unique part identifier. | 418385 |
|
||||||
| `Key` | *string* | :heavy_check_mark: | Key to access this part. | /library/parts/418385/1735864239/file.mkv |
|
| `Key` | **string* | :heavy_minus_sign: | Key to access this part. | /library/parts/418385/1735864239/file.mkv |
|
||||||
| `Indexes` | **string* | :heavy_minus_sign: | N/A | sd |
|
| `Indexes` | **string* | :heavy_minus_sign: | N/A | sd |
|
||||||
| `Duration` | **int* | :heavy_minus_sign: | Duration of the part in milliseconds. | 9610350 |
|
| `Duration` | **int* | :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 |
|
| `File` | **string* | :heavy_minus_sign: | File path for the part. | /mnt/Movies_1/W/Wicked (2024).mkv |
|
||||||
| `Size` | *int64* | :heavy_check_mark: | File size in bytes. | 30649952104 |
|
| `Size` | **int64* | :heavy_minus_sign: | File size in bytes. | 30649952104 |
|
||||||
| `PacketLength` | **int* | :heavy_minus_sign: | N/A | 188 |
|
| `PacketLength` | **int* | :heavy_minus_sign: | N/A | 188 |
|
||||||
| `Container` | **string* | :heavy_minus_sign: | Container format of the part. | mkv |
|
| `Container` | **string* | :heavy_minus_sign: | Container format of the part. | mkv |
|
||||||
| `VideoProfile` | **string* | :heavy_minus_sign: | Video profile for the part. | main 10 |
|
| `VideoProfile` | **string* | :heavy_minus_sign: | Video profile for the part. | main 10 |
|
||||||
| `AudioProfile` | **string* | :heavy_minus_sign: | The audio profile used for the media (e.g., DTS, Dolby Digital, etc.). | dts |
|
| `AudioProfile` | **string* | :heavy_minus_sign: | The audio profile used for the media (e.g., DTS, Dolby Digital, etc.). | dts |
|
||||||
| `Has64bitOffsets` | **bool* | :heavy_minus_sign: | N/A | false |
|
| `Has64bitOffsets` | **bool* | :heavy_minus_sign: | N/A | false |
|
||||||
| `OptimizedForStreaming` | [*operations.GetMediaMetaDataLibraryOptimizedForStreaming](../../models/operations/getmediametadatalibraryoptimizedforstreaming.md) | :heavy_minus_sign: | Has this media been optimized for streaming. NOTE: This can be 0, 1, false or true | |
|
| `OptimizedForStreaming` | [*operations.GetMediaMetaDataLibraryOptimizedForStreaming](../../models/operations/getmediametadatalibraryoptimizedforstreaming.md) | :heavy_minus_sign: | Has this media been optimized for streaming. NOTE: This can be 0, 1, false or true<br/> | |
|
||||||
| `HasThumbnail` | [*operations.GetMediaMetaDataHasThumbnail](../../models/operations/getmediametadatahasthumbnail.md) | :heavy_minus_sign: | N/A | 1 |
|
| `HasThumbnail` | [*operations.GetMediaMetaDataHasThumbnail](../../models/operations/getmediametadatahasthumbnail.md) | :heavy_minus_sign: | N/A | 1 |
|
||||||
| `Stream` | [][operations.GetMediaMetaDataStream](../../models/operations/getmediametadatastream.md) | :heavy_minus_sign: | An array of streams for this part. | |
|
| `Stream` | [][operations.GetMediaMetaDataStream](../../models/operations/getmediametadatastream.md) | :heavy_minus_sign: | N/A | |
|
||||||
@@ -1,10 +1,10 @@
|
|||||||
# MetaDataRating
|
# GetMediaMetaDataRatings
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
| Field | Type | Required | Description | Example |
|
||||||
| -------------------------------------------- | -------------------------------------------- | -------------------------------------------- | -------------------------------------------- | -------------------------------------------- |
|
| -------------------------------------------- | -------------------------------------------- | -------------------------------------------- | -------------------------------------------- | -------------------------------------------- |
|
||||||
| `Image` | *string* | :heavy_check_mark: | A URI or path to the rating image. | themoviedb://image.rating |
|
| `Image` | *string* | :heavy_check_mark: | The image or reference for the rating. | imdb://image.rating |
|
||||||
| `Value` | *float32* | :heavy_check_mark: | The value of the rating. | 3 |
|
| `Value` | *float32* | :heavy_check_mark: | The rating value. | 9 |
|
||||||
| `Type` | *string* | :heavy_check_mark: | The type of rating (e.g., audience, critic). | audience |
|
| `Type` | *string* | :heavy_check_mark: | The type of rating (e.g., audience, critic). | audience |
|
||||||
@@ -4,12 +4,12 @@
|
|||||||
## Fields
|
## Fields
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
| Field | Type | Required | Description | Example |
|
||||||
| ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- |
|
| -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- |
|
||||||
| `ID` | *int64* | :heavy_check_mark: | Unique stream identifier. | 1002625 |
|
| `ID` | *int64* | :heavy_check_mark: | Unique stream identifier. | 1002625 |
|
||||||
| `StreamType` | [operations.GetMediaMetaDataStreamType](../../models/operations/getmediametadatastreamtype.md) | :heavy_check_mark: | Stream type:<br/> - 1 = video<br/> - 2 = audio<br/> - 3 = subtitle<br/> | 1 |
|
| `StreamType` | *int64* | :heavy_check_mark: | Stream type:<br/> - VIDEO = 1<br/> - AUDIO = 2<br/> - SUBTITLE = 3<br/> | |
|
||||||
| `Format` | **string* | :heavy_minus_sign: | Format of the stream (e.g., srt). | srt |
|
| `Format` | **string* | :heavy_minus_sign: | Format of the stream (e.g., srt). | srt |
|
||||||
| `Default` | **bool* | :heavy_minus_sign: | Indicates if this stream is default. | true |
|
| `Default` | **bool* | :heavy_minus_sign: | Indicates if this stream is default. | true |
|
||||||
| `Codec` | *string* | :heavy_check_mark: | Codec used by the stream. | hevc |
|
| `Codec` | **string* | :heavy_minus_sign: | Codec used by the stream. | hevc |
|
||||||
| `Index` | **int* | :heavy_minus_sign: | Index of the stream. | 0 |
|
| `Index` | **int* | :heavy_minus_sign: | Index of the stream. | 0 |
|
||||||
| `Bitrate` | **int* | :heavy_minus_sign: | Bitrate of the stream. | 24743 |
|
| `Bitrate` | **int* | :heavy_minus_sign: | Bitrate of the stream. | 24743 |
|
||||||
| `Language` | **string* | :heavy_minus_sign: | Language of the stream. | English |
|
| `Language` | **string* | :heavy_minus_sign: | Language of the stream. | English |
|
||||||
@@ -45,8 +45,8 @@
|
|||||||
| `EmbeddedInVideo` | **string* | :heavy_minus_sign: | N/A | progressive |
|
| `EmbeddedInVideo` | **string* | :heavy_minus_sign: | N/A | progressive |
|
||||||
| `RefFrames` | **int* | :heavy_minus_sign: | Number of reference frames. | 1 |
|
| `RefFrames` | **int* | :heavy_minus_sign: | Number of reference frames. | 1 |
|
||||||
| `Width` | **int* | :heavy_minus_sign: | Width of the video stream. | 3840 |
|
| `Width` | **int* | :heavy_minus_sign: | Width of the video stream. | 3840 |
|
||||||
| `DisplayTitle` | *string* | :heavy_check_mark: | Display title for the stream. | 4K DoVi/HDR10 (HEVC Main 10) |
|
| `DisplayTitle` | **string* | :heavy_minus_sign: | Display title for the stream. | 4K DoVi/HDR10 (HEVC Main 10) |
|
||||||
| `ExtendedDisplayTitle` | *string* | :heavy_check_mark: | Extended display title for the stream. | 4K DoVi/HDR10 (HEVC Main 10) |
|
| `ExtendedDisplayTitle` | **string* | :heavy_minus_sign: | Extended display title for the stream. | 4K DoVi/HDR10 (HEVC Main 10) |
|
||||||
| `Selected` | **bool* | :heavy_minus_sign: | Indicates if this stream is selected (applicable for audio streams). | true |
|
| `Selected` | **bool* | :heavy_minus_sign: | Indicates if this stream is selected (applicable for audio streams). | true |
|
||||||
| `Forced` | **bool* | :heavy_minus_sign: | N/A | true |
|
| `Forced` | **bool* | :heavy_minus_sign: | N/A | true |
|
||||||
| `Channels` | **int* | :heavy_minus_sign: | Number of audio channels (for audio streams). | 6 |
|
| `Channels` | **int* | :heavy_minus_sign: | Number of audio channels (for audio streams). | 6 |
|
||||||
|
|||||||
@@ -1,16 +0,0 @@
|
|||||||
# GetMediaMetaDataStreamType
|
|
||||||
|
|
||||||
Stream type:
|
|
||||||
- 1 = video
|
|
||||||
- 2 = audio
|
|
||||||
- 3 = subtitle
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## Values
|
|
||||||
|
|
||||||
| Name | Value |
|
|
||||||
| ------------------------------------ | ------------------------------------ |
|
|
||||||
| `GetMediaMetaDataStreamTypeVideo` | 1 |
|
|
||||||
| `GetMediaMetaDataStreamTypeAudio` | 2 |
|
|
||||||
| `GetMediaMetaDataStreamTypeSubtitle` | 3 |
|
|
||||||
@@ -32,11 +32,11 @@ Unknown
|
|||||||
| `LastRatedAt` | **int64* | :heavy_minus_sign: | The Unix timestamp representing the last time the item was rated. | 1721813113 |
|
| `LastRatedAt` | **int64* | :heavy_minus_sign: | The Unix timestamp representing the last time the item was rated. | 1721813113 |
|
||||||
| `LastViewedAt` | **int* | :heavy_minus_sign: | Unix timestamp for when the media item was last viewed. | 1682752242 |
|
| `LastViewedAt` | **int* | :heavy_minus_sign: | Unix timestamp for when the media item was last viewed. | 1682752242 |
|
||||||
| `LeafCount` | **int* | :heavy_minus_sign: | The number of leaf items (end nodes) under this media item. | 14 |
|
| `LeafCount` | **int* | :heavy_minus_sign: | The number of leaf items (end nodes) under this media item. | 14 |
|
||||||
| `LibrarySectionID` | *int64* | :heavy_check_mark: | The identifier for the library section. | 1 |
|
| `LibrarySectionID` | **int64* | :heavy_minus_sign: | The identifier for the library section. | 1 |
|
||||||
| `LibrarySectionKey` | *string* | :heavy_check_mark: | The key corresponding to the library section. | /library/sections/1 |
|
| `LibrarySectionKey` | **string* | :heavy_minus_sign: | The key corresponding to the library section. | /library/sections/1 |
|
||||||
| `LibrarySectionTitle` | *string* | :heavy_check_mark: | The title of the library section. | Movies |
|
| `LibrarySectionTitle` | **string* | :heavy_minus_sign: | The title of the library section. | Movies |
|
||||||
| `OriginalTitle` | **string* | :heavy_minus_sign: | The original title of the media item (if different). | 映画 ブラッククローバー 魔法帝の剣 |
|
| `OriginalTitle` | **string* | :heavy_minus_sign: | The original title of the media item (if different). | 映画 ブラッククローバー 魔法帝の剣 |
|
||||||
| `OriginallyAvailableAt` | [types.Date](../../types/date.md) | :heavy_check_mark: | The original release date of the media item. | 2022-12-14 |
|
| `OriginallyAvailableAt` | [*types.Date](../../types/date.md) | :heavy_minus_sign: | The original release date of the media item. | 2022-12-14 |
|
||||||
| `ParentGUID` | **string* | :heavy_minus_sign: | The GUID of the parent media item. | plex://show/5d9c081b170e24001f2a7be4 |
|
| `ParentGUID` | **string* | :heavy_minus_sign: | The GUID of the parent media item. | plex://show/5d9c081b170e24001f2a7be4 |
|
||||||
| `ParentIndex` | **int* | :heavy_minus_sign: | The index position of the parent media item. | 1 |
|
| `ParentIndex` | **int* | :heavy_minus_sign: | The index position of the parent media item. | 1 |
|
||||||
| `ParentKey` | **string* | :heavy_minus_sign: | The key of the parent media item. | /library/metadata/66 |
|
| `ParentKey` | **string* | :heavy_minus_sign: | The key of the parent media item. | /library/metadata/66 |
|
||||||
|
|||||||
@@ -1,8 +0,0 @@
|
|||||||
# GetSearchAllLibrariesCollection
|
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
|
||||||
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
|
|
||||||
| `Tag` | **string* | :heavy_minus_sign: | N/A | Working NL Subs |
|
|
||||||
@@ -4,5 +4,6 @@
|
|||||||
## Fields
|
## Fields
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
| Field | Type | Required | Description | Example |
|
||||||
| ------------------------ | ------------------------ | ------------------------ | ------------------------ | ------------------------ |
|
| ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- |
|
||||||
| `Tag` | **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 |
|
||||||
@@ -4,5 +4,7 @@
|
|||||||
## Fields
|
## Fields
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
| Field | Type | Required | Description | Example |
|
||||||
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
|
| ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- |
|
||||||
| `Tag` | **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` | **string* | :heavy_minus_sign: | The absolute URL of the thumbnail image for the director. | https://metadata-static.plex.tv/8/people/8d65fa96804802e08f2de09fe014408e.jpg |
|
||||||
20
docs/models/operations/getsearchalllibrariesdirectory.md
Normal file
20
docs/models/operations/getsearchalllibrariesdirectory.md
Normal file
@@ -0,0 +1,20 @@
|
|||||||
|
# GetSearchAllLibrariesDirectory
|
||||||
|
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- |
|
||||||
|
| `Key` | *string* | :heavy_check_mark: | The unique identifier path for the search result item. | /library/sections/3/all?actor=197429 |
|
||||||
|
| `LibrarySectionID` | *int64* | :heavy_check_mark: | The identifier for the library section. | 1 |
|
||||||
|
| `LibrarySectionKey` | *string* | :heavy_check_mark: | The key corresponding to the library section. | /library/sections/1 |
|
||||||
|
| `LibrarySectionTitle` | *string* | :heavy_check_mark: | The title of the library section. | Movies |
|
||||||
|
| `LibrarySectionType` | **int64* | :heavy_minus_sign: | N/A | |
|
||||||
|
| `Type` | *string* | :heavy_check_mark: | The type of the directory. | tag |
|
||||||
|
| `ID` | *int64* | :heavy_check_mark: | N/A | 197429 |
|
||||||
|
| `Filter` | **string* | :heavy_minus_sign: | The filter string used to query this specific item in the library. | actor=197429 |
|
||||||
|
| `Tag` | *string* | :heavy_check_mark: | N/A | Ben Stiller |
|
||||||
|
| `TagType` | **int64* | :heavy_minus_sign: | The type of tag associated with this search result (e.g., Director, Actor). | |
|
||||||
|
| `TagKey` | **string* | :heavy_minus_sign: | The unique identifier for the tag associated with this search result. | 5d776826999c64001ec2c606 |
|
||||||
|
| `Thumb` | **string* | :heavy_minus_sign: | The URL to the thumbnail image associated with this search result. | https://metadata-static.plex.tv/5/people/57bd7c7d6c5c9e2881251b30e5603d3d.jpg |
|
||||||
|
| `Count` | **int64* | :heavy_minus_sign: | The number of items associated with this search result. | 10 |
|
||||||
@@ -1,11 +0,0 @@
|
|||||||
# GetSearchAllLibrariesEnableCreditsMarkerGeneration
|
|
||||||
|
|
||||||
Setting that indicates if credits markers detection is enabled. (-1 = Library default, 0 = Disabled).
|
|
||||||
|
|
||||||
|
|
||||||
## Values
|
|
||||||
|
|
||||||
| Name | Value |
|
|
||||||
| ------------------------------------------------------------------ | ------------------------------------------------------------------ |
|
|
||||||
| `GetSearchAllLibrariesEnableCreditsMarkerGenerationLibraryDefault` | -1 |
|
|
||||||
| `GetSearchAllLibrariesEnableCreditsMarkerGenerationDisabled` | 0 |
|
|
||||||
@@ -1,12 +0,0 @@
|
|||||||
# GetSearchAllLibrariesEpisodeSort
|
|
||||||
|
|
||||||
Setting that indicates how episodes are sorted for the show. (-1 = Library default, 0 = Oldest first, 1 = Newest first).
|
|
||||||
|
|
||||||
|
|
||||||
## Values
|
|
||||||
|
|
||||||
| Name | Value |
|
|
||||||
| ------------------------------------------------ | ------------------------------------------------ |
|
|
||||||
| `GetSearchAllLibrariesEpisodeSortLibraryDefault` | -1 |
|
|
||||||
| `GetSearchAllLibrariesEpisodeSortOldestFirst` | 0 |
|
|
||||||
| `GetSearchAllLibrariesEpisodeSortNewestFirst` | 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 |
|
||||||
|
|||||||
@@ -4,5 +4,6 @@
|
|||||||
## Fields
|
## Fields
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
| Field | Type | Required | Description | Example |
|
||||||
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
|
| -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- |
|
||||||
| `Tag` | **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/getsearchalllibrariesguids.md
Normal file
8
docs/models/operations/getsearchalllibrariesguids.md
Normal file
@@ -0,0 +1,8 @@
|
|||||||
|
# GetSearchAllLibrariesGuids
|
||||||
|
|
||||||
|
|
||||||
|
## 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 @@
|
|||||||
# GetSearchAllLibrariesHasThumbnail
|
# GetSearchAllLibrariesHasThumbnail
|
||||||
|
|
||||||
|
Indicates if the part has a thumbnail.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## Values
|
## Values
|
||||||
|
|
||||||
|
|||||||
@@ -0,0 +1,20 @@
|
|||||||
|
# GetSearchAllLibrariesLibraryOptimizedForStreaming
|
||||||
|
|
||||||
|
Has this media been optimized for streaming. NOTE: This can be 0, 1, false or true
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
## Supported Types
|
||||||
|
|
||||||
|
### GetSearchAllLibrariesOptimizedForStreamingLibrary1
|
||||||
|
|
||||||
|
```go
|
||||||
|
getSearchAllLibrariesLibraryOptimizedForStreaming := operations.CreateGetSearchAllLibrariesLibraryOptimizedForStreamingGetSearchAllLibrariesOptimizedForStreamingLibrary1(operations.GetSearchAllLibrariesOptimizedForStreamingLibrary1{/* values here */})
|
||||||
|
```
|
||||||
|
|
||||||
|
###
|
||||||
|
|
||||||
|
```go
|
||||||
|
getSearchAllLibrariesLibraryOptimizedForStreaming := operations.CreateGetSearchAllLibrariesLibraryOptimizedForStreamingBoolean(bool{/* values here */})
|
||||||
|
```
|
||||||
|
|
||||||
@@ -1,8 +1,10 @@
|
|||||||
# GetSearchAllLibrariesLocation
|
# GetSearchAllLibrariesLocation
|
||||||
|
|
||||||
|
The folder path for the media item.
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
| Field | Type | Required | Description | Example |
|
||||||
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
|
| ------------------------- | ------------------------- | ------------------------- | ------------------------- | ------------------------- |
|
||||||
| `Path` | **string* | :heavy_minus_sign: | N/A | /TV Shows/House |
|
| `Path` | *string* | :heavy_check_mark: | N/A | /TV Shows/Clarkson's Farm |
|
||||||
@@ -4,22 +4,23 @@
|
|||||||
## Fields
|
## Fields
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
| Field | Type | Required | Description | Example |
|
||||||
| ------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- |
|
| -------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||||
| `ID` | *int* | :heavy_check_mark: | N/A | 119534 |
|
| `ID` | *int64* | :heavy_check_mark: | Unique media identifier. | 387322 |
|
||||||
| `Duration` | **int* | :heavy_minus_sign: | N/A | 11558112 |
|
| `Duration` | **int* | :heavy_minus_sign: | Duration of the media in milliseconds. | 9610350 |
|
||||||
| `Bitrate` | **int* | :heavy_minus_sign: | N/A | 25025 |
|
| `Bitrate` | **int* | :heavy_minus_sign: | Bitrate in bits per second. | 25512 |
|
||||||
| `Width` | **int* | :heavy_minus_sign: | N/A | 3840 |
|
| `Width` | **int* | :heavy_minus_sign: | Video width in pixels. | 3840 |
|
||||||
| `Height` | **int* | :heavy_minus_sign: | N/A | 2072 |
|
| `Height` | **int* | :heavy_minus_sign: | Video height in pixels. | 1602 |
|
||||||
| `AspectRatio` | **float64* | :heavy_minus_sign: | N/A | 1.85 |
|
| `AspectRatio` | **float32* | :heavy_minus_sign: | Aspect ratio of the video. | 2.35 |
|
||||||
| `AudioProfile` | **string* | :heavy_minus_sign: | N/A | dts |
|
| `AudioChannels` | **int* | :heavy_minus_sign: | Number of audio channels. | 6 |
|
||||||
| `AudioChannels` | **int* | :heavy_minus_sign: | N/A | 6 |
|
| `DisplayOffset` | **int* | :heavy_minus_sign: | N/A | 50 |
|
||||||
| `AudioCodec` | **string* | :heavy_minus_sign: | N/A | eac3 |
|
| `AudioCodec` | **string* | :heavy_minus_sign: | Audio codec used. | aac |
|
||||||
| `VideoCodec` | **string* | :heavy_minus_sign: | N/A | hevc |
|
| `VideoCodec` | **string* | :heavy_minus_sign: | Video codec used. | hevc |
|
||||||
| `VideoResolution` | **string* | :heavy_minus_sign: | N/A | 4k |
|
| `VideoResolution` | **string* | :heavy_minus_sign: | Video resolution (e.g., 4k). | 4k |
|
||||||
| `Container` | *string* | :heavy_check_mark: | N/A | mkv |
|
| `Container` | **string* | :heavy_minus_sign: | Container format of the media. | mp4 |
|
||||||
| `VideoFrameRate` | **string* | :heavy_minus_sign: | N/A | 24p |
|
| `VideoFrameRate` | **string* | :heavy_minus_sign: | Frame rate of the video. Values found include NTSC, PAL, 24p<br/> | 24p |
|
||||||
| `VideoProfile` | **string* | :heavy_minus_sign: | N/A | main 10 |
|
| `VideoProfile` | **string* | :heavy_minus_sign: | Video profile (e.g., main 10). | main 10 |
|
||||||
| `HasVoiceActivity` | **bool* | :heavy_minus_sign: | N/A | false |
|
| `HasVoiceActivity` | **bool* | :heavy_minus_sign: | Indicates whether voice activity is detected. | false |
|
||||||
| `OptimizedForStreaming` | [*operations.GetSearchAllLibrariesOptimizedForStreaming](../../models/operations/getsearchalllibrariesoptimizedforstreaming.md) | :heavy_minus_sign: | N/A | 1 |
|
| `AudioProfile` | **string* | :heavy_minus_sign: | The audio profile used for the media (e.g., DTS, Dolby Digital, etc.). | dts |
|
||||||
| `Has64bitOffsets` | **bool* | :heavy_minus_sign: | N/A | false |
|
| `OptimizedForStreaming` | [*operations.GetSearchAllLibrariesOptimizedForStreaming](../../models/operations/getsearchalllibrariesoptimizedforstreaming.md) | :heavy_minus_sign: | Has this media been optimized for streaming. NOTE: This can be 0, 1, false or true | |
|
||||||
| `Part` | [][operations.GetSearchAllLibrariesPart](../../models/operations/getsearchalllibrariespart.md) | :heavy_check_mark: | N/A | |
|
| `Has64bitOffsets` | **bool* | :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` | [][operations.GetSearchAllLibrariesPart](../../models/operations/getsearchalllibrariespart.md) | :heavy_minus_sign: | N/A | |
|
||||||
@@ -3,7 +3,14 @@
|
|||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
|
|
||||||
| Field | Type | Required | Description |
|
| Field | Type | Required | Description | Example |
|
||||||
| -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- |
|
| -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- |
|
||||||
| `Size` | *float64* | :heavy_check_mark: | N/A |
|
| `Size` | *int* | :heavy_check_mark: | Number of media items returned in this response. | 50 |
|
||||||
| `SearchResult` | [][operations.SearchResult](../../models/operations/searchresult.md) | :heavy_check_mark: | N/A |
|
| `AllowSync` | *bool* | :heavy_check_mark: | Indicates whether syncing is allowed. | false |
|
||||||
|
| `Identifier` | *string* | :heavy_check_mark: | An plugin identifier for the media container. | com.plexapp.plugins.library |
|
||||||
|
| `LibrarySectionID` | **int64* | :heavy_minus_sign: | The unique identifier for the library section. | 2 |
|
||||||
|
| `LibrarySectionTitle` | **string* | :heavy_minus_sign: | The title of the library section. | TV Series |
|
||||||
|
| `LibrarySectionUUID` | **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` | *int64* | :heavy_check_mark: | The version number for media tags. | 1734362201 |
|
||||||
|
| `SearchResult` | [][operations.SearchResult](../../models/operations/searchresult.md) | :heavy_check_mark: | N/A | |
|
||||||
@@ -1,8 +0,0 @@
|
|||||||
# GetSearchAllLibrariesMediaGUID
|
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
|
||||||
| --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- |
|
|
||||||
| `ID` | *string* | :heavy_check_mark: | Can be one of the following formats:<br/>imdb://tt13015952, tmdb://2434012, tvdb://7945991<br/> | imdb://tt13015952 |
|
|
||||||
@@ -1,83 +1,82 @@
|
|||||||
# GetSearchAllLibrariesMetadata
|
# GetSearchAllLibrariesMetadata
|
||||||
|
|
||||||
|
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` | **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` | **bool* | :heavy_minus_sign: | N/A | false |
|
| `Studio` | **string* | :heavy_minus_sign: | The studio that produced the media item. | 20th Century Studios |
|
||||||
| `LibrarySectionID` | **int64* | :heavy_minus_sign: | N/A | 1 |
|
| `Type` | [operations.GetSearchAllLibrariesType](../../models/operations/getsearchalllibrariestype.md) | :heavy_check_mark: | N/A | movie |
|
||||||
| `LibrarySectionTitle` | **string* | :heavy_minus_sign: | N/A | Movies |
|
| `Title` | *string* | :heavy_check_mark: | The title of the media item. | Avatar: The Way of Water |
|
||||||
| `LibrarySectionKey` | **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` | [operations.GetSearchAllLibrariesType](../../models/operations/getsearchalllibrariestype.md) | :heavy_check_mark: | The type of media content in the Plex library. This can represent videos, music, or photos.<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` | **string* | :heavy_minus_sign: | The content rating for the media item. | PG-13 |
|
||||||
| `Slug` | **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` | **string* | :heavy_minus_sign: | N/A | PG-13 |
|
| `Rating` | *float32* | :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` | *float64* | :heavy_check_mark: | The audience rating for the media item. | 9.2 |
|
||||||
| `Rating` | **float64* | :heavy_minus_sign: | N/A | 7.6 |
|
| `Year` | **int* | :heavy_minus_sign: | The release year of the media item. | 2022 |
|
||||||
| `AudienceRating` | **float64* | :heavy_minus_sign: | N/A | 9.2 |
|
| `Tagline` | *string* | :heavy_check_mark: | A brief tagline for the media item. | Return to Pandora. |
|
||||||
| `Year` | **int* | :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` | **int* | :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` | **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` | [*operations.GetSearchAllLibrariesFlattenSeasons](../../models/operations/getsearchalllibrariesflattenseasons.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` | [*operations.GetSearchAllLibrariesEpisodeSort](../../models/operations/getsearchalllibrariesepisodesort.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` | **int* | :heavy_minus_sign: | The number of leaf items (end nodes) under this media item. | 14 |
|
||||||
| `EnableCreditsMarkerGeneration` | [*operations.GetSearchAllLibrariesEnableCreditsMarkerGeneration](../../models/operations/getsearchalllibrariesenablecreditsmarkergeneration.md) | :heavy_minus_sign: | Setting that indicates if credits markers detection is enabled. (-1 = Library default, 0 = Disabled). | -1 |
|
| `ViewedLeafCount` | **int* | :heavy_minus_sign: | The number of leaf items that have been viewed. | 0 |
|
||||||
| `ShowOrdering` | [*operations.GetSearchAllLibrariesShowOrdering](../../models/operations/getsearchalllibrariesshowordering.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` | **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` | **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` | **string* | :heavy_minus_sign: | N/A | /library/metadata/58683/banner/1703239236 |
|
| `OriginallyAvailableAt` | [*types.Date](../../types/date.md) | :heavy_minus_sign: | The original release date of the media item. | 2022-12-14 |
|
||||||
| `Duration` | **int* | :heavy_minus_sign: | N/A | 11558112 |
|
| `AddedAt` | *int64* | :heavy_check_mark: | N/A | 1556281940 |
|
||||||
| `OriginallyAvailableAt` | [*types.Date](../../types/date.md) | :heavy_minus_sign: | N/A | 2022-12-14 00:00:00 +0000 UTC |
|
|
||||||
| `AddedAt` | *int64* | :heavy_check_mark: | Unix epoch datetime in seconds | 1556281940 |
|
|
||||||
| `UpdatedAt` | **int64* | :heavy_minus_sign: | Unix epoch datetime in seconds | 1556281940 |
|
| `UpdatedAt` | **int64* | :heavy_minus_sign: | Unix epoch datetime in seconds | 1556281940 |
|
||||||
| `AudienceRatingImage` | **string* | :heavy_minus_sign: | N/A | rottentomatoes://image.rating.upright |
|
| `ParentYear` | **int* | :heavy_minus_sign: | The release year of the parent media item. | 2010 |
|
||||||
| `ChapterSource` | **string* | :heavy_minus_sign: | N/A | media |
|
| `AudienceRatingImage` | **string* | :heavy_minus_sign: | The URL for the audience rating image. | rottentomatoes://image.rating.upright |
|
||||||
| `PrimaryExtraKey` | **string* | :heavy_minus_sign: | N/A | /library/metadata/58684 |
|
| `ChapterSource` | **string* | :heavy_minus_sign: | The source from which chapter data is derived. | media |
|
||||||
| `RatingImage` | **string* | :heavy_minus_sign: | N/A | rottentomatoes://image.rating.ripe |
|
| `PrimaryExtraKey` | **string* | :heavy_minus_sign: | The primary extra key associated with this media item. | /library/metadata/58684 |
|
||||||
| `GrandparentRatingKey` | **string* | :heavy_minus_sign: | N/A | 66 |
|
| `OriginalTitle` | **string* | :heavy_minus_sign: | The original title of the media item (if different). | 映画 ブラッククローバー 魔法帝の剣 |
|
||||||
| `GrandparentGUID` | **string* | :heavy_minus_sign: | N/A | plex://show/5d9c081b170e24001f2a7be4 |
|
| `ParentRatingKey` | **string* | :heavy_minus_sign: | The rating key of the parent media item. | 66 |
|
||||||
| `GrandparentKey` | **string* | :heavy_minus_sign: | N/A | /library/metadata/66 |
|
| `GrandparentRatingKey` | **string* | :heavy_minus_sign: | The rating key of the grandparent media item. | 66 |
|
||||||
| `GrandparentTitle` | **string* | :heavy_minus_sign: | N/A | Caprica |
|
| `ParentGUID` | **string* | :heavy_minus_sign: | The GUID of the parent media item. | plex://show/5d9c081b170e24001f2a7be4 |
|
||||||
| `GrandparentThumb` | **string* | :heavy_minus_sign: | N/A | /library/metadata/66/thumb/1705716261 |
|
| `GrandparentGUID` | **string* | :heavy_minus_sign: | The GUID of the grandparent media item. | plex://show/5d9c081b170e24001f2a7be4 |
|
||||||
| `ParentSlug` | **string* | :heavy_minus_sign: | N/A | alice-in-borderland-2020 |
|
| `GrandparentSlug` | **string* | :heavy_minus_sign: | The slug for the grandparent media item. | alice-in-borderland-2020 |
|
||||||
| `GrandparentSlug` | **string* | :heavy_minus_sign: | N/A | alice-in-borderland-2020 |
|
| `GrandparentKey` | **string* | :heavy_minus_sign: | The key of the grandparent media item. | /library/metadata/66 |
|
||||||
| `GrandparentArt` | **string* | :heavy_minus_sign: | N/A | /library/metadata/66/art/1705716261 |
|
| `ParentKey` | **string* | :heavy_minus_sign: | The key of the parent media item. | /library/metadata/66 |
|
||||||
| `GrandparentTheme` | **string* | :heavy_minus_sign: | N/A | /library/metadata/66/theme/1705716261 |
|
| `GrandparentTitle` | **string* | :heavy_minus_sign: | The title of the grandparent media item. | Caprica |
|
||||||
| `Media` | [][operations.GetSearchAllLibrariesMedia](../../models/operations/getsearchalllibrariesmedia.md) | :heavy_minus_sign: | The Media object is only included when type query is `4` or higher.<br/> | |
|
| `GrandparentThumb` | **string* | :heavy_minus_sign: | The thumbnail URL for the grandparent media item. | /library/metadata/66/thumb/1705716261 |
|
||||||
|
| `GrandparentTheme` | **string* | :heavy_minus_sign: | The theme URL for the grandparent media item. | /library/metadata/66/theme/1705716261 |
|
||||||
|
| `GrandparentArt` | **string* | :heavy_minus_sign: | The art URL for the grandparent media item. | /library/metadata/66/art/1705716261 |
|
||||||
|
| `ParentTitle` | **string* | :heavy_minus_sign: | The title of the parent media item. | Caprica |
|
||||||
|
| `ParentIndex` | **int* | :heavy_minus_sign: | The index position of the parent media item. | 1 |
|
||||||
|
| `ParentThumb` | **string* | :heavy_minus_sign: | The thumbnail URL for the parent media item. | /library/metadata/66/thumb/1705716261 |
|
||||||
|
| `RatingImage` | **string* | :heavy_minus_sign: | The URL for the rating image. | rottentomatoes://image.rating.ripe |
|
||||||
|
| `ViewCount` | **int* | :heavy_minus_sign: | The number of times this media item has been viewed. | 1 |
|
||||||
|
| `ViewOffset` | **int* | :heavy_minus_sign: | The current playback offset (in milliseconds). | 5222500 |
|
||||||
|
| `SkipCount` | **int* | :heavy_minus_sign: | The number of times this media item has been skipped. | 1 |
|
||||||
|
| `Subtype` | **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 |
|
||||||
|
| `LastRatedAt` | **int64* | :heavy_minus_sign: | The Unix timestamp representing the last time the item was rated. | 1721813113 |
|
||||||
|
| `CreatedAtAccuracy` | **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 |
|
||||||
|
| `CreatedAtTZOffset` | **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` | **int* | :heavy_minus_sign: | Unix timestamp for when the media item was last viewed. | 1682752242 |
|
||||||
|
| `UserRating` | **float32* | :heavy_minus_sign: | The rating provided by a user for the item. This value is expressed as a decimal number. | 10 |
|
||||||
|
| `Image` | [][operations.GetSearchAllLibrariesImage](../../models/operations/getsearchalllibrariesimage.md) | :heavy_minus_sign: | N/A | |
|
||||||
|
| `UltraBlurColors` | [*operations.GetSearchAllLibrariesUltraBlurColors](../../models/operations/getsearchalllibrariesultrablurcolors.md) | :heavy_minus_sign: | N/A | |
|
||||||
|
| `Guids` | [][operations.GetSearchAllLibrariesGuids](../../models/operations/getsearchalllibrariesguids.md) | :heavy_minus_sign: | N/A | |
|
||||||
|
| `LibrarySectionID` | **int64* | :heavy_minus_sign: | The identifier for the library section. | 1 |
|
||||||
|
| `LibrarySectionTitle` | **string* | :heavy_minus_sign: | The title of the library section. | Movies |
|
||||||
|
| `LibrarySectionKey` | **string* | :heavy_minus_sign: | The key corresponding to the library section. | /library/sections/1 |
|
||||||
|
| `ShowOrdering` | [*operations.GetSearchAllLibrariesShowOrdering](../../models/operations/getsearchalllibrariesshowordering.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 |
|
||||||
|
| `FlattenSeasons` | [*operations.GetSearchAllLibrariesFlattenSeasons](../../models/operations/getsearchalllibrariesflattenseasons.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 |
|
||||||
|
| `SkipChildren` | **bool* | :heavy_minus_sign: | Indicates whether child items should be skipped. | false |
|
||||||
|
| `Media` | [][operations.GetSearchAllLibrariesMedia](../../models/operations/getsearchalllibrariesmedia.md) | :heavy_minus_sign: | N/A | |
|
||||||
| `Genre` | [][operations.GetSearchAllLibrariesGenre](../../models/operations/getsearchalllibrariesgenre.md) | :heavy_minus_sign: | N/A | |
|
| `Genre` | [][operations.GetSearchAllLibrariesGenre](../../models/operations/getsearchalllibrariesgenre.md) | :heavy_minus_sign: | N/A | |
|
||||||
| `Country` | [][operations.GetSearchAllLibrariesCountry](../../models/operations/getsearchalllibrariescountry.md) | :heavy_minus_sign: | N/A | |
|
| `Country` | [][operations.GetSearchAllLibrariesCountry](../../models/operations/getsearchalllibrariescountry.md) | :heavy_minus_sign: | N/A | |
|
||||||
| `Director` | [][operations.GetSearchAllLibrariesDirector](../../models/operations/getsearchalllibrariesdirector.md) | :heavy_minus_sign: | N/A | |
|
| `Director` | [][operations.GetSearchAllLibrariesDirector](../../models/operations/getsearchalllibrariesdirector.md) | :heavy_minus_sign: | N/A | |
|
||||||
| `Writer` | [][operations.GetSearchAllLibrariesWriter](../../models/operations/getsearchalllibrarieswriter.md) | :heavy_minus_sign: | N/A | |
|
| `Writer` | [][operations.GetSearchAllLibrariesWriter](../../models/operations/getsearchalllibrarieswriter.md) | :heavy_minus_sign: | N/A | |
|
||||||
| `Collection` | [][operations.GetSearchAllLibrariesCollection](../../models/operations/getsearchalllibrariescollection.md) | :heavy_minus_sign: | N/A | |
|
|
||||||
| `Role` | [][operations.GetSearchAllLibrariesRole](../../models/operations/getsearchalllibrariesrole.md) | :heavy_minus_sign: | N/A | |
|
| `Role` | [][operations.GetSearchAllLibrariesRole](../../models/operations/getsearchalllibrariesrole.md) | :heavy_minus_sign: | N/A | |
|
||||||
| `Location` | [][operations.GetSearchAllLibrariesLocation](../../models/operations/getsearchalllibrarieslocation.md) | :heavy_minus_sign: | N/A | |
|
| `Location` | [][operations.GetSearchAllLibrariesLocation](../../models/operations/getsearchalllibrarieslocation.md) | :heavy_minus_sign: | N/A | |
|
||||||
| `MediaGUID` | [][operations.GetSearchAllLibrariesMediaGUID](../../models/operations/getsearchalllibrariesmediaguid.md) | :heavy_minus_sign: | The Guid object is only included in the response if the `includeGuids` parameter is set to `1`.<br/> | |
|
|
||||||
| `UltraBlurColors` | [*operations.GetSearchAllLibrariesUltraBlurColors](../../models/operations/getsearchalllibrariesultrablurcolors.md) | :heavy_minus_sign: | N/A | |
|
|
||||||
| `MetaDataRating` | [][operations.GetSearchAllLibrariesMetaDataRating](../../models/operations/getsearchalllibrariesmetadatarating.md) | :heavy_minus_sign: | N/A | |
|
|
||||||
| `Image` | [][operations.GetSearchAllLibrariesImage](../../models/operations/getsearchalllibrariesimage.md) | :heavy_minus_sign: | N/A | |
|
|
||||||
| `TitleSort` | **string* | :heavy_minus_sign: | N/A | Whale |
|
|
||||||
| `ViewCount` | **int* | :heavy_minus_sign: | N/A | 1 |
|
|
||||||
| `LastViewedAt` | **int* | :heavy_minus_sign: | N/A | 1682752242 |
|
|
||||||
| `OriginalTitle` | **string* | :heavy_minus_sign: | N/A | 映画 ブラッククローバー 魔法帝の剣 |
|
|
||||||
| `ViewOffset` | **int* | :heavy_minus_sign: | N/A | 5222500 |
|
|
||||||
| `SkipCount` | **int* | :heavy_minus_sign: | N/A | 1 |
|
|
||||||
| `Index` | **int* | :heavy_minus_sign: | N/A | 1 |
|
|
||||||
| `Theme` | **string* | :heavy_minus_sign: | N/A | /library/metadata/1/theme/1705636920 |
|
|
||||||
| `LeafCount` | **int* | :heavy_minus_sign: | N/A | 14 |
|
|
||||||
| `ViewedLeafCount` | **int* | :heavy_minus_sign: | N/A | 0 |
|
|
||||||
| `ChildCount` | **int* | :heavy_minus_sign: | N/A | 1 |
|
|
||||||
| `HasPremiumExtras` | **string* | :heavy_minus_sign: | N/A | 1 |
|
|
||||||
| `HasPremiumPrimaryExtra` | **string* | :heavy_minus_sign: | N/A | 1 |
|
|
||||||
| `ParentRatingKey` | **string* | :heavy_minus_sign: | The rating key of the parent item.<br/> | 66 |
|
|
||||||
| `ParentGUID` | **string* | :heavy_minus_sign: | N/A | plex://show/5d9c081b170e24001f2a7be4 |
|
|
||||||
| `ParentStudio` | **string* | :heavy_minus_sign: | N/A | UCP |
|
|
||||||
| `ParentKey` | **string* | :heavy_minus_sign: | N/A | /library/metadata/66 |
|
|
||||||
| `ParentTitle` | **string* | :heavy_minus_sign: | N/A | Caprica |
|
|
||||||
| `ParentIndex` | **int* | :heavy_minus_sign: | N/A | 1 |
|
|
||||||
| `ParentYear` | **int* | :heavy_minus_sign: | N/A | 2010 |
|
|
||||||
| `ParentThumb` | **string* | :heavy_minus_sign: | N/A | /library/metadata/66/thumb/1705716261 |
|
|
||||||
| `ParentTheme` | **string* | :heavy_minus_sign: | N/A | /library/metadata/66/theme/1705716261 |
|
|
||||||
@@ -1,10 +0,0 @@
|
|||||||
# GetSearchAllLibrariesMetaDataRating
|
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
|
||||||
| -------------------------------------------- | -------------------------------------------- | -------------------------------------------- | -------------------------------------------- | -------------------------------------------- |
|
|
||||||
| `Image` | *string* | :heavy_check_mark: | A URI or path to the rating image. | themoviedb://image.rating |
|
|
||||||
| `Value` | *float32* | :heavy_check_mark: | The value of the rating. | 3 |
|
|
||||||
| `Type` | *string* | :heavy_check_mark: | The type of rating (e.g., audience, critic). | audience |
|
|
||||||
@@ -1,9 +1,19 @@
|
|||||||
# GetSearchAllLibrariesOptimizedForStreaming
|
# GetSearchAllLibrariesOptimizedForStreaming
|
||||||
|
|
||||||
|
Has this media been optimized for streaming. NOTE: This can be 0, 1, false or true
|
||||||
|
|
||||||
## Values
|
|
||||||
|
|
||||||
| Name | Value |
|
## Supported Types
|
||||||
| --------------------------------------------------- | --------------------------------------------------- |
|
|
||||||
| `GetSearchAllLibrariesOptimizedForStreamingDisable` | 0 |
|
### GetSearchAllLibrariesOptimizedForStreaming1
|
||||||
| `GetSearchAllLibrariesOptimizedForStreamingEnable` | 1 |
|
|
||||||
|
```go
|
||||||
|
getSearchAllLibrariesOptimizedForStreaming := operations.CreateGetSearchAllLibrariesOptimizedForStreamingGetSearchAllLibrariesOptimizedForStreaming1(operations.GetSearchAllLibrariesOptimizedForStreaming1{/* values here */})
|
||||||
|
```
|
||||||
|
|
||||||
|
###
|
||||||
|
|
||||||
|
```go
|
||||||
|
getSearchAllLibrariesOptimizedForStreaming := operations.CreateGetSearchAllLibrariesOptimizedForStreamingBoolean(bool{/* values here */})
|
||||||
|
```
|
||||||
|
|
||||||
|
|||||||
@@ -1,12 +1,9 @@
|
|||||||
# GetLibraryItemsLibraryActiveDirection
|
# GetSearchAllLibrariesOptimizedForStreaming1
|
||||||
|
|
||||||
The direction of the sort. Can be either `asc` or `desc`.
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## Values
|
## Values
|
||||||
|
|
||||||
| Name | Value |
|
| Name | Value |
|
||||||
| ------------------------------------------------- | ------------------------------------------------- |
|
| ------------------------------------------------- | ------------------------------------------------- |
|
||||||
| `GetLibraryItemsLibraryActiveDirectionAscending` | asc |
|
| `GetSearchAllLibrariesOptimizedForStreaming1Zero` | 0 |
|
||||||
| `GetLibraryItemsLibraryActiveDirectionDescending` | desc |
|
| `GetSearchAllLibrariesOptimizedForStreaming1One` | 1 |
|
||||||
@@ -0,0 +1,9 @@
|
|||||||
|
# GetSearchAllLibrariesOptimizedForStreamingLibrary1
|
||||||
|
|
||||||
|
|
||||||
|
## Values
|
||||||
|
|
||||||
|
| Name | Value |
|
||||||
|
| -------------------------------------------------------- | -------------------------------------------------------- |
|
||||||
|
| `GetSearchAllLibrariesOptimizedForStreamingLibrary1Zero` | 0 |
|
||||||
|
| `GetSearchAllLibrariesOptimizedForStreamingLibrary1One` | 1 |
|
||||||
@@ -4,17 +4,19 @@
|
|||||||
## Fields
|
## Fields
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
| Field | Type | Required | Description | Example |
|
||||||
| -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- |
|
| --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||||
| `ID` | *int* | :heavy_check_mark: | N/A | 119542 |
|
| `Accessible` | **bool* | :heavy_minus_sign: | Indicates if the part is accessible. | true |
|
||||||
| `Key` | *string* | :heavy_check_mark: | N/A | /library/parts/119542/1680457526/file.mkv |
|
| `Exists` | **bool* | :heavy_minus_sign: | Indicates if the part exists. | true |
|
||||||
| `Duration` | **int* | :heavy_minus_sign: | N/A | 11558112 |
|
| `ID` | *int64* | :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` | **string* | :heavy_minus_sign: | Key to access this part. | /library/parts/418385/1735864239/file.mkv |
|
||||||
| `Size` | *int64* | :heavy_check_mark: | N/A | 36158371307 |
|
|
||||||
| `Container` | *string* | :heavy_check_mark: | The container format of the media file.<br/> | mkv |
|
|
||||||
| `AudioProfile` | **string* | :heavy_minus_sign: | N/A | dts |
|
|
||||||
| `Has64bitOffsets` | **bool* | :heavy_minus_sign: | N/A | false |
|
|
||||||
| `OptimizedForStreaming` | **bool* | :heavy_minus_sign: | N/A | false |
|
|
||||||
| `VideoProfile` | **string* | :heavy_minus_sign: | N/A | main 10 |
|
|
||||||
| `Indexes` | **string* | :heavy_minus_sign: | N/A | sd |
|
| `Indexes` | **string* | :heavy_minus_sign: | N/A | sd |
|
||||||
|
| `Duration` | **int* | :heavy_minus_sign: | Duration of the part in milliseconds. | 9610350 |
|
||||||
|
| `File` | **string* | :heavy_minus_sign: | File path for the part. | /mnt/Movies_1/W/Wicked (2024).mkv |
|
||||||
|
| `Size` | **int64* | :heavy_minus_sign: | File size in bytes. | 30649952104 |
|
||||||
|
| `PacketLength` | **int* | :heavy_minus_sign: | N/A | 188 |
|
||||||
|
| `Container` | **string* | :heavy_minus_sign: | Container format of the part. | mkv |
|
||||||
|
| `VideoProfile` | **string* | :heavy_minus_sign: | Video profile for the part. | main 10 |
|
||||||
|
| `AudioProfile` | **string* | :heavy_minus_sign: | The audio profile used for the media (e.g., DTS, Dolby Digital, etc.). | dts |
|
||||||
|
| `Has64bitOffsets` | **bool* | :heavy_minus_sign: | N/A | false |
|
||||||
|
| `OptimizedForStreaming` | [*operations.GetSearchAllLibrariesLibraryOptimizedForStreaming](../../models/operations/getsearchalllibrarieslibraryoptimizedforstreaming.md) | :heavy_minus_sign: | Has this media been optimized for streaming. NOTE: This can be 0, 1, false or true<br/> | |
|
||||||
| `HasThumbnail` | [*operations.GetSearchAllLibrariesHasThumbnail](../../models/operations/getsearchalllibrarieshasthumbnail.md) | :heavy_minus_sign: | N/A | 1 |
|
| `HasThumbnail` | [*operations.GetSearchAllLibrariesHasThumbnail](../../models/operations/getsearchalllibrarieshasthumbnail.md) | :heavy_minus_sign: | N/A | 1 |
|
||||||
| `Stream` | [][operations.GetSearchAllLibrariesStream](../../models/operations/getsearchalllibrariesstream.md) | :heavy_minus_sign: | N/A | |
|
|
||||||
@@ -4,10 +4,8 @@
|
|||||||
## Fields
|
## Fields
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
| Field | Type | Required | Description | Example |
|
||||||
| ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- |
|
| ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- |
|
||||||
| `ID` | **int64* | :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` | **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` | **string* | :heavy_minus_sign: | The thumbnail of the actor | https://metadata-static.plex.tv/2/people/27b85844536c39f3f9ac943aaad46608.jpg |
|
| `Role` | **string* | :heavy_minus_sign: | The role played by the actor in the media item. | Self - Judge |
|
||||||
| `Tag` | **string* | :heavy_minus_sign: | The name of the tag or actor. | Mike Smith |
|
| `Thumb` | **string* | :heavy_minus_sign: | The absolute URL of the thumbnail image for the actor. | https://metadata-static.plex.tv/7/people/708568fd018d7aa8b1032dcf867747e8.jpg |
|
||||||
| `TagKey` | **string* | :heavy_minus_sign: | Unique identifier for the tag. | 668e7e7b22bcad9064350c91 |
|
|
||||||
| `Role` | **string* | :heavy_minus_sign: | The role of the actor or tag in the media. | Self |
|
|
||||||
@@ -1,11 +1,12 @@
|
|||||||
# GetSearchAllLibrariesShowOrdering
|
# GetSearchAllLibrariesShowOrdering
|
||||||
|
|
||||||
Setting that indicates the episode ordering for the show.
|
Setting that indicates the episode ordering for the show.
|
||||||
None = Library default,
|
Options:
|
||||||
tmdbAiring = The Movie Database (Aired),
|
- None = Library default
|
||||||
aired = TheTVDB (Aired),
|
- tmdbAiring = The Movie Database (Aired)
|
||||||
dvd = TheTVDB (DVD),
|
- aired = TheTVDB (Aired)
|
||||||
absolute = TheTVDB (Absolute)).
|
- dvd = TheTVDB (DVD)
|
||||||
|
- absolute = TheTVDB (Absolute)
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
@@ -1,45 +0,0 @@
|
|||||||
# GetSearchAllLibrariesStream
|
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
|
||||||
| ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- |
|
|
||||||
| `ID` | *int64* | :heavy_check_mark: | N/A | 272796 |
|
|
||||||
| `StreamType` | *int64* | :heavy_check_mark: | Type of stream (1 = video, 2 = audio, 3 = subtitle) | 1 |
|
|
||||||
| `Default` | **bool* | :heavy_minus_sign: | Indicates if this is the default stream | true |
|
|
||||||
| `Selected` | **bool* | :heavy_minus_sign: | Indicates if the stream is selected | true |
|
|
||||||
| `Codec` | *string* | :heavy_check_mark: | Codec used by the stream | h264 |
|
|
||||||
| `Index` | *int64* | :heavy_check_mark: | The index of the stream | 0 |
|
|
||||||
| `Bitrate` | **int64* | :heavy_minus_sign: | The bitrate of the stream in kbps | 6273 |
|
|
||||||
| `ColorPrimaries` | **string* | :heavy_minus_sign: | The color primaries of the video stream | bt709 |
|
|
||||||
| `ColorRange` | **string* | :heavy_minus_sign: | The color range of the video stream | tv |
|
|
||||||
| `ColorSpace` | **string* | :heavy_minus_sign: | The color space of the video stream | bt709 |
|
|
||||||
| `ColorTrc` | **string* | :heavy_minus_sign: | The transfer characteristics (TRC) of the video stream | bt709 |
|
|
||||||
| `BitDepth` | **int64* | :heavy_minus_sign: | The bit depth of the video stream | 8 |
|
|
||||||
| `ChromaLocation` | **string* | :heavy_minus_sign: | The chroma location of the video stream | left |
|
|
||||||
| `StreamIdentifier` | **string* | :heavy_minus_sign: | The identifier of the video stream | 2 |
|
|
||||||
| `ChromaSubsampling` | **string* | :heavy_minus_sign: | The chroma subsampling format | 4:2:0 |
|
|
||||||
| `CodedHeight` | **int64* | :heavy_minus_sign: | The coded height of the video stream | 1088 |
|
|
||||||
| `CodedWidth` | **int64* | :heavy_minus_sign: | The coded width of the video stream | 1920 |
|
|
||||||
| `FrameRate` | **float64* | :heavy_minus_sign: | The frame rate of the video stream | 29.97 |
|
|
||||||
| `HasScalingMatrix` | **bool* | :heavy_minus_sign: | Indicates if the stream has a scaling matrix | false |
|
|
||||||
| `HearingImpaired` | **bool* | :heavy_minus_sign: | N/A | false |
|
|
||||||
| `ClosedCaptions` | **bool* | :heavy_minus_sign: | N/A | false |
|
|
||||||
| `EmbeddedInVideo` | **string* | :heavy_minus_sign: | N/A | 1 |
|
|
||||||
| `Height` | **int64* | :heavy_minus_sign: | The height of the video stream | 1080 |
|
|
||||||
| `Level` | **int64* | :heavy_minus_sign: | The level of the video codec | 40 |
|
|
||||||
| `Profile` | **string* | :heavy_minus_sign: | The profile of the video codec | main |
|
|
||||||
| `RefFrames` | **int64* | :heavy_minus_sign: | Number of reference frames | 4 |
|
|
||||||
| `ScanType` | **string* | :heavy_minus_sign: | The scan type (progressive or interlaced) | progressive |
|
|
||||||
| `Width` | **int64* | :heavy_minus_sign: | The width of the video stream | 1920 |
|
|
||||||
| `DisplayTitle` | **string* | :heavy_minus_sign: | Display title of the stream | 1080p (H.264) |
|
|
||||||
| `ExtendedDisplayTitle` | **string* | :heavy_minus_sign: | Extended display title of the stream | 1080p (H.264) |
|
|
||||||
| `Channels` | **int64* | :heavy_minus_sign: | Number of audio channels (for audio streams) | 2 |
|
|
||||||
| `Language` | **string* | :heavy_minus_sign: | The language of the stream (for audio/subtitle streams) | English |
|
|
||||||
| `LanguageTag` | **string* | :heavy_minus_sign: | Language tag of the stream | en |
|
|
||||||
| `LanguageCode` | **string* | :heavy_minus_sign: | Language code of the stream | eng |
|
|
||||||
| `AudioChannelLayout` | **string* | :heavy_minus_sign: | The audio channel layout | stereo |
|
|
||||||
| `SamplingRate` | **int64* | :heavy_minus_sign: | Sampling rate of the audio stream in Hz | 48000 |
|
|
||||||
| `Title` | **string* | :heavy_minus_sign: | Title of the subtitle track (for subtitle streams) | English |
|
|
||||||
| `CanAutoSync` | **bool* | :heavy_minus_sign: | Indicates if the subtitle stream can auto-sync | false |
|
|
||||||
@@ -4,5 +4,7 @@
|
|||||||
## Fields
|
## Fields
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
| Field | Type | Required | Description | Example |
|
||||||
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
|
| ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- |
|
||||||
| `Tag` | **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` | **string* | :heavy_minus_sign: | The absolute URL of the thumbnail image for the writer. | https://metadata-static.plex.tv/8/people/8d65fa96804802e08f2de09fe014408e.jpg |
|
||||||
@@ -1,8 +0,0 @@
|
|||||||
# MediaGUID
|
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
|
||||||
| --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- |
|
|
||||||
| `ID` | *string* | :heavy_check_mark: | Can be one of the following formats:<br/>imdb://tt13015952, tmdb://2434012, tvdb://7945991<br/> | imdb://tt13015952 |
|
|
||||||
@@ -3,7 +3,8 @@
|
|||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
|
|
||||||
| Field | Type | Required | Description |
|
| Field | Type | Required | Description | Example |
|
||||||
| ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- |
|
| ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- |
|
||||||
| `Score` | *float32* | :heavy_check_mark: | N/A |
|
| `Score` | *float32* | :heavy_check_mark: | The score of the search result, typically a float value between 0 and 1. | 0.92 |
|
||||||
| `Metadata` | [operations.GetSearchAllLibrariesMetadata](../../models/operations/getsearchalllibrariesmetadata.md) | :heavy_check_mark: | N/A |
|
| `Directory` | [*operations.GetSearchAllLibrariesDirectory](../../models/operations/getsearchalllibrariesdirectory.md) | :heavy_minus_sign: | N/A | |
|
||||||
|
| `Metadata` | [*operations.GetSearchAllLibrariesMetadata](../../models/operations/getsearchalllibrariesmetadata.md) | :heavy_minus_sign: | N/A | |
|
||||||
@@ -1,11 +1,12 @@
|
|||||||
# ShowOrdering
|
# ShowOrdering
|
||||||
|
|
||||||
Setting that indicates the episode ordering for the show.
|
Setting that indicates the episode ordering for the show.
|
||||||
None = Library default,
|
Options:
|
||||||
tmdbAiring = The Movie Database (Aired),
|
- None = Library default
|
||||||
aired = TheTVDB (Aired),
|
- tmdbAiring = The Movie Database (Aired)
|
||||||
dvd = TheTVDB (DVD),
|
- aired = TheTVDB (Aired)
|
||||||
absolute = TheTVDB (Absolute)).
|
- dvd = TheTVDB (DVD)
|
||||||
|
- absolute = TheTVDB (Absolute)
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
@@ -6,7 +6,7 @@
|
|||||||
| Field | Type | Required | Description | Example |
|
| Field | Type | Required | Description | Example |
|
||||||
| -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- |
|
| -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- |
|
||||||
| `ID` | *int64* | :heavy_check_mark: | Unique stream identifier. | 1002625 |
|
| `ID` | *int64* | :heavy_check_mark: | Unique stream identifier. | 1002625 |
|
||||||
| `StreamType` | [operations.StreamType](../../models/operations/streamtype.md) | :heavy_check_mark: | Stream type:<br/> - 1 = video<br/> - 2 = audio<br/> - 3 = subtitle<br/> | 1 |
|
| `StreamType` | *int64* | :heavy_check_mark: | Stream type:<br/> - VIDEO = 1<br/> - AUDIO = 2<br/> - SUBTITLE = 3<br/> | |
|
||||||
| `Format` | **string* | :heavy_minus_sign: | Format of the stream (e.g., srt). | srt |
|
| `Format` | **string* | :heavy_minus_sign: | Format of the stream (e.g., srt). | srt |
|
||||||
| `Default` | **bool* | :heavy_minus_sign: | Indicates if this stream is default. | true |
|
| `Default` | **bool* | :heavy_minus_sign: | Indicates if this stream is default. | true |
|
||||||
| `Codec` | *string* | :heavy_check_mark: | Codec used by the stream. | hevc |
|
| `Codec` | *string* | :heavy_check_mark: | Codec used by the stream. | hevc |
|
||||||
|
|||||||
@@ -1,16 +0,0 @@
|
|||||||
# StreamType
|
|
||||||
|
|
||||||
Stream type:
|
|
||||||
- 1 = video
|
|
||||||
- 2 = audio
|
|
||||||
- 3 = subtitle
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## Values
|
|
||||||
|
|
||||||
| Name | Value |
|
|
||||||
| -------------------- | -------------------- |
|
|
||||||
| `StreamTypeVideo` | 1 |
|
|
||||||
| `StreamTypeAudio` | 2 |
|
|
||||||
| `StreamTypeSubtitle` | 3 |
|
|
||||||
2
go.mod
2
go.mod
@@ -1,5 +1,5 @@
|
|||||||
module github.com/LukeHagar/plexgo
|
module github.com/LukeHagar/plexgo
|
||||||
|
|
||||||
go 1.20
|
go 1.22
|
||||||
|
|
||||||
require github.com/ericlagergren/decimal v0.0.0-20221120152707-495c53812d05
|
require github.com/ericlagergren/decimal v0.0.0-20221120152707-495c53812d05
|
||||||
|
|||||||
@@ -122,7 +122,7 @@ type GetActorsLibraryMediaContainer struct {
|
|||||||
// Identifier for the view group layout.
|
// Identifier for the view group layout.
|
||||||
ViewGroup string `json:"viewGroup"`
|
ViewGroup string `json:"viewGroup"`
|
||||||
// Identifier for the view mode.
|
// Identifier for the view mode.
|
||||||
ViewMode string `json:"viewMode"`
|
ViewMode *string `json:"viewMode,omitempty"`
|
||||||
// An array of actor entries for media items.
|
// An array of actor entries for media items.
|
||||||
Directory []GetActorsLibraryDirectory `json:"Directory,omitempty"`
|
Directory []GetActorsLibraryDirectory `json:"Directory,omitempty"`
|
||||||
}
|
}
|
||||||
@@ -204,9 +204,9 @@ func (o *GetActorsLibraryMediaContainer) GetViewGroup() string {
|
|||||||
return o.ViewGroup
|
return o.ViewGroup
|
||||||
}
|
}
|
||||||
|
|
||||||
func (o *GetActorsLibraryMediaContainer) GetViewMode() string {
|
func (o *GetActorsLibraryMediaContainer) GetViewMode() *string {
|
||||||
if o == nil {
|
if o == nil {
|
||||||
return ""
|
return nil
|
||||||
}
|
}
|
||||||
return o.ViewMode
|
return o.ViewMode
|
||||||
}
|
}
|
||||||
|
|||||||
File diff suppressed because it is too large
Load Diff
@@ -730,96 +730,6 @@ func (o *GetLibrarySectionsAllGuids) GetID() string {
|
|||||||
return o.ID
|
return o.ID
|
||||||
}
|
}
|
||||||
|
|
||||||
type OptimizedForStreaming1 int
|
|
||||||
|
|
||||||
const (
|
|
||||||
OptimizedForStreaming1Zero OptimizedForStreaming1 = 0
|
|
||||||
OptimizedForStreaming1One OptimizedForStreaming1 = 1
|
|
||||||
)
|
|
||||||
|
|
||||||
func (e OptimizedForStreaming1) ToPointer() *OptimizedForStreaming1 {
|
|
||||||
return &e
|
|
||||||
}
|
|
||||||
func (e *OptimizedForStreaming1) UnmarshalJSON(data []byte) error {
|
|
||||||
var v int
|
|
||||||
if err := json.Unmarshal(data, &v); err != nil {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
switch v {
|
|
||||||
case 0:
|
|
||||||
fallthrough
|
|
||||||
case 1:
|
|
||||||
*e = OptimizedForStreaming1(v)
|
|
||||||
return nil
|
|
||||||
default:
|
|
||||||
return fmt.Errorf("invalid value for OptimizedForStreaming1: %v", v)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
type GetLibrarySectionsAllOptimizedForStreamingType string
|
|
||||||
|
|
||||||
const (
|
|
||||||
GetLibrarySectionsAllOptimizedForStreamingTypeOptimizedForStreaming1 GetLibrarySectionsAllOptimizedForStreamingType = "optimizedForStreaming_1"
|
|
||||||
GetLibrarySectionsAllOptimizedForStreamingTypeBoolean GetLibrarySectionsAllOptimizedForStreamingType = "boolean"
|
|
||||||
)
|
|
||||||
|
|
||||||
// GetLibrarySectionsAllOptimizedForStreaming - Has this media been optimized for streaming. NOTE: This can be 0, 1, false or true
|
|
||||||
type GetLibrarySectionsAllOptimizedForStreaming struct {
|
|
||||||
OptimizedForStreaming1 *OptimizedForStreaming1 `queryParam:"inline"`
|
|
||||||
Boolean *bool `queryParam:"inline"`
|
|
||||||
|
|
||||||
Type GetLibrarySectionsAllOptimizedForStreamingType
|
|
||||||
}
|
|
||||||
|
|
||||||
func CreateGetLibrarySectionsAllOptimizedForStreamingOptimizedForStreaming1(optimizedForStreaming1 OptimizedForStreaming1) GetLibrarySectionsAllOptimizedForStreaming {
|
|
||||||
typ := GetLibrarySectionsAllOptimizedForStreamingTypeOptimizedForStreaming1
|
|
||||||
|
|
||||||
return GetLibrarySectionsAllOptimizedForStreaming{
|
|
||||||
OptimizedForStreaming1: &optimizedForStreaming1,
|
|
||||||
Type: typ,
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func CreateGetLibrarySectionsAllOptimizedForStreamingBoolean(boolean bool) GetLibrarySectionsAllOptimizedForStreaming {
|
|
||||||
typ := GetLibrarySectionsAllOptimizedForStreamingTypeBoolean
|
|
||||||
|
|
||||||
return GetLibrarySectionsAllOptimizedForStreaming{
|
|
||||||
Boolean: &boolean,
|
|
||||||
Type: typ,
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func (u *GetLibrarySectionsAllOptimizedForStreaming) UnmarshalJSON(data []byte) error {
|
|
||||||
|
|
||||||
var optimizedForStreaming1 OptimizedForStreaming1 = OptimizedForStreaming1(0)
|
|
||||||
if err := utils.UnmarshalJSON(data, &optimizedForStreaming1, "", true, true); err == nil {
|
|
||||||
u.OptimizedForStreaming1 = &optimizedForStreaming1
|
|
||||||
u.Type = GetLibrarySectionsAllOptimizedForStreamingTypeOptimizedForStreaming1
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
|
|
||||||
var boolean bool = false
|
|
||||||
if err := utils.UnmarshalJSON(data, &boolean, "", true, true); err == nil {
|
|
||||||
u.Boolean = &boolean
|
|
||||||
u.Type = GetLibrarySectionsAllOptimizedForStreamingTypeBoolean
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
|
|
||||||
return fmt.Errorf("could not unmarshal `%s` into any supported union types for GetLibrarySectionsAllOptimizedForStreaming", string(data))
|
|
||||||
}
|
|
||||||
|
|
||||||
func (u GetLibrarySectionsAllOptimizedForStreaming) MarshalJSON() ([]byte, error) {
|
|
||||||
if u.OptimizedForStreaming1 != nil {
|
|
||||||
return utils.MarshalJSON(u.OptimizedForStreaming1, "", true)
|
|
||||||
}
|
|
||||||
|
|
||||||
if u.Boolean != nil {
|
|
||||||
return utils.MarshalJSON(u.Boolean, "", true)
|
|
||||||
}
|
|
||||||
|
|
||||||
return nil, errors.New("could not marshal union type GetLibrarySectionsAllOptimizedForStreaming: all fields are null")
|
|
||||||
}
|
|
||||||
|
|
||||||
type GetLibrarySectionsAllOptimizedForStreaming1 int
|
type GetLibrarySectionsAllOptimizedForStreaming1 int
|
||||||
|
|
||||||
const (
|
const (
|
||||||
@@ -846,26 +756,116 @@ func (e *GetLibrarySectionsAllOptimizedForStreaming1) UnmarshalJSON(data []byte)
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
type GetLibrarySectionsAllOptimizedForStreamingType string
|
||||||
|
|
||||||
|
const (
|
||||||
|
GetLibrarySectionsAllOptimizedForStreamingTypeGetLibrarySectionsAllOptimizedForStreaming1 GetLibrarySectionsAllOptimizedForStreamingType = "get-library-sections-all_optimizedForStreaming_1"
|
||||||
|
GetLibrarySectionsAllOptimizedForStreamingTypeBoolean GetLibrarySectionsAllOptimizedForStreamingType = "boolean"
|
||||||
|
)
|
||||||
|
|
||||||
|
// GetLibrarySectionsAllOptimizedForStreaming - Has this media been optimized for streaming. NOTE: This can be 0, 1, false or true
|
||||||
|
type GetLibrarySectionsAllOptimizedForStreaming struct {
|
||||||
|
GetLibrarySectionsAllOptimizedForStreaming1 *GetLibrarySectionsAllOptimizedForStreaming1 `queryParam:"inline"`
|
||||||
|
Boolean *bool `queryParam:"inline"`
|
||||||
|
|
||||||
|
Type GetLibrarySectionsAllOptimizedForStreamingType
|
||||||
|
}
|
||||||
|
|
||||||
|
func CreateGetLibrarySectionsAllOptimizedForStreamingGetLibrarySectionsAllOptimizedForStreaming1(getLibrarySectionsAllOptimizedForStreaming1 GetLibrarySectionsAllOptimizedForStreaming1) GetLibrarySectionsAllOptimizedForStreaming {
|
||||||
|
typ := GetLibrarySectionsAllOptimizedForStreamingTypeGetLibrarySectionsAllOptimizedForStreaming1
|
||||||
|
|
||||||
|
return GetLibrarySectionsAllOptimizedForStreaming{
|
||||||
|
GetLibrarySectionsAllOptimizedForStreaming1: &getLibrarySectionsAllOptimizedForStreaming1,
|
||||||
|
Type: typ,
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func CreateGetLibrarySectionsAllOptimizedForStreamingBoolean(boolean bool) GetLibrarySectionsAllOptimizedForStreaming {
|
||||||
|
typ := GetLibrarySectionsAllOptimizedForStreamingTypeBoolean
|
||||||
|
|
||||||
|
return GetLibrarySectionsAllOptimizedForStreaming{
|
||||||
|
Boolean: &boolean,
|
||||||
|
Type: typ,
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func (u *GetLibrarySectionsAllOptimizedForStreaming) UnmarshalJSON(data []byte) error {
|
||||||
|
|
||||||
|
var getLibrarySectionsAllOptimizedForStreaming1 GetLibrarySectionsAllOptimizedForStreaming1 = GetLibrarySectionsAllOptimizedForStreaming1(0)
|
||||||
|
if err := utils.UnmarshalJSON(data, &getLibrarySectionsAllOptimizedForStreaming1, "", true, true); err == nil {
|
||||||
|
u.GetLibrarySectionsAllOptimizedForStreaming1 = &getLibrarySectionsAllOptimizedForStreaming1
|
||||||
|
u.Type = GetLibrarySectionsAllOptimizedForStreamingTypeGetLibrarySectionsAllOptimizedForStreaming1
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
var boolean bool = false
|
||||||
|
if err := utils.UnmarshalJSON(data, &boolean, "", true, true); err == nil {
|
||||||
|
u.Boolean = &boolean
|
||||||
|
u.Type = GetLibrarySectionsAllOptimizedForStreamingTypeBoolean
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
return fmt.Errorf("could not unmarshal `%s` into any supported union types for GetLibrarySectionsAllOptimizedForStreaming", string(data))
|
||||||
|
}
|
||||||
|
|
||||||
|
func (u GetLibrarySectionsAllOptimizedForStreaming) MarshalJSON() ([]byte, error) {
|
||||||
|
if u.GetLibrarySectionsAllOptimizedForStreaming1 != nil {
|
||||||
|
return utils.MarshalJSON(u.GetLibrarySectionsAllOptimizedForStreaming1, "", true)
|
||||||
|
}
|
||||||
|
|
||||||
|
if u.Boolean != nil {
|
||||||
|
return utils.MarshalJSON(u.Boolean, "", true)
|
||||||
|
}
|
||||||
|
|
||||||
|
return nil, errors.New("could not marshal union type GetLibrarySectionsAllOptimizedForStreaming: all fields are null")
|
||||||
|
}
|
||||||
|
|
||||||
|
type GetLibrarySectionsAllOptimizedForStreamingLibrary1 int
|
||||||
|
|
||||||
|
const (
|
||||||
|
GetLibrarySectionsAllOptimizedForStreamingLibrary1Zero GetLibrarySectionsAllOptimizedForStreamingLibrary1 = 0
|
||||||
|
GetLibrarySectionsAllOptimizedForStreamingLibrary1One GetLibrarySectionsAllOptimizedForStreamingLibrary1 = 1
|
||||||
|
)
|
||||||
|
|
||||||
|
func (e GetLibrarySectionsAllOptimizedForStreamingLibrary1) ToPointer() *GetLibrarySectionsAllOptimizedForStreamingLibrary1 {
|
||||||
|
return &e
|
||||||
|
}
|
||||||
|
func (e *GetLibrarySectionsAllOptimizedForStreamingLibrary1) UnmarshalJSON(data []byte) error {
|
||||||
|
var v int
|
||||||
|
if err := json.Unmarshal(data, &v); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
switch v {
|
||||||
|
case 0:
|
||||||
|
fallthrough
|
||||||
|
case 1:
|
||||||
|
*e = GetLibrarySectionsAllOptimizedForStreamingLibrary1(v)
|
||||||
|
return nil
|
||||||
|
default:
|
||||||
|
return fmt.Errorf("invalid value for GetLibrarySectionsAllOptimizedForStreamingLibrary1: %v", v)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
type GetLibrarySectionsAllLibraryOptimizedForStreamingType string
|
type GetLibrarySectionsAllLibraryOptimizedForStreamingType string
|
||||||
|
|
||||||
const (
|
const (
|
||||||
GetLibrarySectionsAllLibraryOptimizedForStreamingTypeGetLibrarySectionsAllOptimizedForStreaming1 GetLibrarySectionsAllLibraryOptimizedForStreamingType = "get-library-sections-all_optimizedForStreaming_1"
|
GetLibrarySectionsAllLibraryOptimizedForStreamingTypeGetLibrarySectionsAllOptimizedForStreamingLibrary1 GetLibrarySectionsAllLibraryOptimizedForStreamingType = "get-library-sections-all_optimizedForStreaming_Library_1"
|
||||||
GetLibrarySectionsAllLibraryOptimizedForStreamingTypeBoolean GetLibrarySectionsAllLibraryOptimizedForStreamingType = "boolean"
|
GetLibrarySectionsAllLibraryOptimizedForStreamingTypeBoolean GetLibrarySectionsAllLibraryOptimizedForStreamingType = "boolean"
|
||||||
)
|
)
|
||||||
|
|
||||||
// GetLibrarySectionsAllLibraryOptimizedForStreaming - Has this media been optimized for streaming. NOTE: This can be 0, 1, false or true
|
// GetLibrarySectionsAllLibraryOptimizedForStreaming - Has this media been optimized for streaming. NOTE: This can be 0, 1, false or true
|
||||||
type GetLibrarySectionsAllLibraryOptimizedForStreaming struct {
|
type GetLibrarySectionsAllLibraryOptimizedForStreaming struct {
|
||||||
GetLibrarySectionsAllOptimizedForStreaming1 *GetLibrarySectionsAllOptimizedForStreaming1 `queryParam:"inline"`
|
GetLibrarySectionsAllOptimizedForStreamingLibrary1 *GetLibrarySectionsAllOptimizedForStreamingLibrary1 `queryParam:"inline"`
|
||||||
Boolean *bool `queryParam:"inline"`
|
Boolean *bool `queryParam:"inline"`
|
||||||
|
|
||||||
Type GetLibrarySectionsAllLibraryOptimizedForStreamingType
|
Type GetLibrarySectionsAllLibraryOptimizedForStreamingType
|
||||||
}
|
}
|
||||||
|
|
||||||
func CreateGetLibrarySectionsAllLibraryOptimizedForStreamingGetLibrarySectionsAllOptimizedForStreaming1(getLibrarySectionsAllOptimizedForStreaming1 GetLibrarySectionsAllOptimizedForStreaming1) GetLibrarySectionsAllLibraryOptimizedForStreaming {
|
func CreateGetLibrarySectionsAllLibraryOptimizedForStreamingGetLibrarySectionsAllOptimizedForStreamingLibrary1(getLibrarySectionsAllOptimizedForStreamingLibrary1 GetLibrarySectionsAllOptimizedForStreamingLibrary1) GetLibrarySectionsAllLibraryOptimizedForStreaming {
|
||||||
typ := GetLibrarySectionsAllLibraryOptimizedForStreamingTypeGetLibrarySectionsAllOptimizedForStreaming1
|
typ := GetLibrarySectionsAllLibraryOptimizedForStreamingTypeGetLibrarySectionsAllOptimizedForStreamingLibrary1
|
||||||
|
|
||||||
return GetLibrarySectionsAllLibraryOptimizedForStreaming{
|
return GetLibrarySectionsAllLibraryOptimizedForStreaming{
|
||||||
GetLibrarySectionsAllOptimizedForStreaming1: &getLibrarySectionsAllOptimizedForStreaming1,
|
GetLibrarySectionsAllOptimizedForStreamingLibrary1: &getLibrarySectionsAllOptimizedForStreamingLibrary1,
|
||||||
Type: typ,
|
Type: typ,
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@@ -881,10 +881,10 @@ func CreateGetLibrarySectionsAllLibraryOptimizedForStreamingBoolean(boolean bool
|
|||||||
|
|
||||||
func (u *GetLibrarySectionsAllLibraryOptimizedForStreaming) UnmarshalJSON(data []byte) error {
|
func (u *GetLibrarySectionsAllLibraryOptimizedForStreaming) UnmarshalJSON(data []byte) error {
|
||||||
|
|
||||||
var getLibrarySectionsAllOptimizedForStreaming1 GetLibrarySectionsAllOptimizedForStreaming1 = GetLibrarySectionsAllOptimizedForStreaming1(0)
|
var getLibrarySectionsAllOptimizedForStreamingLibrary1 GetLibrarySectionsAllOptimizedForStreamingLibrary1 = GetLibrarySectionsAllOptimizedForStreamingLibrary1(0)
|
||||||
if err := utils.UnmarshalJSON(data, &getLibrarySectionsAllOptimizedForStreaming1, "", true, true); err == nil {
|
if err := utils.UnmarshalJSON(data, &getLibrarySectionsAllOptimizedForStreamingLibrary1, "", true, true); err == nil {
|
||||||
u.GetLibrarySectionsAllOptimizedForStreaming1 = &getLibrarySectionsAllOptimizedForStreaming1
|
u.GetLibrarySectionsAllOptimizedForStreamingLibrary1 = &getLibrarySectionsAllOptimizedForStreamingLibrary1
|
||||||
u.Type = GetLibrarySectionsAllLibraryOptimizedForStreamingTypeGetLibrarySectionsAllOptimizedForStreaming1
|
u.Type = GetLibrarySectionsAllLibraryOptimizedForStreamingTypeGetLibrarySectionsAllOptimizedForStreamingLibrary1
|
||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -899,8 +899,8 @@ func (u *GetLibrarySectionsAllLibraryOptimizedForStreaming) UnmarshalJSON(data [
|
|||||||
}
|
}
|
||||||
|
|
||||||
func (u GetLibrarySectionsAllLibraryOptimizedForStreaming) MarshalJSON() ([]byte, error) {
|
func (u GetLibrarySectionsAllLibraryOptimizedForStreaming) MarshalJSON() ([]byte, error) {
|
||||||
if u.GetLibrarySectionsAllOptimizedForStreaming1 != nil {
|
if u.GetLibrarySectionsAllOptimizedForStreamingLibrary1 != nil {
|
||||||
return utils.MarshalJSON(u.GetLibrarySectionsAllOptimizedForStreaming1, "", true)
|
return utils.MarshalJSON(u.GetLibrarySectionsAllOptimizedForStreamingLibrary1, "", true)
|
||||||
}
|
}
|
||||||
|
|
||||||
if u.Boolean != nil {
|
if u.Boolean != nil {
|
||||||
@@ -937,31 +937,15 @@ func (e *GetLibrarySectionsAllHasThumbnail) UnmarshalJSON(data []byte) error {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
// GetLibrarySectionsAllStreamType - Stream type:
|
|
||||||
// - 1 = video
|
|
||||||
// - 2 = audio
|
|
||||||
// - 3 = subtitle
|
|
||||||
type GetLibrarySectionsAllStreamType int
|
|
||||||
|
|
||||||
const (
|
|
||||||
GetLibrarySectionsAllStreamTypeVideo GetLibrarySectionsAllStreamType = 1
|
|
||||||
GetLibrarySectionsAllStreamTypeAudio GetLibrarySectionsAllStreamType = 2
|
|
||||||
GetLibrarySectionsAllStreamTypeSubtitle GetLibrarySectionsAllStreamType = 3
|
|
||||||
)
|
|
||||||
|
|
||||||
func (e GetLibrarySectionsAllStreamType) ToPointer() *GetLibrarySectionsAllStreamType {
|
|
||||||
return &e
|
|
||||||
}
|
|
||||||
|
|
||||||
type GetLibrarySectionsAllStream struct {
|
type GetLibrarySectionsAllStream struct {
|
||||||
// Unique stream identifier.
|
// Unique stream identifier.
|
||||||
ID int64 `json:"id"`
|
ID int64 `json:"id"`
|
||||||
// Stream type:
|
// Stream type:
|
||||||
// - 1 = video
|
// - VIDEO = 1
|
||||||
// - 2 = audio
|
// - AUDIO = 2
|
||||||
// - 3 = subtitle
|
// - SUBTITLE = 3
|
||||||
//
|
//
|
||||||
StreamType GetLibrarySectionsAllStreamType `json:"streamType"`
|
streamType int64 `const:"1" json:"streamType"`
|
||||||
// Format of the stream (e.g., srt).
|
// Format of the stream (e.g., srt).
|
||||||
Format *string `json:"format,omitempty"`
|
Format *string `json:"format,omitempty"`
|
||||||
// Indicates if this stream is default.
|
// Indicates if this stream is default.
|
||||||
@@ -1057,6 +1041,17 @@ type GetLibrarySectionsAllStream struct {
|
|||||||
Title *string `json:"title,omitempty"`
|
Title *string `json:"title,omitempty"`
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func (g GetLibrarySectionsAllStream) MarshalJSON() ([]byte, error) {
|
||||||
|
return utils.MarshalJSON(g, "", false)
|
||||||
|
}
|
||||||
|
|
||||||
|
func (g *GetLibrarySectionsAllStream) UnmarshalJSON(data []byte) error {
|
||||||
|
if err := utils.UnmarshalJSON(data, &g, "", false, false); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
func (o *GetLibrarySectionsAllStream) GetID() int64 {
|
func (o *GetLibrarySectionsAllStream) GetID() int64 {
|
||||||
if o == nil {
|
if o == nil {
|
||||||
return 0
|
return 0
|
||||||
@@ -1064,11 +1059,8 @@ func (o *GetLibrarySectionsAllStream) GetID() int64 {
|
|||||||
return o.ID
|
return o.ID
|
||||||
}
|
}
|
||||||
|
|
||||||
func (o *GetLibrarySectionsAllStream) GetStreamType() GetLibrarySectionsAllStreamType {
|
func (o *GetLibrarySectionsAllStream) GetStreamType() int64 {
|
||||||
if o == nil {
|
return 1
|
||||||
return GetLibrarySectionsAllStreamType(0)
|
|
||||||
}
|
|
||||||
return o.StreamType
|
|
||||||
}
|
}
|
||||||
|
|
||||||
func (o *GetLibrarySectionsAllStream) GetFormat() *string {
|
func (o *GetLibrarySectionsAllStream) GetFormat() *string {
|
||||||
@@ -1862,7 +1854,7 @@ type GetLibrarySectionsAllMetadata struct {
|
|||||||
// The duration of the media item in milliseconds.
|
// The duration of the media item in milliseconds.
|
||||||
Duration int `json:"duration"`
|
Duration int `json:"duration"`
|
||||||
// The original release date of the media item.
|
// The original release date of the media item.
|
||||||
OriginallyAvailableAt types.Date `json:"originallyAvailableAt"`
|
OriginallyAvailableAt *types.Date `json:"originallyAvailableAt,omitempty"`
|
||||||
AddedAt int64 `json:"addedAt"`
|
AddedAt int64 `json:"addedAt"`
|
||||||
// Unix epoch datetime in seconds
|
// Unix epoch datetime in seconds
|
||||||
UpdatedAt *int64 `json:"updatedAt,omitempty"`
|
UpdatedAt *int64 `json:"updatedAt,omitempty"`
|
||||||
@@ -2106,9 +2098,9 @@ func (o *GetLibrarySectionsAllMetadata) GetDuration() int {
|
|||||||
return o.Duration
|
return o.Duration
|
||||||
}
|
}
|
||||||
|
|
||||||
func (o *GetLibrarySectionsAllMetadata) GetOriginallyAvailableAt() types.Date {
|
func (o *GetLibrarySectionsAllMetadata) GetOriginallyAvailableAt() *types.Date {
|
||||||
if o == nil {
|
if o == nil {
|
||||||
return types.Date{}
|
return nil
|
||||||
}
|
}
|
||||||
return o.OriginallyAvailableAt
|
return o.OriginallyAvailableAt
|
||||||
}
|
}
|
||||||
@@ -2409,9 +2401,9 @@ type GetLibrarySectionsAllMediaContainer struct {
|
|||||||
// An plugin identifier for the media container.
|
// An plugin identifier for the media container.
|
||||||
Identifier string `json:"identifier"`
|
Identifier string `json:"identifier"`
|
||||||
// The unique identifier for the library section.
|
// The unique identifier for the library section.
|
||||||
LibrarySectionID int64 `json:"librarySectionID"`
|
LibrarySectionID *int64 `json:"librarySectionID,omitempty"`
|
||||||
// The title of the library section.
|
// The title of the library section.
|
||||||
LibrarySectionTitle string `json:"librarySectionTitle"`
|
LibrarySectionTitle *string `json:"librarySectionTitle,omitempty"`
|
||||||
// The universally unique identifier for the library section.
|
// The universally unique identifier for the library section.
|
||||||
LibrarySectionUUID *string `json:"librarySectionUUID,omitempty"`
|
LibrarySectionUUID *string `json:"librarySectionUUID,omitempty"`
|
||||||
// The prefix used for media tag resource paths.
|
// The prefix used for media tag resource paths.
|
||||||
@@ -2484,16 +2476,16 @@ func (o *GetLibrarySectionsAllMediaContainer) GetIdentifier() string {
|
|||||||
return o.Identifier
|
return o.Identifier
|
||||||
}
|
}
|
||||||
|
|
||||||
func (o *GetLibrarySectionsAllMediaContainer) GetLibrarySectionID() int64 {
|
func (o *GetLibrarySectionsAllMediaContainer) GetLibrarySectionID() *int64 {
|
||||||
if o == nil {
|
if o == nil {
|
||||||
return 0
|
return nil
|
||||||
}
|
}
|
||||||
return o.LibrarySectionID
|
return o.LibrarySectionID
|
||||||
}
|
}
|
||||||
|
|
||||||
func (o *GetLibrarySectionsAllMediaContainer) GetLibrarySectionTitle() string {
|
func (o *GetLibrarySectionsAllMediaContainer) GetLibrarySectionTitle() *string {
|
||||||
if o == nil {
|
if o == nil {
|
||||||
return ""
|
return nil
|
||||||
}
|
}
|
||||||
return o.LibrarySectionTitle
|
return o.LibrarySectionTitle
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -455,37 +455,21 @@ func (e *GetMediaMetaDataHasThumbnail) UnmarshalJSON(data []byte) error {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
// GetMediaMetaDataStreamType - Stream type:
|
|
||||||
// - 1 = video
|
|
||||||
// - 2 = audio
|
|
||||||
// - 3 = subtitle
|
|
||||||
type GetMediaMetaDataStreamType int
|
|
||||||
|
|
||||||
const (
|
|
||||||
GetMediaMetaDataStreamTypeVideo GetMediaMetaDataStreamType = 1
|
|
||||||
GetMediaMetaDataStreamTypeAudio GetMediaMetaDataStreamType = 2
|
|
||||||
GetMediaMetaDataStreamTypeSubtitle GetMediaMetaDataStreamType = 3
|
|
||||||
)
|
|
||||||
|
|
||||||
func (e GetMediaMetaDataStreamType) ToPointer() *GetMediaMetaDataStreamType {
|
|
||||||
return &e
|
|
||||||
}
|
|
||||||
|
|
||||||
type GetMediaMetaDataStream struct {
|
type GetMediaMetaDataStream struct {
|
||||||
// Unique stream identifier.
|
// Unique stream identifier.
|
||||||
ID int64 `json:"id"`
|
ID int64 `json:"id"`
|
||||||
// Stream type:
|
// Stream type:
|
||||||
// - 1 = video
|
// - VIDEO = 1
|
||||||
// - 2 = audio
|
// - AUDIO = 2
|
||||||
// - 3 = subtitle
|
// - SUBTITLE = 3
|
||||||
//
|
//
|
||||||
StreamType GetMediaMetaDataStreamType `json:"streamType"`
|
streamType int64 `const:"1" json:"streamType"`
|
||||||
// Format of the stream (e.g., srt).
|
// Format of the stream (e.g., srt).
|
||||||
Format *string `json:"format,omitempty"`
|
Format *string `json:"format,omitempty"`
|
||||||
// Indicates if this stream is default.
|
// Indicates if this stream is default.
|
||||||
Default *bool `json:"default,omitempty"`
|
Default *bool `json:"default,omitempty"`
|
||||||
// Codec used by the stream.
|
// Codec used by the stream.
|
||||||
Codec string `json:"codec"`
|
Codec *string `json:"codec,omitempty"`
|
||||||
// Index of the stream.
|
// Index of the stream.
|
||||||
Index *int `json:"index,omitempty"`
|
Index *int `json:"index,omitempty"`
|
||||||
// Bitrate of the stream.
|
// Bitrate of the stream.
|
||||||
@@ -553,9 +537,9 @@ type GetMediaMetaDataStream struct {
|
|||||||
// Width of the video stream.
|
// Width of the video stream.
|
||||||
Width *int `json:"width,omitempty"`
|
Width *int `json:"width,omitempty"`
|
||||||
// Display title for the stream.
|
// Display title for the stream.
|
||||||
DisplayTitle string `json:"displayTitle"`
|
DisplayTitle *string `json:"displayTitle,omitempty"`
|
||||||
// Extended display title for the stream.
|
// Extended display title for the stream.
|
||||||
ExtendedDisplayTitle string `json:"extendedDisplayTitle"`
|
ExtendedDisplayTitle *string `json:"extendedDisplayTitle,omitempty"`
|
||||||
// Indicates if this stream is selected (applicable for audio streams).
|
// Indicates if this stream is selected (applicable for audio streams).
|
||||||
Selected *bool `json:"selected,omitempty"`
|
Selected *bool `json:"selected,omitempty"`
|
||||||
Forced *bool `json:"forced,omitempty"`
|
Forced *bool `json:"forced,omitempty"`
|
||||||
@@ -575,6 +559,17 @@ type GetMediaMetaDataStream struct {
|
|||||||
Title *string `json:"title,omitempty"`
|
Title *string `json:"title,omitempty"`
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func (g GetMediaMetaDataStream) MarshalJSON() ([]byte, error) {
|
||||||
|
return utils.MarshalJSON(g, "", false)
|
||||||
|
}
|
||||||
|
|
||||||
|
func (g *GetMediaMetaDataStream) UnmarshalJSON(data []byte) error {
|
||||||
|
if err := utils.UnmarshalJSON(data, &g, "", false, false); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
func (o *GetMediaMetaDataStream) GetID() int64 {
|
func (o *GetMediaMetaDataStream) GetID() int64 {
|
||||||
if o == nil {
|
if o == nil {
|
||||||
return 0
|
return 0
|
||||||
@@ -582,11 +577,8 @@ func (o *GetMediaMetaDataStream) GetID() int64 {
|
|||||||
return o.ID
|
return o.ID
|
||||||
}
|
}
|
||||||
|
|
||||||
func (o *GetMediaMetaDataStream) GetStreamType() GetMediaMetaDataStreamType {
|
func (o *GetMediaMetaDataStream) GetStreamType() int64 {
|
||||||
if o == nil {
|
return 1
|
||||||
return GetMediaMetaDataStreamType(0)
|
|
||||||
}
|
|
||||||
return o.StreamType
|
|
||||||
}
|
}
|
||||||
|
|
||||||
func (o *GetMediaMetaDataStream) GetFormat() *string {
|
func (o *GetMediaMetaDataStream) GetFormat() *string {
|
||||||
@@ -603,9 +595,9 @@ func (o *GetMediaMetaDataStream) GetDefault() *bool {
|
|||||||
return o.Default
|
return o.Default
|
||||||
}
|
}
|
||||||
|
|
||||||
func (o *GetMediaMetaDataStream) GetCodec() string {
|
func (o *GetMediaMetaDataStream) GetCodec() *string {
|
||||||
if o == nil {
|
if o == nil {
|
||||||
return ""
|
return nil
|
||||||
}
|
}
|
||||||
return o.Codec
|
return o.Codec
|
||||||
}
|
}
|
||||||
@@ -855,16 +847,16 @@ func (o *GetMediaMetaDataStream) GetWidth() *int {
|
|||||||
return o.Width
|
return o.Width
|
||||||
}
|
}
|
||||||
|
|
||||||
func (o *GetMediaMetaDataStream) GetDisplayTitle() string {
|
func (o *GetMediaMetaDataStream) GetDisplayTitle() *string {
|
||||||
if o == nil {
|
if o == nil {
|
||||||
return ""
|
return nil
|
||||||
}
|
}
|
||||||
return o.DisplayTitle
|
return o.DisplayTitle
|
||||||
}
|
}
|
||||||
|
|
||||||
func (o *GetMediaMetaDataStream) GetExtendedDisplayTitle() string {
|
func (o *GetMediaMetaDataStream) GetExtendedDisplayTitle() *string {
|
||||||
if o == nil {
|
if o == nil {
|
||||||
return ""
|
return nil
|
||||||
}
|
}
|
||||||
return o.ExtendedDisplayTitle
|
return o.ExtendedDisplayTitle
|
||||||
}
|
}
|
||||||
@@ -940,14 +932,14 @@ type GetMediaMetaDataPart struct {
|
|||||||
// Unique part identifier.
|
// Unique part identifier.
|
||||||
ID int64 `json:"id"`
|
ID int64 `json:"id"`
|
||||||
// Key to access this part.
|
// Key to access this part.
|
||||||
Key string `json:"key"`
|
Key *string `json:"key,omitempty"`
|
||||||
Indexes *string `json:"indexes,omitempty"`
|
Indexes *string `json:"indexes,omitempty"`
|
||||||
// Duration of the part in milliseconds.
|
// Duration of the part in milliseconds.
|
||||||
Duration *int `json:"duration,omitempty"`
|
Duration *int `json:"duration,omitempty"`
|
||||||
// File path for the part.
|
// File path for the part.
|
||||||
File string `json:"file"`
|
File *string `json:"file,omitempty"`
|
||||||
// File size in bytes.
|
// File size in bytes.
|
||||||
Size int64 `json:"size"`
|
Size *int64 `json:"size,omitempty"`
|
||||||
PacketLength *int `json:"packetLength,omitempty"`
|
PacketLength *int `json:"packetLength,omitempty"`
|
||||||
// Container format of the part.
|
// Container format of the part.
|
||||||
Container *string `json:"container,omitempty"`
|
Container *string `json:"container,omitempty"`
|
||||||
@@ -957,9 +949,9 @@ type GetMediaMetaDataPart struct {
|
|||||||
AudioProfile *string `json:"audioProfile,omitempty"`
|
AudioProfile *string `json:"audioProfile,omitempty"`
|
||||||
Has64bitOffsets *bool `json:"has64bitOffsets,omitempty"`
|
Has64bitOffsets *bool `json:"has64bitOffsets,omitempty"`
|
||||||
// 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
|
||||||
|
//
|
||||||
OptimizedForStreaming *GetMediaMetaDataLibraryOptimizedForStreaming `json:"optimizedForStreaming,omitempty"`
|
OptimizedForStreaming *GetMediaMetaDataLibraryOptimizedForStreaming `json:"optimizedForStreaming,omitempty"`
|
||||||
HasThumbnail *GetMediaMetaDataHasThumbnail `default:"0" json:"hasThumbnail"`
|
HasThumbnail *GetMediaMetaDataHasThumbnail `default:"0" json:"hasThumbnail"`
|
||||||
// An array of streams for this part.
|
|
||||||
Stream []GetMediaMetaDataStream `json:"Stream,omitempty"`
|
Stream []GetMediaMetaDataStream `json:"Stream,omitempty"`
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -995,9 +987,9 @@ func (o *GetMediaMetaDataPart) GetID() int64 {
|
|||||||
return o.ID
|
return o.ID
|
||||||
}
|
}
|
||||||
|
|
||||||
func (o *GetMediaMetaDataPart) GetKey() string {
|
func (o *GetMediaMetaDataPart) GetKey() *string {
|
||||||
if o == nil {
|
if o == nil {
|
||||||
return ""
|
return nil
|
||||||
}
|
}
|
||||||
return o.Key
|
return o.Key
|
||||||
}
|
}
|
||||||
@@ -1016,16 +1008,16 @@ func (o *GetMediaMetaDataPart) GetDuration() *int {
|
|||||||
return o.Duration
|
return o.Duration
|
||||||
}
|
}
|
||||||
|
|
||||||
func (o *GetMediaMetaDataPart) GetFile() string {
|
func (o *GetMediaMetaDataPart) GetFile() *string {
|
||||||
if o == nil {
|
if o == nil {
|
||||||
return ""
|
return nil
|
||||||
}
|
}
|
||||||
return o.File
|
return o.File
|
||||||
}
|
}
|
||||||
|
|
||||||
func (o *GetMediaMetaDataPart) GetSize() int64 {
|
func (o *GetMediaMetaDataPart) GetSize() *int64 {
|
||||||
if o == nil {
|
if o == nil {
|
||||||
return 0
|
return nil
|
||||||
}
|
}
|
||||||
return o.Size
|
return o.Size
|
||||||
}
|
}
|
||||||
@@ -1108,7 +1100,7 @@ type GetMediaMetaDataMedia struct {
|
|||||||
VideoCodec *string `json:"videoCodec,omitempty"`
|
VideoCodec *string `json:"videoCodec,omitempty"`
|
||||||
// Video resolution (e.g., 4k).
|
// Video resolution (e.g., 4k).
|
||||||
VideoResolution *string `json:"videoResolution,omitempty"`
|
VideoResolution *string `json:"videoResolution,omitempty"`
|
||||||
// File container type.
|
// Container format of the media.
|
||||||
Container *string `json:"container,omitempty"`
|
Container *string `json:"container,omitempty"`
|
||||||
// Frame rate of the video. Values found include NTSC, PAL, 24p
|
// Frame rate of the video. Values found include NTSC, PAL, 24p
|
||||||
//
|
//
|
||||||
@@ -1121,8 +1113,10 @@ type GetMediaMetaDataMedia struct {
|
|||||||
AudioProfile *string `json:"audioProfile,omitempty"`
|
AudioProfile *string `json:"audioProfile,omitempty"`
|
||||||
// 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
|
||||||
OptimizedForStreaming *GetMediaMetaDataOptimizedForStreaming `json:"optimizedForStreaming,omitempty"`
|
OptimizedForStreaming *GetMediaMetaDataOptimizedForStreaming `json:"optimizedForStreaming,omitempty"`
|
||||||
|
// Indicates whether the media has 64-bit offsets.
|
||||||
|
// This is relevant for media files that may require larger offsets than what 32-bit integers can provide.
|
||||||
|
//
|
||||||
Has64bitOffsets *bool `json:"has64bitOffsets,omitempty"`
|
Has64bitOffsets *bool `json:"has64bitOffsets,omitempty"`
|
||||||
// An array of parts for this media item.
|
|
||||||
Part []GetMediaMetaDataPart `json:"Part,omitempty"`
|
Part []GetMediaMetaDataPart `json:"Part,omitempty"`
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -1538,7 +1532,7 @@ func (o *GetMediaMetaDataRole) GetThumb() *string {
|
|||||||
return o.Thumb
|
return o.Thumb
|
||||||
}
|
}
|
||||||
|
|
||||||
type Ratings struct {
|
type GetMediaMetaDataRatings struct {
|
||||||
// The image or reference for the rating.
|
// The image or reference for the rating.
|
||||||
Image string `json:"image"`
|
Image string `json:"image"`
|
||||||
// The rating value.
|
// The rating value.
|
||||||
@@ -1547,21 +1541,21 @@ type Ratings struct {
|
|||||||
Type string `json:"type"`
|
Type string `json:"type"`
|
||||||
}
|
}
|
||||||
|
|
||||||
func (o *Ratings) GetImage() string {
|
func (o *GetMediaMetaDataRatings) GetImage() string {
|
||||||
if o == nil {
|
if o == nil {
|
||||||
return ""
|
return ""
|
||||||
}
|
}
|
||||||
return o.Image
|
return o.Image
|
||||||
}
|
}
|
||||||
|
|
||||||
func (o *Ratings) GetValue() float32 {
|
func (o *GetMediaMetaDataRatings) GetValue() float32 {
|
||||||
if o == nil {
|
if o == nil {
|
||||||
return 0.0
|
return 0.0
|
||||||
}
|
}
|
||||||
return o.Value
|
return o.Value
|
||||||
}
|
}
|
||||||
|
|
||||||
func (o *Ratings) GetType() string {
|
func (o *GetMediaMetaDataRatings) GetType() string {
|
||||||
if o == nil {
|
if o == nil {
|
||||||
return ""
|
return ""
|
||||||
}
|
}
|
||||||
@@ -1610,8 +1604,8 @@ func (o *GetMediaMetaDataLocation) GetPath() string {
|
|||||||
return o.Path
|
return o.Path
|
||||||
}
|
}
|
||||||
|
|
||||||
// Chapter - The thumbnail for the chapter
|
// GetMediaMetaDataChapter - The thumbnail for the chapter
|
||||||
type Chapter struct {
|
type GetMediaMetaDataChapter struct {
|
||||||
ID int64 `json:"id"`
|
ID int64 `json:"id"`
|
||||||
Filter string `json:"filter"`
|
Filter string `json:"filter"`
|
||||||
Index int64 `json:"index"`
|
Index int64 `json:"index"`
|
||||||
@@ -1620,129 +1614,129 @@ type Chapter struct {
|
|||||||
Thumb string `json:"thumb"`
|
Thumb string `json:"thumb"`
|
||||||
}
|
}
|
||||||
|
|
||||||
func (o *Chapter) GetID() int64 {
|
func (o *GetMediaMetaDataChapter) GetID() int64 {
|
||||||
if o == nil {
|
if o == nil {
|
||||||
return 0
|
return 0
|
||||||
}
|
}
|
||||||
return o.ID
|
return o.ID
|
||||||
}
|
}
|
||||||
|
|
||||||
func (o *Chapter) GetFilter() string {
|
func (o *GetMediaMetaDataChapter) GetFilter() string {
|
||||||
if o == nil {
|
if o == nil {
|
||||||
return ""
|
return ""
|
||||||
}
|
}
|
||||||
return o.Filter
|
return o.Filter
|
||||||
}
|
}
|
||||||
|
|
||||||
func (o *Chapter) GetIndex() int64 {
|
func (o *GetMediaMetaDataChapter) GetIndex() int64 {
|
||||||
if o == nil {
|
if o == nil {
|
||||||
return 0
|
return 0
|
||||||
}
|
}
|
||||||
return o.Index
|
return o.Index
|
||||||
}
|
}
|
||||||
|
|
||||||
func (o *Chapter) GetStartTimeOffset() int64 {
|
func (o *GetMediaMetaDataChapter) GetStartTimeOffset() int64 {
|
||||||
if o == nil {
|
if o == nil {
|
||||||
return 0
|
return 0
|
||||||
}
|
}
|
||||||
return o.StartTimeOffset
|
return o.StartTimeOffset
|
||||||
}
|
}
|
||||||
|
|
||||||
func (o *Chapter) GetEndTimeOffset() int64 {
|
func (o *GetMediaMetaDataChapter) GetEndTimeOffset() int64 {
|
||||||
if o == nil {
|
if o == nil {
|
||||||
return 0
|
return 0
|
||||||
}
|
}
|
||||||
return o.EndTimeOffset
|
return o.EndTimeOffset
|
||||||
}
|
}
|
||||||
|
|
||||||
func (o *Chapter) GetThumb() string {
|
func (o *GetMediaMetaDataChapter) GetThumb() string {
|
||||||
if o == nil {
|
if o == nil {
|
||||||
return ""
|
return ""
|
||||||
}
|
}
|
||||||
return o.Thumb
|
return o.Thumb
|
||||||
}
|
}
|
||||||
|
|
||||||
// Attributes associated with the marker.
|
// GetMediaMetaDataAttributes - Attributes associated with the marker.
|
||||||
type Attributes struct {
|
type GetMediaMetaDataAttributes struct {
|
||||||
// The identifier for the attributes.
|
// The identifier for the attributes.
|
||||||
ID int64 `json:"id"`
|
ID int64 `json:"id"`
|
||||||
// The version number of the marker attributes.
|
// The version number of the marker attributes.
|
||||||
Version *int64 `json:"version,omitempty"`
|
Version *int64 `json:"version,omitempty"`
|
||||||
}
|
}
|
||||||
|
|
||||||
func (o *Attributes) GetID() int64 {
|
func (o *GetMediaMetaDataAttributes) GetID() int64 {
|
||||||
if o == nil {
|
if o == nil {
|
||||||
return 0
|
return 0
|
||||||
}
|
}
|
||||||
return o.ID
|
return o.ID
|
||||||
}
|
}
|
||||||
|
|
||||||
func (o *Attributes) GetVersion() *int64 {
|
func (o *GetMediaMetaDataAttributes) GetVersion() *int64 {
|
||||||
if o == nil {
|
if o == nil {
|
||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
return o.Version
|
return o.Version
|
||||||
}
|
}
|
||||||
|
|
||||||
// Marker - The final status of the marker
|
// GetMediaMetaDataMarker - The final status of the marker
|
||||||
type Marker struct {
|
type GetMediaMetaDataMarker struct {
|
||||||
ID int64 `json:"id"`
|
ID int64 `json:"id"`
|
||||||
Type string `json:"type"`
|
Type string `json:"type"`
|
||||||
StartTimeOffset int64 `json:"startTimeOffset"`
|
StartTimeOffset int64 `json:"startTimeOffset"`
|
||||||
EndTimeOffset int64 `json:"endTimeOffset"`
|
EndTimeOffset int64 `json:"endTimeOffset"`
|
||||||
Final *bool `json:"final,omitempty"`
|
Final *bool `json:"final,omitempty"`
|
||||||
// Attributes associated with the marker.
|
// Attributes associated with the marker.
|
||||||
Attributes *Attributes `json:"Attributes,omitempty"`
|
Attributes *GetMediaMetaDataAttributes `json:"Attributes,omitempty"`
|
||||||
}
|
}
|
||||||
|
|
||||||
func (o *Marker) GetID() int64 {
|
func (o *GetMediaMetaDataMarker) GetID() int64 {
|
||||||
if o == nil {
|
if o == nil {
|
||||||
return 0
|
return 0
|
||||||
}
|
}
|
||||||
return o.ID
|
return o.ID
|
||||||
}
|
}
|
||||||
|
|
||||||
func (o *Marker) GetType() string {
|
func (o *GetMediaMetaDataMarker) GetType() string {
|
||||||
if o == nil {
|
if o == nil {
|
||||||
return ""
|
return ""
|
||||||
}
|
}
|
||||||
return o.Type
|
return o.Type
|
||||||
}
|
}
|
||||||
|
|
||||||
func (o *Marker) GetStartTimeOffset() int64 {
|
func (o *GetMediaMetaDataMarker) GetStartTimeOffset() int64 {
|
||||||
if o == nil {
|
if o == nil {
|
||||||
return 0
|
return 0
|
||||||
}
|
}
|
||||||
return o.StartTimeOffset
|
return o.StartTimeOffset
|
||||||
}
|
}
|
||||||
|
|
||||||
func (o *Marker) GetEndTimeOffset() int64 {
|
func (o *GetMediaMetaDataMarker) GetEndTimeOffset() int64 {
|
||||||
if o == nil {
|
if o == nil {
|
||||||
return 0
|
return 0
|
||||||
}
|
}
|
||||||
return o.EndTimeOffset
|
return o.EndTimeOffset
|
||||||
}
|
}
|
||||||
|
|
||||||
func (o *Marker) GetFinal() *bool {
|
func (o *GetMediaMetaDataMarker) GetFinal() *bool {
|
||||||
if o == nil {
|
if o == nil {
|
||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
return o.Final
|
return o.Final
|
||||||
}
|
}
|
||||||
|
|
||||||
func (o *Marker) GetAttributes() *Attributes {
|
func (o *GetMediaMetaDataMarker) GetAttributes() *GetMediaMetaDataAttributes {
|
||||||
if o == nil {
|
if o == nil {
|
||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
return o.Attributes
|
return o.Attributes
|
||||||
}
|
}
|
||||||
|
|
||||||
type Extras struct {
|
type GetMediaMetaDataExtras struct {
|
||||||
// The size of the extras.
|
// The size of the extras.
|
||||||
Size *int64 `json:"size,omitempty"`
|
Size *int64 `json:"size,omitempty"`
|
||||||
}
|
}
|
||||||
|
|
||||||
func (o *Extras) GetSize() *int64 {
|
func (o *GetMediaMetaDataExtras) GetSize() *int64 {
|
||||||
if o == nil {
|
if o == nil {
|
||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
@@ -1797,7 +1791,7 @@ type GetMediaMetaDataMetadata struct {
|
|||||||
// The duration of the media item in milliseconds.
|
// The duration of the media item in milliseconds.
|
||||||
Duration int `json:"duration"`
|
Duration int `json:"duration"`
|
||||||
// The original release date of the media item.
|
// The original release date of the media item.
|
||||||
OriginallyAvailableAt types.Date `json:"originallyAvailableAt"`
|
OriginallyAvailableAt *types.Date `json:"originallyAvailableAt,omitempty"`
|
||||||
AddedAt int64 `json:"addedAt"`
|
AddedAt int64 `json:"addedAt"`
|
||||||
// Unix epoch datetime in seconds
|
// Unix epoch datetime in seconds
|
||||||
UpdatedAt *int64 `json:"updatedAt,omitempty"`
|
UpdatedAt *int64 `json:"updatedAt,omitempty"`
|
||||||
@@ -1860,11 +1854,11 @@ type GetMediaMetaDataMetadata struct {
|
|||||||
Image []GetMediaMetaDataImage `json:"Image,omitempty"`
|
Image []GetMediaMetaDataImage `json:"Image,omitempty"`
|
||||||
UltraBlurColors *GetMediaMetaDataUltraBlurColors `json:"UltraBlurColors,omitempty"`
|
UltraBlurColors *GetMediaMetaDataUltraBlurColors `json:"UltraBlurColors,omitempty"`
|
||||||
// The identifier for the library section.
|
// The identifier for the library section.
|
||||||
LibrarySectionID int64 `json:"librarySectionID"`
|
LibrarySectionID *int64 `json:"librarySectionID,omitempty"`
|
||||||
// The title of the library section.
|
// The title of the library section.
|
||||||
LibrarySectionTitle string `json:"librarySectionTitle"`
|
LibrarySectionTitle *string `json:"librarySectionTitle,omitempty"`
|
||||||
// The key corresponding to the library section.
|
// The key corresponding to the library section.
|
||||||
LibrarySectionKey string `json:"librarySectionKey"`
|
LibrarySectionKey *string `json:"librarySectionKey,omitempty"`
|
||||||
Guids []GetMediaMetaDataGuids `json:"Guid,omitempty"`
|
Guids []GetMediaMetaDataGuids `json:"Guid,omitempty"`
|
||||||
Media []GetMediaMetaDataMedia `json:"Media,omitempty"`
|
Media []GetMediaMetaDataMedia `json:"Media,omitempty"`
|
||||||
Genre []GetMediaMetaDataGenre `json:"Genre,omitempty"`
|
Genre []GetMediaMetaDataGenre `json:"Genre,omitempty"`
|
||||||
@@ -1873,12 +1867,12 @@ type GetMediaMetaDataMetadata struct {
|
|||||||
Writer []GetMediaMetaDataWriter `json:"Writer,omitempty"`
|
Writer []GetMediaMetaDataWriter `json:"Writer,omitempty"`
|
||||||
Producer []GetMediaMetaDataProducer `json:"Producer,omitempty"`
|
Producer []GetMediaMetaDataProducer `json:"Producer,omitempty"`
|
||||||
Role []GetMediaMetaDataRole `json:"Role,omitempty"`
|
Role []GetMediaMetaDataRole `json:"Role,omitempty"`
|
||||||
Ratings []Ratings `json:"Rating,omitempty"`
|
Ratings []GetMediaMetaDataRatings `json:"Rating,omitempty"`
|
||||||
Similar []GetMediaMetaDataSimilar `json:"Similar,omitempty"`
|
Similar []GetMediaMetaDataSimilar `json:"Similar,omitempty"`
|
||||||
Location []GetMediaMetaDataLocation `json:"Location,omitempty"`
|
Location []GetMediaMetaDataLocation `json:"Location,omitempty"`
|
||||||
Chapter []Chapter `json:"Chapter,omitempty"`
|
Chapter []GetMediaMetaDataChapter `json:"Chapter,omitempty"`
|
||||||
Marker []Marker `json:"Marker,omitempty"`
|
Marker []GetMediaMetaDataMarker `json:"Marker,omitempty"`
|
||||||
Extras *Extras `json:"Extras,omitempty"`
|
Extras *GetMediaMetaDataExtras `json:"Extras,omitempty"`
|
||||||
}
|
}
|
||||||
|
|
||||||
func (g GetMediaMetaDataMetadata) MarshalJSON() ([]byte, error) {
|
func (g GetMediaMetaDataMetadata) MarshalJSON() ([]byte, error) {
|
||||||
@@ -2053,9 +2047,9 @@ func (o *GetMediaMetaDataMetadata) GetDuration() int {
|
|||||||
return o.Duration
|
return o.Duration
|
||||||
}
|
}
|
||||||
|
|
||||||
func (o *GetMediaMetaDataMetadata) GetOriginallyAvailableAt() types.Date {
|
func (o *GetMediaMetaDataMetadata) GetOriginallyAvailableAt() *types.Date {
|
||||||
if o == nil {
|
if o == nil {
|
||||||
return types.Date{}
|
return nil
|
||||||
}
|
}
|
||||||
return o.OriginallyAvailableAt
|
return o.OriginallyAvailableAt
|
||||||
}
|
}
|
||||||
@@ -2284,23 +2278,23 @@ func (o *GetMediaMetaDataMetadata) GetUltraBlurColors() *GetMediaMetaDataUltraBl
|
|||||||
return o.UltraBlurColors
|
return o.UltraBlurColors
|
||||||
}
|
}
|
||||||
|
|
||||||
func (o *GetMediaMetaDataMetadata) GetLibrarySectionID() int64 {
|
func (o *GetMediaMetaDataMetadata) GetLibrarySectionID() *int64 {
|
||||||
if o == nil {
|
if o == nil {
|
||||||
return 0
|
return nil
|
||||||
}
|
}
|
||||||
return o.LibrarySectionID
|
return o.LibrarySectionID
|
||||||
}
|
}
|
||||||
|
|
||||||
func (o *GetMediaMetaDataMetadata) GetLibrarySectionTitle() string {
|
func (o *GetMediaMetaDataMetadata) GetLibrarySectionTitle() *string {
|
||||||
if o == nil {
|
if o == nil {
|
||||||
return ""
|
return nil
|
||||||
}
|
}
|
||||||
return o.LibrarySectionTitle
|
return o.LibrarySectionTitle
|
||||||
}
|
}
|
||||||
|
|
||||||
func (o *GetMediaMetaDataMetadata) GetLibrarySectionKey() string {
|
func (o *GetMediaMetaDataMetadata) GetLibrarySectionKey() *string {
|
||||||
if o == nil {
|
if o == nil {
|
||||||
return ""
|
return nil
|
||||||
}
|
}
|
||||||
return o.LibrarySectionKey
|
return o.LibrarySectionKey
|
||||||
}
|
}
|
||||||
@@ -2361,7 +2355,7 @@ func (o *GetMediaMetaDataMetadata) GetRole() []GetMediaMetaDataRole {
|
|||||||
return o.Role
|
return o.Role
|
||||||
}
|
}
|
||||||
|
|
||||||
func (o *GetMediaMetaDataMetadata) GetRatings() []Ratings {
|
func (o *GetMediaMetaDataMetadata) GetRatings() []GetMediaMetaDataRatings {
|
||||||
if o == nil {
|
if o == nil {
|
||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
@@ -2382,21 +2376,21 @@ func (o *GetMediaMetaDataMetadata) GetLocation() []GetMediaMetaDataLocation {
|
|||||||
return o.Location
|
return o.Location
|
||||||
}
|
}
|
||||||
|
|
||||||
func (o *GetMediaMetaDataMetadata) GetChapter() []Chapter {
|
func (o *GetMediaMetaDataMetadata) GetChapter() []GetMediaMetaDataChapter {
|
||||||
if o == nil {
|
if o == nil {
|
||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
return o.Chapter
|
return o.Chapter
|
||||||
}
|
}
|
||||||
|
|
||||||
func (o *GetMediaMetaDataMetadata) GetMarker() []Marker {
|
func (o *GetMediaMetaDataMetadata) GetMarker() []GetMediaMetaDataMarker {
|
||||||
if o == nil {
|
if o == nil {
|
||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
return o.Marker
|
return o.Marker
|
||||||
}
|
}
|
||||||
|
|
||||||
func (o *GetMediaMetaDataMetadata) GetExtras() *Extras {
|
func (o *GetMediaMetaDataMetadata) GetExtras() *GetMediaMetaDataExtras {
|
||||||
if o == nil {
|
if o == nil {
|
||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
@@ -2411,9 +2405,9 @@ type GetMediaMetaDataMediaContainer struct {
|
|||||||
// An plugin identifier for the media container.
|
// An plugin identifier for the media container.
|
||||||
Identifier string `json:"identifier"`
|
Identifier string `json:"identifier"`
|
||||||
// The unique identifier for the library section.
|
// The unique identifier for the library section.
|
||||||
LibrarySectionID int64 `json:"librarySectionID"`
|
LibrarySectionID *int64 `json:"librarySectionID,omitempty"`
|
||||||
// The title of the library section.
|
// The title of the library section.
|
||||||
LibrarySectionTitle string `json:"librarySectionTitle"`
|
LibrarySectionTitle *string `json:"librarySectionTitle,omitempty"`
|
||||||
// The universally unique identifier for the library section.
|
// The universally unique identifier for the library section.
|
||||||
LibrarySectionUUID *string `json:"librarySectionUUID,omitempty"`
|
LibrarySectionUUID *string `json:"librarySectionUUID,omitempty"`
|
||||||
// The prefix used for media tag resource paths.
|
// The prefix used for media tag resource paths.
|
||||||
@@ -2445,16 +2439,16 @@ func (o *GetMediaMetaDataMediaContainer) GetIdentifier() string {
|
|||||||
return o.Identifier
|
return o.Identifier
|
||||||
}
|
}
|
||||||
|
|
||||||
func (o *GetMediaMetaDataMediaContainer) GetLibrarySectionID() int64 {
|
func (o *GetMediaMetaDataMediaContainer) GetLibrarySectionID() *int64 {
|
||||||
if o == nil {
|
if o == nil {
|
||||||
return 0
|
return nil
|
||||||
}
|
}
|
||||||
return o.LibrarySectionID
|
return o.LibrarySectionID
|
||||||
}
|
}
|
||||||
|
|
||||||
func (o *GetMediaMetaDataMediaContainer) GetLibrarySectionTitle() string {
|
func (o *GetMediaMetaDataMediaContainer) GetLibrarySectionTitle() *string {
|
||||||
if o == nil {
|
if o == nil {
|
||||||
return ""
|
return nil
|
||||||
}
|
}
|
||||||
return o.LibrarySectionTitle
|
return o.LibrarySectionTitle
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -814,31 +814,15 @@ func (e *HasThumbnail) UnmarshalJSON(data []byte) error {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
// StreamType - Stream type:
|
|
||||||
// - 1 = video
|
|
||||||
// - 2 = audio
|
|
||||||
// - 3 = subtitle
|
|
||||||
type StreamType int
|
|
||||||
|
|
||||||
const (
|
|
||||||
StreamTypeVideo StreamType = 1
|
|
||||||
StreamTypeAudio StreamType = 2
|
|
||||||
StreamTypeSubtitle StreamType = 3
|
|
||||||
)
|
|
||||||
|
|
||||||
func (e StreamType) ToPointer() *StreamType {
|
|
||||||
return &e
|
|
||||||
}
|
|
||||||
|
|
||||||
type Stream struct {
|
type Stream struct {
|
||||||
// Unique stream identifier.
|
// Unique stream identifier.
|
||||||
ID int64 `json:"id"`
|
ID int64 `json:"id"`
|
||||||
// Stream type:
|
// Stream type:
|
||||||
// - 1 = video
|
// - VIDEO = 1
|
||||||
// - 2 = audio
|
// - AUDIO = 2
|
||||||
// - 3 = subtitle
|
// - SUBTITLE = 3
|
||||||
//
|
//
|
||||||
StreamType StreamType `json:"streamType"`
|
streamType int64 `const:"1" json:"streamType"`
|
||||||
// Format of the stream (e.g., srt).
|
// Format of the stream (e.g., srt).
|
||||||
Format *string `json:"format,omitempty"`
|
Format *string `json:"format,omitempty"`
|
||||||
// Indicates if this stream is default.
|
// Indicates if this stream is default.
|
||||||
@@ -934,6 +918,17 @@ type Stream struct {
|
|||||||
Title *string `json:"title,omitempty"`
|
Title *string `json:"title,omitempty"`
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func (s Stream) MarshalJSON() ([]byte, error) {
|
||||||
|
return utils.MarshalJSON(s, "", false)
|
||||||
|
}
|
||||||
|
|
||||||
|
func (s *Stream) UnmarshalJSON(data []byte) error {
|
||||||
|
if err := utils.UnmarshalJSON(data, &s, "", false, false); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
func (o *Stream) GetID() int64 {
|
func (o *Stream) GetID() int64 {
|
||||||
if o == nil {
|
if o == nil {
|
||||||
return 0
|
return 0
|
||||||
@@ -941,11 +936,8 @@ func (o *Stream) GetID() int64 {
|
|||||||
return o.ID
|
return o.ID
|
||||||
}
|
}
|
||||||
|
|
||||||
func (o *Stream) GetStreamType() StreamType {
|
func (o *Stream) GetStreamType() int64 {
|
||||||
if o == nil {
|
return 1
|
||||||
return StreamType(0)
|
|
||||||
}
|
|
||||||
return o.StreamType
|
|
||||||
}
|
}
|
||||||
|
|
||||||
func (o *Stream) GetFormat() *string {
|
func (o *Stream) GetFormat() *string {
|
||||||
@@ -2020,15 +2012,15 @@ type GetRecentlyAddedMetadata struct {
|
|||||||
// The number of leaf items (end nodes) under this media item.
|
// The number of leaf items (end nodes) under this media item.
|
||||||
LeafCount *int `json:"leafCount,omitempty"`
|
LeafCount *int `json:"leafCount,omitempty"`
|
||||||
// The identifier for the library section.
|
// The identifier for the library section.
|
||||||
LibrarySectionID int64 `json:"librarySectionID"`
|
LibrarySectionID *int64 `json:"librarySectionID,omitempty"`
|
||||||
// The key corresponding to the library section.
|
// The key corresponding to the library section.
|
||||||
LibrarySectionKey string `json:"librarySectionKey"`
|
LibrarySectionKey *string `json:"librarySectionKey,omitempty"`
|
||||||
// The title of the library section.
|
// The title of the library section.
|
||||||
LibrarySectionTitle string `json:"librarySectionTitle"`
|
LibrarySectionTitle *string `json:"librarySectionTitle,omitempty"`
|
||||||
// The original title of the media item (if different).
|
// The original title of the media item (if different).
|
||||||
OriginalTitle *string `json:"originalTitle,omitempty"`
|
OriginalTitle *string `json:"originalTitle,omitempty"`
|
||||||
// The original release date of the media item.
|
// The original release date of the media item.
|
||||||
OriginallyAvailableAt types.Date `json:"originallyAvailableAt"`
|
OriginallyAvailableAt *types.Date `json:"originallyAvailableAt,omitempty"`
|
||||||
// The GUID of the parent media item.
|
// The GUID of the parent media item.
|
||||||
ParentGUID *string `json:"parentGuid,omitempty"`
|
ParentGUID *string `json:"parentGuid,omitempty"`
|
||||||
// The index position of the parent media item.
|
// The index position of the parent media item.
|
||||||
@@ -2287,23 +2279,23 @@ func (o *GetRecentlyAddedMetadata) GetLeafCount() *int {
|
|||||||
return o.LeafCount
|
return o.LeafCount
|
||||||
}
|
}
|
||||||
|
|
||||||
func (o *GetRecentlyAddedMetadata) GetLibrarySectionID() int64 {
|
func (o *GetRecentlyAddedMetadata) GetLibrarySectionID() *int64 {
|
||||||
if o == nil {
|
if o == nil {
|
||||||
return 0
|
return nil
|
||||||
}
|
}
|
||||||
return o.LibrarySectionID
|
return o.LibrarySectionID
|
||||||
}
|
}
|
||||||
|
|
||||||
func (o *GetRecentlyAddedMetadata) GetLibrarySectionKey() string {
|
func (o *GetRecentlyAddedMetadata) GetLibrarySectionKey() *string {
|
||||||
if o == nil {
|
if o == nil {
|
||||||
return ""
|
return nil
|
||||||
}
|
}
|
||||||
return o.LibrarySectionKey
|
return o.LibrarySectionKey
|
||||||
}
|
}
|
||||||
|
|
||||||
func (o *GetRecentlyAddedMetadata) GetLibrarySectionTitle() string {
|
func (o *GetRecentlyAddedMetadata) GetLibrarySectionTitle() *string {
|
||||||
if o == nil {
|
if o == nil {
|
||||||
return ""
|
return nil
|
||||||
}
|
}
|
||||||
return o.LibrarySectionTitle
|
return o.LibrarySectionTitle
|
||||||
}
|
}
|
||||||
@@ -2315,9 +2307,9 @@ func (o *GetRecentlyAddedMetadata) GetOriginalTitle() *string {
|
|||||||
return o.OriginalTitle
|
return o.OriginalTitle
|
||||||
}
|
}
|
||||||
|
|
||||||
func (o *GetRecentlyAddedMetadata) GetOriginallyAvailableAt() types.Date {
|
func (o *GetRecentlyAddedMetadata) GetOriginallyAvailableAt() *types.Date {
|
||||||
if o == nil {
|
if o == nil {
|
||||||
return types.Date{}
|
return nil
|
||||||
}
|
}
|
||||||
return o.OriginallyAvailableAt
|
return o.OriginallyAvailableAt
|
||||||
}
|
}
|
||||||
|
|||||||
File diff suppressed because it is too large
Load Diff
@@ -2,7 +2,7 @@
|
|||||||
|
|
||||||
package plexgo
|
package plexgo
|
||||||
|
|
||||||
// Generated from OpenAPI doc version 0.0.3 and generator version 2.620.2
|
// Generated from OpenAPI doc version 0.0.3 and generator version 2.623.4
|
||||||
|
|
||||||
import (
|
import (
|
||||||
"context"
|
"context"
|
||||||
@@ -277,9 +277,9 @@ func WithTimeout(timeout time.Duration) SDKOption {
|
|||||||
// New creates a new instance of the SDK with the provided options
|
// New creates a new instance of the SDK with the provided options
|
||||||
func New(opts ...SDKOption) *PlexAPI {
|
func New(opts ...SDKOption) *PlexAPI {
|
||||||
sdk := &PlexAPI{
|
sdk := &PlexAPI{
|
||||||
SDKVersion: "0.22.0",
|
SDKVersion: "0.23.0",
|
||||||
sdkConfiguration: config.SDKConfiguration{
|
sdkConfiguration: config.SDKConfiguration{
|
||||||
UserAgent: "speakeasy-sdk/go 0.22.0 2.620.2 0.0.3 github.com/LukeHagar/plexgo",
|
UserAgent: "speakeasy-sdk/go 0.23.0 2.623.4 0.0.3 github.com/LukeHagar/plexgo",
|
||||||
ServerList: ServerList,
|
ServerList: ServerList,
|
||||||
ServerVariables: []map[string]string{
|
ServerVariables: []map[string]string{
|
||||||
{
|
{
|
||||||
|
|||||||
Reference in New Issue
Block a user