InvalidDmapDataErrorInvalidFormatErrorInvalidResponseErrorpyatv.exceptionsLocal exceptions used by library.
- +
+class InvalidFormatError
+(*args, **kwargs)
+Raised when an unsupported (file) format is encountered.
class InvalidResponseError
(*args, **kwargs)
diff --git a/docs/api/pyatv.interface.html b/docs/api/pyatv.interface.html
index 814adc59d..953b5858a 100644
--- a/docs/api/pyatv.interface.html
+++ b/docs/api/pyatv.interface.html
@@ -306,6 +306,7 @@ Sto
Stream
@@ -336,7 +337,7 @@ Module pyatv.interface
Public interface exposed by library.
This module contains all the interfaces that represents a generic Apple TV device and
all its features.
-
+
@@ -352,7 +353,7 @@ Functions
Retrieve all commands and help texts from an API object.
Information about an app.
Initialize a new App instance.
var identifier -> strReturn a unique bundle id for the app.
var name -> Optional[str]User friendly name of app.
Base class representing an Apple TV.
Listener interface: pyatv.interfaces.DeviceListener
Initialize a new StateProducer instance.
var apps -> AppsReturn apps interface.
var audio -> AudioReturn audio interface.
var device_info -> DeviceInfoReturn API for device information.
var features -> FeaturesReturn features interface.
var keyboard -> KeyboardReturn keyboard interface.
var metadata -> MetadataReturn API for retrieving metadata from the Apple TV.
var power -> PowerReturn API for power management.
var push_updater -> PushUpdaterReturn API for handling push update from the Apple TV.
var remote_control -> RemoteControlReturn API for controlling the Apple TV.
var service -> BaseServiceReturn service used to connect to the Apple TV.
var settings -> SettingsReturn device settings used by pyatv.
var stream -> StreamReturn API for streaming media.
var user_accounts -> UserAccountsReturn user accounts interface.
Close connection and release allocated resources.
@@ -487,7 +488,7 @@ Methods
-
Initiate connection to device.
No need to call it yourself, it's done automatically.
@@ -496,7 +497,7 @@ Methods
Base class for app handling.
Fetch a list of apps that can be launched.
@@ -528,7 +529,7 @@ Methods
Supported by: Protocol.Companion
Launch an app based on bundle ID or URL.
Methods
Artwork information.
Volume level is managed in percent where 0 is muted and 100 is max volume.
Listener interface: pyatv.interfaces.AudioListener
Initialize a new StateProducer instance.
- +Return current list of output device IDs.
var volume -> floatReturn current volume level.
Range is in percent, i.e. [0.0-100.0].
Add output devices.
@@ -635,7 +636,7 @@ Methods
Supported by: Protocol.MRP
Remove output devices.
-
@@ -648,7 +649,7 @@ Methods
Supported by: Protocol.MRP
Set output devices.
-
@@ -662,7 +663,7 @@ Methods
Change current volume level.
Range is in percent, i.e. [0.0-100.0].
-
@@ -679,7 +680,7 @@ Methods
range. It is not necessarily linear.
Call will block until volume change has been acknowledged by the device (when
possible and supported).
-
+
-
@@ -696,7 +697,7 @@ Methods
range. It is not necessarily linear.
Call will block until volume change has been acknowledged by the device (when
possible and supported).
-
+
@@ -705,7 +706,7 @@ Methods
-
Listener interface for audio updates.
Ancestors
- abc.ABC
@@ -723,7 +724,7 @@ Methods
-
Output devices were updated.
-
@@ -732,7 +733,7 @@ Methods
-
Device volume was updated.
@@ -746,7 +747,7 @@ Methods
several services depending on the protocols it supports, e.g. DMAP or
AirPlay.
Initialize a new BaseConfig instance.
-
+
Ancestors
- abc.ABC
@@ -760,47 +761,47 @@ Instance variables
var address -> ipaddress.IPv4Address-
IP address of device.
var all_identifiers -> List[str]-
Return all unique identifiers for this device.
var deep_sleep -> bool-
If device is in deep sleep.
var device_info -> DeviceInfo-
Return general device information.
var identifier -> Optional[str]-
Return the main identifier associated with this device.
var name -> str-
Name of device.
var properties -> Mapping[str, Mapping[str, str]]-
Return Zeroconf properties.
var ready -> bool-
Return if configuration is ready, (at least one service with identifier).
var services -> List[BaseService]-
Return all supported services.
Methods
@@ -813,7 +814,7 @@ Methods
-
Add a new service.
If the service already exists, it will be merged.
-
@@ -822,7 +823,7 @@ Methods
-
Apply settings to configuration.
-
@@ -833,7 +834,7 @@ Methods
Look up a service based on protocol.
If a service with the specified protocol is not available, None is
returned.
-
@@ -842,7 +843,7 @@ Methods
-
Return suggested service used to establish connection.
-
@@ -851,7 +852,7 @@ Methods
-
Set credentials for a protocol if it exists.
@@ -862,7 +863,7 @@ Methods
-
Base class for protocol services.
Initialize a new BaseService.
Ancestors
- abc.ABC
@@ -877,37 +878,37 @@ Instance variables
var enabled -> bool-
Return True if service is enabled.
var identifier -> Optional[str]-
Return unique identifier associated with this service.
var pairing -> PairingRequirement-
Return if pairing is required by service.
var port -> int-
Return service port number.
var properties -> Mapping[str, str]-
Return service Zeroconf properties.
var protocol -> Protocol-
Return protocol type.
var requires_password -> bool-
Return if a password is required to access service.
Methods
@@ -922,7 +923,7 @@ Methods
Expects the same format as returned by settings() method. Unknown properties
are silently ignored. Settings with a None value are also ignore (keeps
original value).
-
+
-
@@ -932,7 +933,7 @@ Methods
-
Merge with other service of same type.
Merge will only include credentials, password and properties.
-
@@ -941,7 +942,7 @@ Methods
-
Return settings and their values.
@@ -952,7 +953,7 @@ Methods
-
General information about device.
Initialize a new DeviceInfo instance.
Class variables
var OUTPUT_DEVICE_IDInstance variables
var build_number -> Optional[str]-
Operating system build number, e.g. 17K795.
var mac -> Optional[str]-
Device MAC address.
var model -> DeviceModel-
Hardware model name, e.g. 3, 4 or 4K.
var model_str -> str-
Return model name as string.
This property will return the model name as a string and fallback to raw_model
if it is not available.
var operating_system -> OperatingSystem-
Operating system running on device.
var output_device_id -> Optional[str]-
Output device identifier.
var raw_model -> Optional[str]-
Return raw model description.
If DeviceInfo.model returns DeviceModel.Unknown
then this property contains the raw model string (if any is available).
var version -> Optional[str]-
Operating system version.
@@ -1013,7 +1014,7 @@ Instance variables
-
Listener interface for generic device updates.
Ancestors
- abc.ABC
@@ -1032,7 +1033,7 @@ Methods
-
Device connection was (intentionally) closed.
-
@@ -1041,7 +1042,7 @@ Methods
-
Device was unexpectedly disconnected.
@@ -1051,7 +1052,7 @@ Methods
-
Feature state and options.
Ancestors
- builtins.tuple
@@ -1073,7 +1074,7 @@ Instance variables
-
Base class for supported feature functionality.
Subclasses
- pyatv.core.facade.FacadeFeatures
@@ -1092,7 +1093,7 @@ Methods
Return state of all features.
@@ -1101,7 +1102,7 @@ Methods
Return current state of a feature.
@@ -1113,7 +1114,7 @@ Methods
This method will return True if all given features are in the state specified
by "states". If "states" is a list of states, it is enough for the feature to be
in one of the listed states.
-
+
@@ -1126,7 +1127,7 @@ Methods
Listener
interface: pyatv.interfaces.KeyboardListener
Initialize a new StateProducer instance.
-
+
Ancestors
- abc.ABC
@@ -1147,7 +1148,7 @@ Instance variables
Supported by: Protocol.Companion
Return keyboard focus state.
Methods
@@ -1163,7 +1164,7 @@ Methods
Supported by: Protocol.Companion
Input text into virtual keyboard.
-
@@ -1176,7 +1177,7 @@ Methods
Supported by: Protocol.Companion
Clear virtual keyboard text.
-
@@ -1189,7 +1190,7 @@ Methods
Supported by: Protocol.Companion
Get current virtual keyboard text.
-
@@ -1202,7 +1203,7 @@ Methods
Supported by: Protocol.Companion
Replace text in virtual keyboard.
Methods
-
Listener interface for keyboard updates.
Ancestors
- abc.ABC
@@ -1229,7 +1230,7 @@ Methods
-
Keyboard focus state was updated.
@@ -1239,7 +1240,7 @@ Methods
-
Container for media (e.g. audio or video) metadata.
Class variables
var album -> Optional[str]Class variables
Base class for retrieving metadata from an Apple TV.
Do note that this property returns which app is currently playing something and not which app is currently active. If nothing is playing, the corresponding feature will be unavailable.
- +var artwork_id -> strReturn a unique identifier for current artwork.
var device_id -> Optional[str]Return a unique identifier for current device.
@@ -1329,7 +1330,7 @@ Methods
Return what is currently playing.
Information about an output device.
Initialize a new OutputDevice instance.
var identifier -> strReturn a unique id for the output device.
var name -> Optional[str]User friendly name of output device.
Base class for API used to pair with an Apple TV.
Initialize a new instance of PairingHandler.
var device_provides_pin -> boolReturn True if remote device presents PIN code, else False.
var has_paired -> boolIf a successful pairing has been performed.
The value will be reset when stop() is called.
var service -> BaseServiceReturn service used for pairing.
Start pairing process.
@@ -1411,7 +1412,7 @@ Methods
Call to free allocated resources after pairing.
@@ -1420,7 +1421,7 @@ Methods
Stop pairing process.
@@ -1429,7 +1430,7 @@ Methods
Pin code used for pairing.
Base class for retrieving what is currently playing.
Initialize a new Playing instance.
Album of the currently playing song.
var artist -> Optional[str]Artist of the currently playing song.
var content_identifier -> Optional[str]Content identifier (app specific).
var device_state -> DeviceStateDevice state, e.g. playing or paused.
var episode_number -> Optional[int]Episode number of TV series.
var genre -> Optional[str]Genre of the currently playing song.
var hash -> strCreate 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.
var media_type -> MediaTypeType of media is currently playing, e.g. video, music.
var position -> Optional[int]Position in the playing media (seconds).
var repeat -> Optional[RepeatState]Repeat mode.
var season_number -> Optional[int]Season number of TV series.
var series_name -> Optional[str]Title of TV series.
var shuffle -> Optional[ShuffleState]If shuffle is enabled or not.
var title -> Optional[str]Title of the current media, e.g. movie or song name.
var total_time -> Optional[int]Total play time in seconds.
Base class for retrieving power state from an Apple TV.
Listener interface: pyatv.interfaces.PowerListener
Initialize a new StateProducer instance.
Return device power state.
Turn device off.
@@ -1633,7 +1634,7 @@ Methods
Supported by: Protocol.Companion, Protocol.MRP
Turn device on.
Methods
Listener interface for power updates.
Device power state was updated.
Listener interface for push updates.
Inform about an error when updating play status.
@@ -1700,7 +1701,7 @@ Methods
Inform about changes to what is currently playing.
Listener interface: PushListener.
Initialize a new StateProducer instance.
- +var active -> boolReturn if push updater has been started.
Begin to listen to updates.
If an error occurs, start must be called again.
@@ -1757,7 +1758,7 @@ Methods
No longer forward updates to listener.
Base class for API used to control an Apple TV.
Select previous channel.
@@ -1802,7 +1803,7 @@ Methods
Supported by: Protocol.Companion
Select next channel.
-
@@ -1815,7 +1816,7 @@ Methods
Supported by: Protocol.Companion, Protocol.DMAP, Protocol.MRP
Press key down.
-
@@ -1828,7 +1829,7 @@ Methods
Supported by: Protocol.Companion, Protocol.MRP
Press key home.
-
@@ -1841,7 +1842,7 @@ Methods
Supported by: Protocol.MRP
Hold key home.
-
@@ -1854,7 +1855,7 @@ Methods
Supported by: Protocol.Companion, Protocol.DMAP, Protocol.MRP
Press key left.