Class Season

Represents a single Show Season (including all episodes).

Hierarchy

Video
- Season

Constructors

constructor

new Season(
    server: PlexServer,
    data: any,
    initpath?: string,
    parent?: PlexObject,
): Season
Parameters
- server: PlexServer
- data: any
- Optionalinitpath: string
- Optionalparent: PlexObject
Returns Season
Inherited from Video.constructor
- Defined in src/base/plexObject.ts:23

Properties

_INCLUDES

_INCLUDES: {
    checkFiles: number;
    includeAllConcerts: number;
    includeBandwidths: number;
    includeChapters: number;
    includeChildren: number;
    includeConcerts: number;
    includeExternalMedia: number;
    includeExtras: number;
    includeFields: string;
    includeGeolocation: number;
    includeLoudnessRamps: number;
    includeMarkers: number;
    includeOnDeck: number;
    includePopularLeaves: number;
    includePreferences: number;
    includeRelated: number;
    includeRelatedCount: number;
    includeReviews: number;
    includeStations: number;
} = ...

addedAt

addedAt: Date

Datetime this item was added to the library.

`Optional`art

art?: string

`Optional`artBlurHash

artBlurHash?: string

BlurHash string for artwork image.

`Optional`grandparentArt

grandparentArt?: string

index

index: number

Season number

key

key: string

plex relative url

`Optional`lastViewedAt

lastViewedAt?: Date

Datetime item was last accessed.

leafCount

leafCount: number

Number of episodes in season.

`Optional`librarySectionID

librarySectionID?: number

listType

listType: "video" = ...

Hardcoded as 'video' (useful for search filters).

METADATA_TYPE

METADATA_TYPE: string = 'episode'

`Optional` `Readonly`parent

parent?: WeakRef<any>

WeakRef to the parent object that this object is built from.

parentKey

parentKey: string

Key to this season

parentRatingKey

parentRatingKey: string

Rating key of the show this season belongs to

parentTitle

parentTitle: string

Show title

players

players: any

(:class:~plexapi.client.PlexClient): Client objects playing this item (for active sessions).

`Optional`playlistItemID

playlistItemID?: number

(int): Playlist item ID (only populated for :class:~plexapi.playlist.Playlist items).

`Optional`ratingKey

ratingKey?: string

`Readonly`server

server: PlexServer

session

session: any

(:class:~plexapi.media.Session): Session object, for a playing media file.

sessionKey

sessionKey: any

(int): Active session key.

summary

summary: string

Summary of the artist, track, or album.

TAG

TAG: string = 'Directory'

thumb

thumb: string

URL to thumbnail image.

`Optional`thumbBlurHash

thumbBlurHash?: string

BlurHash string for thumbnail image.

`Optional`title

title?: string

`Optional`titleSort

titleSort?: string

Title to use when sorting (defaults to title).

transcodeSessions

transcodeSessions: any

(:class:~plexapi.media.TranscodeSession): Transcode Session object if item is being transcoded (None otherwise).

`Optional`type

type?: string

TYPE

TYPE: string = 'season'

`Optional`updatedAt

updatedAt?: Date

Datetime this item was updated.

usernames

usernames: any

(str): Username of the person playing this item (for active sessions).

`Optional`viewCount

viewCount?: number

Count of times this item was accessed.

viewedAt

viewedAt: any

(datetime): Datetime item was last viewed (history).

viewedLeafCount

viewedLeafCount: number

Number of watched episodes in season

`Optional`year

year?: number

`Static`TAG

TAG: string = null

xml element tag

`Static`TYPE

TYPE: string = null

xml element type

Accessors

artUrl

get artUrl(): URL
Returns URL
Inherited from Video.artUrl
- Defined in src/video.ts:74

isFullObject

get isFullObject(): boolean
Retruns True if this is already a full object. A full object means all attributes were populated from the api path representing only this item. For example, the search result for a movie often only contain a portion of the attributes a full object (main url) for that movie would contain.

Returns boolean
Inherited from Video.isFullObject
- Defined in src/base/partialPlexObject.ts:85

isWatched

get isWatched(): boolean
Returns season number

Returns boolean
Overrides Video.isWatched
- Defined in src/video.ts:440

seasonNumber

get seasonNumber(): number
Returns season number

Returns number
- Defined in src/video.ts:435

thumbUrl

get thumbUrl(): URL
Return the first first thumbnail url starting on the most specific thumbnail for that item.

Returns URL
Inherited from Video.thumbUrl
- Defined in src/video.ts:69

Methods

addCollection

addCollection(collections: string[]): Promise<void>
Add a collection(s).
Parameters
- collections: string[]
Returns Promise<void>
Inherited from Video.addCollection
- Defined in src/base/partialPlexObject.ts:215

addGenre

