From e185ecf277d6647acb556b4bd7aa9eeb1bfe1102 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Pierre=20St=C3=A5hl?= Local exceptions used by library. Raised when an unsupported (file) format is encountered. Public interface exposed by library. This module contains all the interfaces that represents a generic Apple TV device and
all its features. Retrieve all commands and help texts from an API object. Information about an app. Initialize a new App instance. Return a unique bundle id for the app. User friendly name of app. Base class representing an Apple TV. Listener interface: Initialize a new StateProducer instance. Return apps interface. Return audio interface. Return API for device information. Return features interface. Return keyboard interface. Return API for retrieving metadata from the Apple TV. Return API for power management. Return API for handling push update from the Apple TV. Return API for controlling the Apple TV. Return service used to connect to the Apple TV. Return device settings used by pyatv. Return API for streaming media. Return user accounts interface. Close connection and release allocated resources. Initiate connection to device. No need to call it yourself, it's done automatically. Base class for app handling. Fetch a list of apps that can be launched. Launch an app based on bundle ID or URL. Artwork information. Volume level is managed in percent where 0 is muted and 100 is max volume. Listener interface: Initialize a new StateProducer instance. Return current list of output device IDs. Return current volume level. Range is in percent, i.e. [0.0-100.0]. Add output devices. Remove output devices. Set output devices. Change current volume level. Range is in percent, i.e. [0.0-100.0].InvalidDmapDataError
+InvalidFormatError
InvalidResponseError
Module
pyatv.exceptions
Ancestors
+class InvalidFormatError
+(*args, **kwargs)
+
Ancestors
+
+
+
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
@@ -336,7 +337,7 @@ Stream
Module
pyatv.interface
Functions
Classes
Instance variables
var identifier -> str
var name -> Optional[str]
Instance variables
pyatv.interfaces.DeviceListener
Ancestors
Instance variables
var apps -> Apps
var audio -> Audio
var device_info -> DeviceInfo
var features -> Features
var keyboard -> Keyboard
var metadata -> Metadata
var power -> Power
var push_updater -> PushUpdater
var remote_control -> RemoteControl
var service -> BaseService
var settings -> Settings
var stream -> Stream
var user_accounts -> UserAccounts
Methods
@@ -477,7 +478,7 @@ Methods
@@ -487,7 +488,7 @@
Methods
Methods
Subclasses
Methods
Supported by: Protocol.Companion
@@ -528,7 +529,7 @@
Methods
Supported by: Protocol.Companion
Methods
Ancestors
Instance variables
pyatv.interfaces.AudioListener
Ancestors
Instance variables
Supported by: Protocol.MRP
var volume -> float
Instance variables
Methods
@@ -622,7 +623,7 @@ Methods
Supported by: Protocol.MRP
@@ -635,7 +636,7 @@
Methods
Supported by: Protocol.MRP
@@ -648,7 +649,7 @@
Methods
Supported by: Protocol.MRP
@@ -662,7 +663,7 @@
Methods
@@ -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.
Output devices were updated.
@@ -732,7 +733,7 @@ Methods
Device volume was updated.
Initialize a new BaseConfig instance.
- +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.
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_ID
@@ -965,46 +966,46 @@ Instance 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.
Feature state and options.
Base class for supported feature functionality.
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.
-
+
Listener
interface: pyatv.interfaces.KeyboardListener
Initialize a new StateProducer instance.
- +Return keyboard focus state.
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.
-
+
@@ -1211,7 +1212,7 @@ 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.
var album -> Optional[str]
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 -> str
Return 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 -> str
Return 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 -> bool
Return True if remote device presents PIN code, else False.
var has_paired -> bool
If a successful pairing has been performed.
The value will be reset when stop() is called.
var service -> BaseService
Return 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 -> DeviceState
Device 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 -> str
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.
var media_type -> MediaType
Type 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.
-
+
@@ -1642,7 +1643,7 @@ 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 -> bool
Return 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.
-
+