Class Extra

Represents a single Extra (trailer, behindTheScenes, etc).

Hierarchy (View Summary)

Clip
- Extra

Index

Constructors

constructor

Accessors

artUrl isFullObject isWatched thumbUrl

Constructors

constructor

new Extra(
    server: PlexServer,
    data: any,
    initpath?: string,
    parent?: PlexObject,
): Extra
Parameters
- server: PlexServer
- data: any
- Optionalinitpath: string
- Optionalparent: PlexObject
Returns Extra
Inherited from Clip.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

key

key: string

plex relative url

`Optional`lastViewedAt

lastViewedAt?: Date

Datetime item was last accessed.

`Optional`librarySectionID

librarySectionID?: number

listType

listType: "video" = ...

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

METADATA_TYPE

METADATA_TYPE: string = 'clip'

`Optional` `Readonly`parent

parent?: WeakRef<any>

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

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.

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 = 'clip'

`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).

`Optional`year

year?: number

`Static`TAG

TAG: string = 'Video'

xml element tag

`Static`TYPE

TYPE: string = null

xml element type

Accessors

artUrl

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

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 Clip.isFullObject
- Defined in src/base/partialPlexObject.ts:87

isWatched

get isWatched(): boolean
Returns True if this video is watched.

Returns boolean
Inherited from Clip.isWatched
- Defined in src/video.ts:55

thumbUrl

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

Returns URL
Inherited from Clip.thumbUrl
- Defined in src/video.ts:67

Methods

addCollection

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

addGenre

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

addLabel

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

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 Clip.analyze
- Defined in src/base/partialPlexObject.ts:60

audioStreams

audioStreams(): AudioStream[]
Returns all audio streams from all parts.

Returns AudioStream[]
Inherited from Clip.audioStreams
- Defined in src/base/playable.ts:80

createPlayQueue

createPlayQueue(options?: CreatePlayQueueOptions): Promise<PlayQueue>
Returns a new PlayQueue from this media item.
Parameters
- options: CreatePlayQueueOptions = {}
  Options for creating the PlayQueue
Returns Promise<PlayQueue>
New PlayQueue instance
Inherited from Clip.createPlayQueue
- Defined in src/base/playable.ts:36

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 Clip.delete
- Defined in src/base/partialPlexObject.ts:217

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 Clip.edit
- Defined in src/base/partialPlexObject.ts:265

editContentRating

editContentRating(contentRating: string): Promise<void>
Set the content rating (e.g. PG-13, R, TV-MA).
Parameters
- contentRating: string
Returns Promise<void>
Inherited from Clip.editContentRating
- Defined in src/base/partialPlexObject.ts:312

editOriginallyAvailableAt

editOriginallyAvailableAt(date: string): Promise<void>
Set the originally available at date (release date).
Parameters
- date: string
Returns Promise<void>
Inherited from Clip.editOriginallyAvailableAt
- Defined in src/base/partialPlexObject.ts:322

editSortTitle

editSortTitle(sortTitle: string): Promise<void>
Set the sort title.
Parameters
- sortTitle: string
Returns Promise<void>
Inherited from Clip.editSortTitle
- Defined in src/base/partialPlexObject.ts:302

editStudio

editStudio(studio: string): Promise<void>
Set the studio.
Parameters
- studio: string
Returns Promise<void>
Inherited from Clip.editStudio
- Defined in src/base/partialPlexObject.ts:317

editSummary

editSummary(summary: string): Promise<void>
Set the summary.
Parameters
- summary: string
Returns Promise<void>
Inherited from Clip.editSummary
- Defined in src/base/partialPlexObject.ts:307

editTitle

editTitle(title: string): Promise<void>
Set the title.
Parameters
- title: string
Returns Promise<void>
Inherited from Clip.editTitle
- Defined in src/base/partialPlexObject.ts:297

extras

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

fixMatch

fixMatch(
    options?: {
        agent?: string;
        auto?: boolean;
        searchResult?: SearchResult;
    },
): Promise<void>
Use match result to update show metadata.
Parameters
- options: { agent?: string; auto?: boolean; searchResult?: SearchResult } = {}
  Match options.
Returns Promise<void>
Inherited from Clip.fixMatch
- Defined in src/base/partialPlexObject.ts:95

getStreamURL

getStreamURL(params?: Record<string, string>): string
Returns a stream URL that can be used for playback.
Parameters
- params: Record<string, string> = {}
  Additional URL parameters for transcoding options.
Returns string
Inherited from Clip.getStreamURL
- Defined in src/base/playable.ts:44

getWebURL

getWebURL(__namedParameters?: { base?: string }): string
Parameters
- __namedParameters: { base?: string } = {}
Returns string
Inherited from Clip.getWebURL
- Defined in src/base/partialPlexObject.ts:251

history

history(options?: Omit<HistoryOptions, "ratingKey">): Promise<HistoryResult[]>
Get Play History for a media item.
Parameters
- options: Omit<HistoryOptions, "ratingKey"> = {}
  Filter and paging options.
Returns Promise<HistoryResult[]>
Inherited from Clip.history
- Defined in src/base/partialPlexObject.ts:206

isChildOf

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

iterParts

iterParts(): MediaPart[]
Returns all MediaPart objects across all Media entries.

Returns MediaPart[]
Inherited from Clip.iterParts
- Defined in src/base/playable.ts:72

markUnwatched

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

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

markWatched

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

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

matches

matches(
    options?: {
        agent?: string;
        language?: string;
        title?: string;
        year?: string;
    },
): Promise<SearchResult[]>
Parameters
- options: { agent?: string; language?: string; title?: string; year?: string } = {}
  Match options.
  
  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 Clip.matches
- Defined in src/base/partialPlexObject.ts:143

posters

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

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

rate

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

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 Clip.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 Clip.reload
- Defined in src/base/partialPlexObject.ts:68

removeCollection

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

removeGenre

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

removeLabel

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

section

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

setPoster

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

subtitleStreams

subtitleStreams(): SubtitleStream[]
Returns all subtitle streams from all parts.

Returns SubtitleStream[]
Inherited from Clip.subtitleStreams
- Defined in src/base/playable.ts:87

unmatch

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

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

updateProgress

updateProgress(
time: number,
state?: "playing" | "paused" | "stopped",
): Promise<void>
Update the play progress for this media item.
Parameters
- time: number
  Current playback time in milliseconds.
- state: "playing" | "paused" | "stopped" = 'stopped'
  Playback state ('playing', 'paused', 'stopped'). Default 'stopped'.
Returns Promise<void>
Inherited from Clip.updateProgress
- Defined in src/base/playable.ts:111

updateTimeline

updateTimeline(
    time: number,
    state: "playing" | "paused" | "stopped",
    duration: number,
): Promise<void>
Update the timeline for this media item.
Parameters
- time: number
  Current playback time in milliseconds.
- state: "playing" | "paused" | "stopped"
  Playback state ('playing', 'paused', 'stopped').
- duration: number
  Total duration in milliseconds.
Returns Promise<void>
Inherited from Clip.updateTimeline
- Defined in src/base/playable.ts:125

uploadPoster

uploadPoster(
__namedParameters?: { file?: Uint8Array; url?: string },
): Promise<void>
I haven't tested this yet. It may not work.
Parameters
- __namedParameters: { file?: Uint8Array; url?: string } = {}
Returns Promise<void>
Inherited from Clip.uploadPoster
- Defined in src/video.ts:136

videoStreams

videoStreams(): MediaPartStream[]
Returns all video streams from all media (first part of each).

Returns MediaPartStream[]
Inherited from Clip.videoStreams
- Defined in src/base/playable.ts:94

Class Extra

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns Extra

Properties

_INCLUDES

addedAt

Optionalart

OptionalartBlurHash

OptionalgrandparentArt

key

OptionallastViewedAt

OptionallibrarySectionID

listType

METADATA_TYPE

Optional Readonlyparent

players

OptionalplaylistItemID

OptionalratingKey

Readonlyserver

session

sessionKey

summary

thumb

OptionalthumbBlurHash

Optionaltitle

OptionaltitleSort

transcodeSessions

Optionaltype

TYPE

OptionalupdatedAt

usernames

OptionalviewCount

viewedAt

Optionalyear

StaticTAG

StaticTYPE

Accessors

artUrl

Returns URL

isFullObject

Returns boolean

isWatched

Returns boolean

thumbUrl

Returns URL

Methods

addCollection

Parameters

Returns Promise<void>

addGenre

Parameters

Returns Promise<void>

addLabel

Parameters

Returns Promise<void>

analyze

Returns Promise<void>

audioStreams

Returns AudioStream[]

createPlayQueue

Parameters

Returns Promise<PlayQueue>

delete

Returns Promise<any>

edit

Parameters

Returns Promise<void>

editContentRating

Parameters

Returns Promise<void>

editOriginallyAvailableAt

Parameters

`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