addGenre(genres: string[]): Promise<void>
Add a genre(s).
Parameters
- genres: string[]
Returns Promise<void>
Inherited from Video.addGenre
- Defined in src/base/partialPlexObject.ts:235

addLabel

addLabel(labels: string[]): Promise<void>
Add a label(s).
Parameters
- labels: string[]
Returns Promise<void>
Inherited from Video.addLabel
- Defined in src/base/partialPlexObject.ts:225

analyze

analyze(): Promise<void>
Tell Plex Media Server to performs analysis on it this item to gather information. Analysis includes:
- Gather Media Properties: All of the media you add to a Library has properties that are useful to know–whether it's a video file, a music track, or one of your photos (container, codec, resolution, etc).
- Generate Default Artwork: Artwork will automatically be grabbed from a video file. A background image will be pulled out as well as a smaller image to be used for poster/thumbnail type purposes.
- Generate Video Preview Thumbnails: Video preview thumbnails are created, if you have that feature enabled. Video preview thumbnails allow graphical seeking in some Apps. It's also used in the Plex Web App Now Playing screen to show a graphical representation of where playback is. Video preview thumbnails creation is a CPU-intensive process akin to transcoding the file.
- Generate intro video markers: Detects show intros, exposing the 'Skip Intro' button in clients.
Returns Promise<void>
Inherited from Video.analyze
- Defined in src/base/partialPlexObject.ts:58

delete

delete(): Promise<any>
Delete a media element. This has to be enabled under settings > server > library in plex webui.

Returns Promise<any>
Inherited from Video.delete
- Defined in src/base/partialPlexObject.ts:210

edit

edit(changeObj: Record<string, string | number>): Promise<void>
Edit an object.
Parameters
- changeObj: Record<string, string | number>
  Obj of settings to edit. Example: {'type': 1, 'id': movie.ratingKey, 'title.value': 'New Title', 'collection[0].tag.tag': 'Super', 'collection.locked': 0}
Returns Promise<void>
Inherited from Video.edit
- Defined in src/base/partialPlexObject.ts:258

episodes

episodes(query?: Record<string, string | number>): Promise<Episode[]>
Parameters
- Optionalquery: Record<string, string | number>
Returns Promise<Episode[]>
a list of :class:~plexapi.video.Episode objects.
- Defined in src/video.ts:447

extras

extras(): Promise<Extra[]>
Returns Promise<Extra[]>
Inherited from Video.extras
- Defined in src/video.ts:103

fixMatch

fixMatch(
    searchResult?: SearchResult,
    auto?: boolean,
    agent?: string,
): Promise<void>
Use match result to update show metadata.
Parameters
- OptionalsearchResult: SearchResult
  Search result
- auto: boolean = false
  True uses first match from matches, False allows user to provide the match
- agent: string = ''
  (str): Agent name to be used (imdb, thetvdb, themoviedb, etc.)
Returns Promise<void>
See
PartialPlexObject.matches
Inherited from Video.fixMatch
- Defined in src/base/partialPlexObject.ts:95

getWebURL

getWebURL(base?: string): string
Parameters
- Optionalbase: string
Returns string
Inherited from Video.getWebURL
- Defined in src/base/partialPlexObject.ts:244

history

history(maxresults?: number, mindate?: Date): Promise<HistoryMetadatum[]>
Get Play History for a media item.
Parameters
- maxresults: number = 9999999
  Only return the specified number of results (optional).
- Optionalmindate: Date
  Min datetime to return results from.
Returns Promise<HistoryMetadatum[]>
Inherited from Video.history
- Defined in src/base/partialPlexObject.ts:199

isChildOf

isChildOf(cls: any): boolean
Returns True if this object is a child of the given class.
Parameters
- cls: any
Returns boolean
Inherited from Video.isChildOf
- Defined in src/base/plexObject.ts:63

markUnwatched

markUnwatched(): Promise<void>
Mark video as unwatched.

Returns Promise<void>
Inherited from Video.markUnwatched
- Defined in src/video.ts:91

markWatched

markWatched(): Promise<void>
Mark video as watched.

Returns Promise<void>
Inherited from Video.markWatched
- Defined in src/video.ts:82

matches

matches(
    agent?: string,
    title?: string,
    year?: string,
    language?: string,
): Promise<SearchResult[]>
Parameters
- Optionalagent: string
  Agent name to be used (imdb, thetvdb, themoviedb, etc.)
- Optionaltitle: string
  Title of item to search for
- Optionalyear: string
  Year of item to search in
