Module pyatv.settings

Settings for configuring pyatv.

Browse git

Classes

class AirPlaySettings (**data: Any)

Settings related to AirPlay.

Create a new model by parsing and validating input data from keyword arguments.

Raises ValidationError if the input data cannot be parsed to form a valid model.

Browse git

Ancestors

  • pydantic.v1.main.BaseModel
  • pydantic.v1.utils.Representation

Class variables

var credentials -> str | None

The type of the None singleton.

var identifier -> str | None

The type of the None singleton.

var mrp_tunnel -> MrpTunnel

The type of the None singleton.

var password -> str | None

The type of the None singleton.

class AirPlayVersion (*args, **kwds)

AirPlay version to use.

Browse git

Ancestors

  • builtins.str
  • enum.Enum

Class variables

var Auto = auto

Automatically determine what version to use.

var V1 = 1

Use version 1 of AirPlay.

var V2 = 2

Use version 2 of AirPlay.

class CompanionSettings (**data: Any)

Settings related to Companion.

Create a new model by parsing and validating input data from keyword arguments.

Raises ValidationError if the input data cannot be parsed to form a valid model.

Browse git

Ancestors

  • pydantic.v1.main.BaseModel
  • pydantic.v1.utils.Representation

Class variables

var credentials -> str | None

The type of the None singleton.

var identifier -> str | None

The type of the None singleton.

class DmapSettings (**data: Any)

Settings related to DMAP.

Create a new model by parsing and validating input data from keyword arguments.

Raises ValidationError if the input data cannot be parsed to form a valid model.

Browse git

Ancestors

  • pydantic.v1.main.BaseModel
  • pydantic.v1.utils.Representation

Class variables

var credentials -> str | None

The type of the None singleton.

var identifier -> str | None

The type of the None singleton.

class InfoSettings (**data: Any)

Information related settings.

Create a new model by parsing and validating input data from keyword arguments.

Raises ValidationError if the input data cannot be parsed to form a valid model.

Browse git

Ancestors

  • pydantic.v1.main.BaseModel
  • pydantic.v1.utils.Representation

Class variables

var device_id -> str

The type of the None singleton.

var mac -> str

The type of the None singleton.

var model -> str

The type of the None singleton.

var name -> str

The type of the None singleton.

var os_build -> str

The type of the None singleton.

var os_name -> str

The type of the None singleton.

var os_version -> str

The type of the None singleton.

Static methods

def mac_validator(mac: str) -> str

Validate MAC address to be correct.

class MrpSettings (**data: Any)

Settings related to MRP.

Create a new model by parsing and validating input data from keyword arguments.

Raises ValidationError if the input data cannot be parsed to form a valid model.

Browse git

Ancestors

  • pydantic.v1.main.BaseModel
  • pydantic.v1.utils.Representation

Class variables

var credentials -> str | None

The type of the None singleton.

var identifier -> str | None

The type of the None singleton.

class MrpTunnel (*args, **kwds)

How MRP tunneling over AirPlay is handled.

Browse git

Ancestors

  • builtins.str
  • enum.Enum

Class variables

var Auto = auto

Automatically set up MRP tunnel if supported by remote device.

var Disable = disable

Fully disable set up of MRP tunnel.

var Force = force

Force set up of MRP tunnel even if remote device does not supports it.

class ProtocolSettings (**data: Any)

Container for protocol specific settings.

Create a new model by parsing and validating input data from keyword arguments.

Raises ValidationError if the input data cannot be parsed to form a valid model.

Browse git

Ancestors

  • pydantic.v1.main.BaseModel
  • pydantic.v1.utils.Representation

Class variables

var airplay -> AirPlaySettings

The type of the None singleton.

var companion -> CompanionSettings

The type of the None singleton.

var dmap -> DmapSettings

The type of the None singleton.

var mrp -> MrpSettings

The type of the None singleton.

var raop -> RaopSettings

The type of the None singleton.

class RaopSettings (**data: Any)

Settings related to RAOP.

Create a new model by parsing and validating input data from keyword arguments.

Raises ValidationError if the input data cannot be parsed to form a valid model.

Browse git

Ancestors

  • pydantic.v1.main.BaseModel
  • pydantic.v1.utils.Representation

Class variables

var control_port -> int

Server side (UDP) port used by control server.

Set to 0 to use random free port.

var credentials -> str | None

The type of the None singleton.

var identifier -> str | None

The type of the None singleton.

var password -> str | None

The type of the None singleton.

var protocol_version -> AirPlayVersion

Protocol version used.

In reality this corresponds to the AirPlay version used. Set to 0 for automatic mode (recommended), or 1 or 2 for AirPlay 1 or 2 respectively.

var timing_port -> int

Server side (UDP) port used by timing server.

Set to 0 to use random free port.

class Settings (**data: Any)

Settings container class.

Create a new model by parsing and validating input data from keyword arguments.

Raises ValidationError if the input data cannot be parsed to form a valid model.

Browse git

Ancestors

  • pydantic.v1.main.BaseModel
  • pydantic.v1.utils.Representation

Class variables

var info -> InfoSettings

The type of the None singleton.

var protocols -> ProtocolSettings

The type of the None singleton.