OptionaladdedOptionalartOptionalartOptionalaudienceOptionalchaptersOptionalchapterOptionalcollectionsOptionaldistanceSonic distance from a seed item, used in sonically similar results.
OptionaldurationOptionalfieldsList of field objects.
OptionalgenresOptionalgrandparentOptionalgrandparentOptionalgrandparentOptionalgrandparentOptionalgrandparentOptionalgrandparentOptionalgrandparentOptionalguidOptionalguidsOptionalimagesList of image objects.
OptionalindexPlex index number (often the track number for tracks).
plex relative url
OptionallabelsOptionallastOptionallastOptionallibraryOptionallibraryKey of the library section this item belongs to.
OptionallibraryTitle of the library section this item belongs to.
OptionalmediaOptionalmoodsList of mood objects.
OptionalmusicPlex music analysis version (1 indicates sonic analysis complete).
OptionaloriginalOptional ReadonlyparentWeakRef to the parent object that this object is built from.
OptionalparentOptionalparentOptionalparentOptionalparentOptionalparentOptionalparent(:class:~plexapi.client.PlexClient): Client objects playing this item (for active sessions).
Optionalplaylist(int): Playlist item ID (only populated for :class:~plexapi.playlist.Playlist items).
OptionalprimaryOptionalratingOptionalratingReadonlyserver(:class:~plexapi.media.Session): Session object, for a playing media file.
(int): Active session key.
OptionalskipOptionalsourceOptionalsummaryOptionalthumbOptionalthumbOptionaltitleOptionaltitleTitle used for sorting (defaults to title).
(:class:~plexapi.media.TranscodeSession): Transcode Session object if item is being transcoded (None otherwise).
OptionaltypeOptionalupdated(str): Username of the person playing this item (for active sessions).
OptionaluserUser rating (0.0-10.0).
OptionalviewCount of times the item was played.
(datetime): Datetime item was last viewed (history).
OptionalviewOptionalyearStaticMETADATA_Default metadata type for audio sync items.
StaticTAGxml element tag
StaticTYPExml element type
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.
List of file paths where the track is found on disk.
The track number.
Default title for a new syncItem.
Add a collection(s).
Add a genre(s).
Add a label(s).
Return the track's Album.
Tell Plex Media Server to performs analysis on it this item to gather information. Analysis includes:
Return the track's Artist.
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.
Edit an object.
Obj of settings to edit. Example: {'type': 1, 'id': movie.ratingKey, 'title.value': 'New Title', 'collection[0].tag.tag': 'Super', 'collection.locked': 0}
Set the content rating (e.g. PG-13, R, TV-MA).
Set the originally available at date (release date).
Set the sort title.
Set the studio.
Set the summary.
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.
Returns the Plex Web URL pointing to the album details page for this track.
Get Play History for a media item.
Filter and paging options.
Returns True if this object is a child of the given class.
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
A filename for use in download.
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: anyRemove 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: numberMaximum number of similar items to return. Server default is 50.
OptionalmaxDistance: numberMaximum 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.
Update the play progress for this media item.
Current playback time in milliseconds.
Playback state ('playing', 'paused', 'stopped'). Default 'stopped'.
Update the timeline for this media item.
Current playback time in milliseconds.
Playback state ('playing', 'paused', 'stopped').
Total duration in milliseconds.
Returns the full URL for a given part (like a media stream) relative to the item's key. Includes the authentication token.
The relative path or resource identifier.
The full URL string including the server address and token, or undefined if part is empty.
Returns all video streams from all media (first part of each).
Represents a single Track.