- Optionallanguage: string
  Language of item to search in
  
  Examples:
  
  video.matches()
  
  video.matches(title="something", year=2020)
  
  video.matches(title="something")
  
  video.matches(year=2020)
  
  video.matches(title="something", year="")
  
  video.matches(title="", year=2020)
  
  video.matches(title="", year="")
  
  The default behaviour in Plex Web = no params in plexapi
  
  Both title and year specified by user
  
  Year automatically filled in
  
  Title automatically filled in
  
  Explicitly searches for title with blank year
  
  Explicitly searches for blank title with year
  
  I don't know what the user is thinking... return the same result as 1
  
  For 2 to 7, the agent and language is automatically filled in
Returns Promise<SearchResult[]>
Inherited from Video.matches
- Defined in src/base/partialPlexObject.ts:139

posters

posters(): Promise<Poster[]>
Returns list of available Poster objects.

Returns Promise<Poster[]>
Inherited from Video.posters
- Defined in src/video.ts:117

rate

rate(rate: number): Promise<void>
Parameters
- rate: number
Returns Promise<void>
Inherited from Video.rate
- Defined in src/video.ts:97

refresh

refresh(): Promise<void>
Refreshing a Library or individual item causes the metadata for the item to be refreshed, even if it already has metadata. You can think of refreshing as "update metadata for the requested item even if it already has some". You should refresh a Library or individual item if:

Returns Promise<void>
Inherited from Video.refresh
- Defined in src/base/plexObject.ts:55

reload

reload(ekey?: string, args?: any): Promise<void>
load full data / reload the data for this object from this.key.
Parameters
- Optionalekey: string
- Optionalargs: any
Returns Promise<void>
Inherited from Video.reload
- Defined in src/base/partialPlexObject.ts:66

removeCollection

removeCollection(collections: string[]): Promise<void>
Remove a collection(s).
Parameters
- collections: string[]
Returns Promise<void>
Inherited from Video.removeCollection
- Defined in src/base/partialPlexObject.ts:220

removeGenre

removeGenre(genres: string[]): Promise<void>
Remove a genre(s).
Parameters
- genres: string[]
Returns Promise<void>
Inherited from Video.removeGenre
- Defined in src/base/partialPlexObject.ts:240

removeLabel

removeLabel(labels: string[]): Promise<void>
Remove a label(s).
Parameters
- labels: string[]
Returns Promise<void>
Inherited from Video.removeLabel
- Defined in src/base/partialPlexObject.ts:230

section

section(): Promise<Section>
Returns Promise<Section>
Inherited from Video.section
- Defined in src/base/partialPlexObject.ts:203

setPoster

setPoster(poster: Poster): Promise<Season>
Set the poster for a Plex object.
Parameters
- poster: Poster
  The poster object to select.
Returns Promise<Season>
Inherited from Video.setPoster
- Defined in src/video.ts:130

unmatch

unmatch(): Promise<any>
Unmatches metadata match from object.

Returns Promise<any>
Inherited from Video.unmatch
- Defined in src/base/partialPlexObject.ts:189

uploadPoster

uploadPoster(url?: string, file?: Uint8Array): Promise<void>
I haven't tested this yet. It may not work.
Parameters
- Optionalurl: string
- Optionalfile: Uint8Array
Returns Promise<void>
Inherited from Video.uploadPoster
- Defined in src/video.ts:138

Class Season

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns Season

Properties

_INCLUDES

addedAt

Optionalart

OptionalartBlurHash

OptionalgrandparentArt

index

key

OptionallastViewedAt

leafCount

OptionallibrarySectionID

listType

METADATA_TYPE

Optional Readonlyparent

parentKey

parentRatingKey

parentTitle

players

OptionalplaylistItemID

OptionalratingKey

Readonlyserver

session

sessionKey

summary

TAG

thumb

OptionalthumbBlurHash

Optionaltitle

OptionaltitleSort

transcodeSessions

Optionaltype

TYPE

OptionalupdatedAt

usernames

OptionalviewCount

viewedAt

viewedLeafCount

Optionalyear

StaticTAG

StaticTYPE

Accessors

artUrl

Returns URL

isFullObject

Returns boolean

isWatched

Returns boolean

seasonNumber

Returns number

thumbUrl

Returns URL

Methods

addCollection

Parameters

Returns Promise<void>

addGenre

Parameters

Returns Promise<void>

addLabel

Parameters

Returns Promise<void>

analyze

Returns Promise<void>

delete

Returns Promise<any>

edit

Parameters

Returns Promise<void>

episodes

`Optional`art

`Optional`artBlurHash

`Optional`grandparentArt

`Optional`lastViewedAt

`Optional`librarySectionID

`Optional` `Readonly`parent

`Optional`playlistItemID

`Optional`ratingKey

`Readonly`server

`Optional`thumbBlurHash

`Optional`title

`Optional`titleSort

`Optional`type

`Optional`updatedAt

`Optional`viewCount

`Optional`year

`Static`TAG

`Static`TYPE