API¶
This page contains documentation for all public APIs in pyatv.
NOTE: Currently, the content on this page is far from complete. It will be updated as time goes. Feel free to help out.
Module contents¶
Library for controlling an Apple TV.
-
class
pyatv.
AppleTVDevice
[source]¶ Bases:
pyatv.AppleTVDevice
Representation of an Apple TV device used when connecting.
Submodules¶
pyatv.const module¶
Constants used in the public API.
-
pyatv.const.
MEDIA_TYPE_MUSIC
= 3¶ Media type is music
-
pyatv.const.
MEDIA_TYPE_TV
= 4¶ Media type is TV
-
pyatv.const.
MEDIA_TYPE_UNKNOWN
= 1¶ Media type is unknown
-
pyatv.const.
MEDIA_TYPE_VIDEO
= 2¶ Media type is video
-
pyatv.const.
PLAY_STATE_FAST_BACKWARD
= 6¶ Media is being rewinded
-
pyatv.const.
PLAY_STATE_FAST_FORWARD
= 5¶ Media is being fast forwarded
-
pyatv.const.
PLAY_STATE_LOADING
= 2¶ Media is loading/buffering
-
pyatv.const.
PLAY_STATE_NO_MEDIA
= 1¶ No media is currently select/playing
-
pyatv.const.
PLAY_STATE_PAUSED
= 3¶ Media is paused
-
pyatv.const.
PLAY_STATE_PLAYING
= 4¶ Media is playing
-
pyatv.const.
REPEAT_STATE_ALL
= 2¶ Repeat all tracks
-
pyatv.const.
REPEAT_STATE_OFF
= 0¶ No repeat
-
pyatv.const.
REPEAT_STATE_TRACK
= 1¶ Repeat current track
pyatv.exceptions module¶
Local exceptions used by library.
-
exception
pyatv.exceptions.
AsyncUpdaterRunningError
[source]¶ Bases:
Exception
Thrown when performing an invalid action in AsyncUpdater..
-
exception
pyatv.exceptions.
DeviceAuthenticationError
[source]¶ Bases:
Exception
Thrown when device authentication fails.
-
exception
pyatv.exceptions.
InvalidDmapDataError
[source]¶ Bases:
Exception
Thrown when invalid DMAP data is parsed.
-
exception
pyatv.exceptions.
NoAsyncListenerError
[source]¶ Bases:
Exception
Thrown when starting AsyncUpdater with no listener.
-
exception
pyatv.exceptions.
NoCredentialsError
[source]¶ Bases:
Exception
Thrown if performing an action before initialize is called.
-
exception
pyatv.exceptions.
NotSupportedError
[source]¶ Bases:
NotImplementedError
Thrown when trying to perform an action that is not supported.
-
exception
pyatv.exceptions.
UnknownMediaKind
[source]¶ Bases:
Exception
Thrown when an unknown media kind is found.
pyatv.helpers module¶
Various helper methods.
-
pyatv.helpers.
auto_connect
(handler, timeout=5, not_found=None, event_loop=None)[source]¶ Short method for connecting to a device.
This is a convenience method that create an event loop, auto discovers devices, picks the first device found, connects to it and passes it to a user provided handler. An optional error handler can be provided that is called when no device was found. Very inflexible in many cases, but can be handys sometimes when trying things.
Note 1: both handler and not_found must be coroutines Note 2: An optional loop can be passed if needed (mainly for testing)
pyatv.interface module¶
API exposed by the library.
-
class
pyatv.interface.
AirPlay
[source]¶ Bases:
object
Base class for AirPlay functionality.
-
class
pyatv.interface.
AppleTV
[source]¶ Bases:
object
Base class representing an Apple TV.
-
airplay
¶ Return API for working with AirPlay.
-
logout
()[source]¶ Perform an explicit logout.
Must be done when session is no longer needed to not leak resources.
-
metadata
¶ Return API for retrieving metadata from the Apple TV.
-
push_updater
¶ Return API for handling push update from the Apple TV.
-
remote_control
¶ Return API for controlling the Apple TV.
-
-
class
pyatv.interface.
Metadata
[source]¶ Bases:
object
Base class for retrieving metadata from an Apple TV.
-
class
pyatv.interface.
Playing
[source]¶ Bases:
object
Base class for retrieving what is currently playing.
-
album
¶ Album of the currently playing song.
-
artist
¶ Artist of the currently playing song.
-
hash
¶ Create a unique hash for what is currently playing.
The hash is based on title, artist, album and total time. It should always be the same for the same content, but it is not guaranteed.
-
media_type
¶ Type of media is currently playing, e.g. video, music.
-
play_state
¶ Play state, e.g. playing or paused.
-
position
¶ Position in the playing media (seconds).
-
repeat
¶ Repeat mode.
-
shuffle
¶ If shuffle is enabled or not.
-
title
¶ Title of the current media, e.g. movie or song name.
-
total_time
¶ Total play time in seconds.
-
-
class
pyatv.interface.
PushUpdater
[source]¶ Bases:
object
Base class for push/async updates from an Apple TV.
-
listener
¶ Object (PushUpdaterListener) that receives updates.
-