Optionalinitpath: stringOptionalparent: PlexObjectOptionaladdedOptionalartOptionalartOptionaldistanceSonic distance from a seed item, used in sonically similar results.
List of field objects.
OptionalguidList of image objects.
OptionalindexPlex index number (often the track number for tracks).
Plex relative url of this metadata item.
OptionallastOptionallastOptionallibraryOptionallibraryKey of the library section this item belongs to.
OptionallibraryTitle of the library section this item belongs to.
OptionalliveWhether the active session is live TV.
List of mood objects.
OptionalmusicPlex music analysis version (1 indicates sonic analysis complete).
Optional ReadonlyparentWeakRef to the parent object that this object is built from.
OptionalplayerClient currently playing this item.
Clients associated with this active playback.
OptionalplaylistPlaylist item ID, only populated for items loaded from a Playlist.
OptionalplayQueue-local item ID (only populated for PlayQueue items).
OptionalratingReadonlyserverOptionalsessionBandwidth allocation for the active playback, when one exists.
OptionalsessionServer-local key for an active playback session.
Bandwidth allocations associated with this active playback.
OptionalsummaryOptionalthumbOptionalthumbOptionaltitleOptionaltitleTitle used for sorting (defaults to title).
OptionaltranscodeActive transcode associated with this playback, when Plex includes it.
Transcodes associated with this active playback.
OptionaltypeOptionalultraOptionalupdatedOptionaluserAccount currently playing this item.
Usernames associated with this active playback.
OptionaluserUser rating (0.0-10.0).
Count of times the item was played.
OptionalviewedDatetime item was last viewed (history).
OptionalyearStaticMETADATA_Default metadata type for audio sync items.
StaticTAGxml element tag
StaticTYPExml element type
Background art URL with the token, falling back to the artist's art.
Typed poster, background, logo, and square-art management.
Indicates if the audio item has undergone sonic analysis.
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.
Hardcoded list type for filtering.
Path relative to the Plex server data directory, using server-independent separators.
Thumbnail URL with the token, falling back to the album or artist thumbnail.
Add a collection(s).
Add a genre(s).
Add a label(s).
Tell Plex Media Server to performs analysis on it this item to gather information. Analysis includes:
Returns all audio streams from all parts.
Returns a new PlayQueue from this media item.
Options for creating the PlayQueue
New PlayQueue instance
Delete a media element. This has to be enabled under settings > server > library in plex webui.
Stream original media files; consume each body before advancing the iterator.
Edit an object.
Validate values against Plex's advertised preferences before submitting them.
Set the content rating (e.g. PG-13, R, TV-MA).
Edit several typed metadata fields in one request.
Set the originally available at date (release date).
Set the sort title.
Set the studio.
Set the summary.
Edit a server-defined tag, such as genre, collection, country, director, or mood.
Set the title.
Use match result to update show metadata.
Match options.
Returns a stream URL that can be used for playback.
Additional URL parameters for transcoding options.
Get Play History for a media item.
Filter and paging options.
Returns true if this object was built from a parent of the given class.
Whether a loaded field is locked against metadata refreshes.
Returns all MediaPart objects across all Media entries.
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
Set a personal rating from 0 to 10, or clear it with null.
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:
load full data / reload the data for this object from this.key.
Optionalekey: stringOptionalargs: Record<string, number | boolean>Remove a collection(s).
Remove a genre(s).
Remove a label(s).
Fetches a list of sonically similar audio items from the Plex server.
The returned items will be instances of the same class as the current item
(e.g., calling sonicallySimilar on a Track instance returns Track[]).
Optionallimit: number
Maximum number of similar items to return. Server default is 50.
OptionalmaxDistance: number
Maximum sonic distance (0.0 - 1.0) between items. Server default is 0.25.
Optionaloptions: Record<string, string | number>
Optional additional filters to apply to the results.
A promise resolving to an array of sonically similar Audio items.
Returns all subtitle streams from all parts.
Unmatches metadata match from object.
Set the watched progress for this item. Plex ignores progress of 60 seconds or less, use Playable.markUnplayed to clear progress instead.
Report playback progress for this item the way a player would. Duration defaults to the item's own duration.
Build an authenticated server URL for a path such as a media part key.
Returns all video streams from every media part.
Base class for all audio objects including Artist, Album, and Track.