EmbyPy Documentation Release 0.6.4.0 Andriy Zasypkin Sep 04, 2021 Contents: 1 EmbyPy module 3 1.1 Emby API Wrapper...........................................3 2 EmbyPy Objects module 5 2.1 EmbyPy EmbyObject..........................................5 2.2 EmbyPy Folders.............................................7 2.3 EmbyPy Videos.............................................9 2.4 EmbyPy MISC.............................................. 11 3 EmbyPy Utils module 13 3.1 EmbyPy Connector............................................ 13 4 License 15 5 Indices and tables 25 Python Module Index 27 Index 29 i ii EmbyPy Documentation, Release 0.6.4.0 Start with the embypy.Emby class, it should be the main thing that your make requests to. Contents: 1 EmbyPy Documentation, Release 0.6.4.0 2 Contents: CHAPTER 1 EmbyPy module 1.1 Emby API Wrapper A basic wrapper for the Emby Rest API. (c) 2017 Andriy Zasypkin GPLv3, see LICENSE.txt for more details. Emby(url, **kargs) Emby connection class, an object of this type should be created to communicate with emby Emby.info(**kargs) Emby.search(**kargs) Emby.latest(**kargs) Emby.nextUp(**kargs) Emby.update(**kargs) Emby.albums Emby.create_playlist(**kargs) Emby.artists Emby.songs Emby.playlists Emby.episodes Emby.movies class embypy.Emby(url, **kargs) Emby connection class, an object of this type should be created to communicate with emby Parameters • url (str) – url to the server (e.g. http://127.0.0.1:8096/) • api_key (str, optional) – key obtained from server dashboard • device_id (str, optional) – device id to pass to emby • username (str, optional) – username to login, this+password can be used instead of an apikey 3 EmbyPy Documentation, Release 0.6.4.0 • password (str, optional) – password for user to login as connector Object used to make api requests, do not use Type embypy.utils.connector.Connector 4 Chapter 1. EmbyPy module CHAPTER 2 EmbyPy Objects module 2.1 EmbyPy EmbyObject EmbyObject(object_dict, connector[, save]) Deafult EMby Object Template EmbyObject.id string with hexidecimal hash representing the id of this object in emby EmbyObject.name name of the item EmbyObject.path get the filepath of the media file (not url) EmbyObject.type get the object type (general) EmbyObject.media_type get the object type (specific) EmbyObject.genres list of genres EmbyObject.tags list of tags EmbyObject.overview the description of the item EmbyObject.primary_image_url url of the main poster image EmbyObject.community_rating int [0-10] with the rating of the item EmbyObject.primary_image_url url of the main poster image EmbyObject.parent EmbyObject.url EmbyObject.update(**kargs) EmbyObject.send(**kargs) EmbyObject.process(**kargs) class embypy.objects.EmbyObject(object_dict, connector, save=True) Deafult EMby Object Template Parameters • object_dict (dict) – dictionary with json info returned from emby • connector (embypy.utils.connector.Connector) – connector object to make upstream api calls • save (bool) – if true, append to list of existing objects saves space/increases speed/reduces 5 EmbyPy Documentation, Release 0.6.4.0 issues only set to false if creating a temp object that will be thrown out id string with hexidecimal hash representing the id of this object in emby name name of the item See also: post title same as name See also: post watched returns True it item has been watched played same as watched percentage_played returns played percentage [0,1] of item duration returns duration of item in seconds play_count returns users playcount for item favorite returns True if user favorited item type get the object type (general) See also: media_type media_type get the object type (specific) See also: type genres list of genres See also: post, tags tags list of tags See also: post, genres 6 Chapter 2. EmbyPy Objects module EmbyPy Documentation, Release 0.6.4.0 overview the description of the item See also: post community_rating int [0-10] with the rating of the item See also: post primary_image_url url of the main poster image parent_id id of the parent object See also: parent path get the filepath of the media file (not url) See also: url 2.2 EmbyPy Folders Folder.child_count number of items in this folder Folder.cumulative_run_time total run time of items in ticks Folder.items Playlist.songs Playlist.add_items(**kargs) Playlist.remove_items(**kargs) BoxSet.movies BoxSet.series MusicAlbum.album_artists MusicAlbum.artists MusicAlbum.songs MusicArtist.albums MusicArtist.songs Season.index_number season number Season.played_percentage percentage of episodes watched Season.episodes Season.series Series.status whether show is Airing or Complete Series.air_days Days of the week the show airs Series.air_time Time of day at which show airs Series.premiere_date date the show started airing Series.seasons Series.episodes Continued on next page 2.2. EmbyPy Folders 7 EmbyPy Documentation, Release 0.6.4.0 Table 2 – continued from previous page GameSystem(object_dict, connector) Class representing emby game systems objects class embypy.objects.Folder(object_dict, connector) Class representing generic emby folder objects Parameters • object_dict (dict) – same as for EmbyObject • connector (embypy.utils.connector.Connector) – same as for EmbyObject child_count number of items in this folder cumulative_run_time total run time of items in ticks cumulative_duration total run time of items in seconds class embypy.objects.Playlist(object_dict, connector) Class representing emby playlist objects Parameters • object_dict (dict) – same as for EmbyObject • connector (embypy.utils.connector.Connector) – same as for EmbyObject class embypy.objects.BoxSet(object_dict, connector) Class representing emby boxsets/collection objects Parameters • object_dict (dict) – same as for EmbyObject • connector (embypy.utils.connector.Connector) – same as for EmbyObject class embypy.objects.Series(object_dict, connector) Class representing emby TV show/series objects Parameters • object_dict (dict) – same as for EmbyObject • connector (embypy.utils.connector.Connector) – same as for EmbyObject air_days Days of the week the show airs air_time Time of day at which show airs status whether show is Airing or Complete premiere_date date the show started airing class embypy.objects.Season(object_dict, connector) Class representing emby season objects for TV shows Parameters • object_dict (dict) – same as for EmbyObject 8 Chapter 2. EmbyPy Objects module EmbyPy Documentation, Release 0.6.4.0 • connector (embypy.utils.connector.Connector) – same as for EmbyObject index_number season number played_percentage percentage of episodes watched series_id emby id of the show series_name Name of the show class embypy.objects.MusicArtist(object_dict, connector) class embypy.objects.MusicAlbum(object_dict, connector) Class representing emby music album objects Parameters • object_dict (dict) – same as for EmbyObject • connector (embypy.utils.connector.Connector) – same as for EmbyObject album_artist_ids emby id of album artist artist_ids list of emby artist ids for the song class embypy.objects.GameSystem(object_dict, connector) Class representing emby game systems objects Parameters • object_dict (dict) – same as for EmbyObject • connector (embypy.utils.connector.Connector) – same as for EmbyObject 2.3 EmbyPy Videos Video.aspect_ratio aspect ratio of the video Video.chapters chapters included in the video file Movie.premiere_date date that the movie permiered Episode.episode_number the episode number (in the season) Episode.premiere_date date that the episode permiered Episode.season Episode.series Trailer(object_dict, connector) Class representing trailer objects AdultVideo(object_dict, connector) Class representing adult vidoe objects MusicVideo(object_dict, connector) Class representing music video objects class embypy.objects.Video(object_dict, connector) Class representing generic emby video objects Parameters • object_dict (dict) – same as for EmbyObject 2.3. EmbyPy Videos 9 EmbyPy Documentation, Release 0.6.4.0 • connector (embypy.utils.connector.Connector) – same as for EmbyObject aspect_ratio aspect ratio of the video chapters chapters included in the video file stream_url stream url (as an mp4) class embypy.objects.Movie(object_dict, connector) Class representing movie objects Parameters • object_dict (dict) – same as for EmbyObject • connector (embypy.utils.connector.Connector) – same as for EmbyObject premiere_date date that the movie permiered class embypy.objects.Episode(object_dict, connector) Class representing episode objects Parameters • object_dict (dict) – same as for EmbyObject • connector (embypy.utils.connector.Connector) – same as for EmbyObject premiere_date date that the episode permiered index_number the episode number (in the season) episode_number the episode number (in the season) season_name season name season_number season index season_id season name series_id The emby id of the series this episode belongs to series_name name of the season genres genres for the show class embypy.objects.Trailer(object_dict, connector) Class representing trailer objects Parameters • object_dict (dict) – same as for EmbyObject 10 Chapter 2. EmbyPy Objects module EmbyPy Documentation, Release 0.6.4.0 • connector (embypy.utils.connector.Connector) – same as for EmbyObject class embypy.objects.AdultVideo(object_dict, connector) Class representing adult vidoe objects Parameters • object_dict (dict) – same as for EmbyObject • connector (embypy.utils.connector.Connector) – same as for EmbyObject class embypy.objects.MusicVideo(object_dict, connector)