Class Photo

Hierarchy

Playable
- Photo

Index

Constructors

constructor

Accessors

artwork isFullObject locations

Constructors

constructor

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

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;
} = ...

`Optional`addedAt

addedAt?: Date

`Optional`createdAtAccuracy

createdAtAccuracy?: string

`Optional`createdAtTZOffset

createdAtTZOffset?: number

fields

fields: Field[]

`Optional`guid

guid?: string

images

images: Image[]

`Optional`index

index?: number

key

key: string

plex relative url

`Optional`lastRatedAt

lastRatedAt?: Date

`Optional`librarySectionID

librarySectionID?: number

`Optional`librarySectionKey

librarySectionKey?: string

`Optional`librarySectionTitle

librarySectionTitle?: string

listType

listType: "photo" = ...

media

media: PhotoMedia[]

`Optional`originallyAvailableAt

originallyAvailableAt?: Date

`Optional` `Readonly`parent

parent?: WeakRef<any>

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

`Optional`parentGuid

parentGuid?: string

`Optional`parentIndex

parentIndex?: number

`Optional`parentKey

parentKey?: string

`Optional`parentRatingKey

parentRatingKey?: number

`Optional`parentThumb

parentThumb?: string

`Optional`parentTitle

parentTitle?: string

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`playQueueItemID

playQueueItemID?: number

Queue-local item ID (only populated for PlayQueue 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.

`Optional`sourceURI

sourceURI?: string

`Optional`summary

summary?: string

`Optional`thumb

thumb?: string

`Optional`title

title?: string

`Optional`titleSort

titleSort?: string

transcodeSessions

transcodeSessions: any

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

`Optional`type

type?: string

`Optional`updatedAt

updatedAt?: Date

usernames

usernames: any

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

`Optional`userRating

userRating?: number

viewedAt

viewedAt: any

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

`Optional`year

year?: number

`Static` `Readonly`METADATA_TYPE

METADATA_TYPE: "photo" = 'photo'

`Static`TAG

TAG: string = 'Photo'

xml element tag

`Static`TYPE

TYPE: string = 'photo'

xml element type

Accessors

artwork

get artwork(): ArtworkManager
Typed poster, background, logo, and square-art management.

Returns ArtworkManager
Inherited from Playable.artwork
- Defined in src/base/partialPlexObject.ts:42

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

locations

get locations(): string[]
Returns string[]
- Defined in src/photo.ts:288

Methods

addCollection

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

addGenre

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

addLabel

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

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

audioStreams

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

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

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 Playable.createPlayQueue
- Defined in src/base/playable.ts:38

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

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

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 Playable.editContentRating
- Defined in src/base/partialPlexObject.ts:333

editOriginallyAvailableAt

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

editSortTitle

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

editStudio

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

editSummary

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

editTitle

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

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 Playable.fixMatch
- Defined in src/base/partialPlexObject.ts:101

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 Playable.getStreamURL
- Defined in src/base/playable.ts:46

getWebURL

getWebURL(__namedParameters?: { base?: string }): string
Parameters
- __namedParameters: { base?: string } = {}
Returns string
Overrides Playable.getWebURL
- Defined in src/photo.ts:324

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 Playable.history
- Defined in src/base/partialPlexObject.ts:212

isChildOf

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

iterParts

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

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

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 Playable.matches
- Defined in src/base/partialPlexObject.ts:149

originalUrl

originalUrl(): string
Returns the first authenticated original file URL, when Plex exposes one. This does not download files or write to disk.

Returns string
- Defined in src/photo.ts:311

originalUrls

originalUrls(): string[]
Returns authenticated URLs for the original photo files exposed by Plex. This does not download files or write to disk.

Returns string[]
- Defined in src/photo.ts:299

photoalbum

photoalbum(): Promise<Photoalbum>
Returns Promise<Photoalbum>
- Defined in src/photo.ts:315

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 Playable.refresh
- Defined in src/base/plexObject.ts:53

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

removeCollection

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

removeGenre

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

removeLabel

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

section

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

subtitleStreams

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

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

unmatch

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

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

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 Playable.updateProgress
- Defined in src/base/playable.ts:113

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 Playable.updateTimeline
- Defined in src/base/playable.ts:127

videoStreams

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

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

Class Photo

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns Photo

Properties

_INCLUDES

OptionaladdedAt

OptionalcreatedAtAccuracy

OptionalcreatedAtTZOffset

fields

Optionalguid

images

Optionalindex

key

OptionallastRatedAt

OptionallibrarySectionID

OptionallibrarySectionKey

OptionallibrarySectionTitle

listType

media

OptionaloriginallyAvailableAt

Optional Readonlyparent

OptionalparentGuid

OptionalparentIndex

OptionalparentKey

OptionalparentRatingKey

OptionalparentThumb

OptionalparentTitle

players

OptionalplaylistItemID

OptionalplayQueueItemID

OptionalratingKey

Readonlyserver

session

sessionKey

OptionalsourceURI

Optionalsummary

tags

Optionalthumb

Optionaltitle

OptionaltitleSort

transcodeSessions

Optionaltype

OptionalupdatedAt

usernames

OptionaluserRating

viewedAt

Optionalyear

Static ReadonlyMETADATA_TYPE

StaticTAG

StaticTYPE

Accessors

artwork

Returns ArtworkManager

isFullObject

Returns boolean

locations

Returns string[]

Methods

addCollection

Parameters

Returns Promise<void>

addGenre

Parameters

Returns Promise<void>

addLabel

Parameters

Returns Promise<void>

analyze

Returns Promise<void>

audioStreams

Returns AudioStream[]

createPlayQueue

`Optional`addedAt

`Optional`createdAtAccuracy

`Optional`createdAtTZOffset

`Optional`guid

`Optional`index

`Optional`lastRatedAt

`Optional`librarySectionID

`Optional`librarySectionKey

`Optional`librarySectionTitle

`Optional`originallyAvailableAt

`Optional` `Readonly`parent

`Optional`parentGuid

`Optional`parentIndex

`Optional`parentKey

`Optional`parentRatingKey

`Optional`parentThumb

`Optional`parentTitle

`Optional`playlistItemID

`Optional`playQueueItemID

`Optional`ratingKey

`Readonly`server

`Optional`sourceURI

`Optional`summary

`Optional`thumb

`Optional`title

`Optional`titleSort

`Optional`type

`Optional`updatedAt

`Optional`userRating

`Optional`year

`Static` `Readonly`METADATA_TYPE

`Static`TAG

`Static`TYPE