Mirrors/python-plexapi
2
0
Fork 0
mirror of https://github.com/pkkid/python-plexapi synced 2024-11-22 11:43:13 +00:00
Code Issues Projects Releases Packages Wiki Activity

Update docstring from artBlurHash and thumbBlurHash

Browse source
This commit is contained in:
JonnyWong16 2020-11-21 21:25:24 -08:00
parent 9fb3eaf41c
commit f3e9425a2c
No known key found for this signature in database
GPG key ID: B1F1F9807184697A
3 changed files with 9 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
plexapi/audio.py
View file

@ -11,6 +11,8 @@ class Audio(PlexPartialObject):
Attributes: Attributes:
addedAt (datetime): Datetime this item was added to the library. addedAt (datetime): Datetime this item was added to the library.
art (str): URL to artwork image.
artBlurHash (str): BlurHash string for artwork image.
fields (list): List of :class:`~plexapi.media.Field`. fields (list): List of :class:`~plexapi.media.Field`.
index (sting): Index Number (often the track number). index (sting): Index Number (often the track number).
key (str): API URL (/library/metadata/<ratingkey>). key (str): API URL (/library/metadata/<ratingkey>).
@ -20,6 +22,7 @@ class Audio(PlexPartialObject):
ratingKey (int): Unique key identifying this item. ratingKey (int): Unique key identifying this item.
summary (str): Summary of the artist, track, or album. summary (str): Summary of the artist, track, or album.
thumb (str): URL to thumbnail image. thumb (str): URL to thumbnail image.
thumbBlurHash (str): BlurHash string for thumbnail image.
title (str): Artist, Album or Track title. (Jason Mraz, We Sing, Lucky, etc.) title (str): Artist, Album or Track title. (Jason Mraz, We Sing, Lucky, etc.)
titleSort (str): Title to use when sorting (defaults to title). titleSort (str): Title to use when sorting (defaults to title).
type (str): 'artist', 'album', or 'track'. type (str): 'artist', 'album', or 'track'.
@ -115,7 +118,6 @@ class Artist(Audio):
Attributes: Attributes:
TAG (str): 'Directory' TAG (str): 'Directory'
TYPE (str): 'artist' TYPE (str): 'artist'
art (str): Artist artwork (/library/metadata/<ratingkey>/art/<artid>)
countries (list): List of :class:`~plexapi.media.Country` objects this artist respresents. countries (list): List of :class:`~plexapi.media.Country` objects this artist respresents.
genres (list): List of :class:`~plexapi.media.Genre` objects this artist respresents. genres (list): List of :class:`~plexapi.media.Genre` objects this artist respresents.
guid (str): Unknown (unique ID; com.plexapp.agents.plexmusic://gracenote/artist/05517B8701668D28?lang=en) guid (str): Unknown (unique ID; com.plexapp.agents.plexmusic://gracenote/artist/05517B8701668D28?lang=en)
@ -200,7 +202,6 @@ class Album(Audio):
Attributes: Attributes:
TAG (str): 'Directory' TAG (str): 'Directory'
TYPE (str): 'album' TYPE (str): 'album'
art (str): Album artwork (/library/metadata/<ratingkey>/art/<artid>)
genres (list): List of :class:`~plexapi.media.Genre` objects this album respresents. genres (list): List of :class:`~plexapi.media.Genre` objects this album respresents.
key (str): API URL (/library/metadata/<ratingkey>). key (str): API URL (/library/metadata/<ratingkey>).
originallyAvailableAt (datetime): Datetime this album was released. originallyAvailableAt (datetime): Datetime this album was released.
@ -285,7 +286,6 @@ class Track(Audio, Playable):
Attributes: Attributes:
TAG (str): 'Directory' TAG (str): 'Directory'
TYPE (str): 'track' TYPE (str): 'track'
art (str): Track artwork (/library/metadata/<ratingkey>/art/<artid>)
chapterSource (TYPE): Unknown chapterSource (TYPE): Unknown
duration (int): Length of this album in seconds. duration (int): Length of this album in seconds.
grandparentArt (str): Album artist artwork. grandparentArt (str): Album artist artwork.

3
plexapi/library.py
View file

@ -1403,6 +1403,8 @@ class Collections(PlexPartialObject):
ratingKey (int): Unique key identifying this item. ratingKey (int): Unique key identifying this item.
addedAt (datetime): Datetime this item was added to the library. addedAt (datetime): Datetime this item was added to the library.
art (str): URL to artwork image.
artBlurHash (str): BlurHash string for artwork image.
childCount (int): Count of child object(s) childCount (int): Count of child object(s)
collectionMode (str): How the items in the collection are displayed. collectionMode (str): How the items in the collection are displayed.
collectionSort (str): How to sort the items in the collection. collectionSort (str): How to sort the items in the collection.
@ -1420,6 +1422,7 @@ class Collections(PlexPartialObject):
subtype (str): Media type subtype (str): Media type
summary (str): Summary of the collection summary (str): Summary of the collection
thumb (str): URL to thumbnail image. thumb (str): URL to thumbnail image.
thumbBlurHash (str): BlurHash string for thumbnail image.
title (str): Collection Title title (str): Collection Title
titleSort (str): Title to use when sorting (defaults to title). titleSort (str): Title to use when sorting (defaults to title).
type (str): Hardcoded 'collection' type (str): Hardcoded 'collection'

3
plexapi/video.py
View file

@ -14,6 +14,8 @@ class Video(PlexPartialObject):
Attributes: Attributes:
addedAt (datetime): Datetime this item was added to the library. addedAt (datetime): Datetime this item was added to the library.
art (str): URL to artwork image.
artBlurHash (str): BlurHash string for artwork image.
fields (list): List of :class:`~plexapi.media.Field`. fields (list): List of :class:`~plexapi.media.Field`.
key (str): API URL (/library/metadata/<ratingkey>). key (str): API URL (/library/metadata/<ratingkey>).
lastViewedAt (datetime): Datetime item was last accessed. lastViewedAt (datetime): Datetime item was last accessed.
@ -22,6 +24,7 @@ class Video(PlexPartialObject):
ratingKey (int): Unique key identifying this item. ratingKey (int): Unique key identifying this item.
summary (str): Summary of the artist, track, or album. summary (str): Summary of the artist, track, or album.
thumb (str): URL to thumbnail image. thumb (str): URL to thumbnail image.
thumbBlurHash (str): BlurHash string for thumbnail image.
title (str): Artist, Album or Track title. (Jason Mraz, We Sing, Lucky, etc.) title (str): Artist, Album or Track title. (Jason Mraz, We Sing, Lucky, etc.)
titleSort (str): Title to use when sorting (defaults to title). titleSort (str): Title to use when sorting (defaults to title).
type (str): 'artist', 'album', or 'track'. type (str): 'artist', 'album', or 'track'.