homeassistant.components.itunes.media_player.Itunes Class Reference

Public Member Functions
def	__init__ (self, host, port, use_ssl)
def	airplay_device (self, device_id)
def	airplay_devices (self)
def	artwork_url (self)
def	next (self)
def	now_playing (self)
def	pause (self)
def	play (self)
def	play_playlist (self, playlist_id_or_name)
def	previous (self)
def	set_muted (self, muted)
def	set_shuffle (self, shuffle)
def	set_volume (self, level)
def	set_volume_airplay_device (self, device_id, level)
def	stop (self)
def	toggle_airplay_device (self, device_id, toggle)

Public Attributes
	host
	port
	use_ssl

Private Member Functions
def	_base_url (self)
def	_command (self, named_command)
def	_request (self, method, path, params=None)

Detailed Description

The iTunes API client.

Definition at line 40 of file media_player.py.

Constructor & Destructor Documentation

__init__()

def homeassistant.components.itunes.media_player.Itunes.__init__	(		self,
			host,
			port,
			use_ssl
	)

Initialize the iTunes device.

Definition at line 43 of file media_player.py.

Member Function Documentation

_base_url()

def homeassistant.components.itunes.media_player.Itunes._base_url (   self )

private

Return the base URL for endpoints.

Definition at line 50 of file media_player.py.

_command()

def homeassistant.components.itunes.media_player.Itunes._command (   self,   named_command  )

private

Make a request for a controlling command.

Definition at line 80 of file media_player.py.

_request()

def homeassistant.components.itunes.media_player.Itunes._request (   self,   method,   path,   params = None  )

private

Make the actual request and return the parsed response.

Definition at line 62 of file media_player.py.

airplay_device()

def homeassistant.components.itunes.media_player.Itunes.airplay_device	(		self,
			device_id
	)

Return an AirPlay device.

Definition at line 148 of file media_player.py.

airplay_devices()

def homeassistant.components.itunes.media_player.Itunes.airplay_devices

(

self

)

Return a list of AirPlay devices.

Definition at line 144 of file media_player.py.

artwork_url()

def homeassistant.components.itunes.media_player.Itunes.artwork_url

(

self

)

Return a URL of the current track's album art.

Definition at line 140 of file media_player.py.

next()

def homeassistant.components.itunes.media_player.Itunes.next

(

self

)

Skip to the next track and returns the current state.

Definition at line 110 of file media_player.py.

now_playing()

def homeassistant.components.itunes.media_player.Itunes.now_playing

(

self

)

Return the current state.

Definition at line 84 of file media_player.py.

pause()

def homeassistant.components.itunes.media_player.Itunes.pause

(

self

)

Set playback to paused and returns the current state.

Definition at line 106 of file media_player.py.

play()

def homeassistant.components.itunes.media_player.Itunes.play

(

self

)

Set playback to play and returns the current state.

Definition at line 102 of file media_player.py.

play_playlist()

def homeassistant.components.itunes.media_player.Itunes.play_playlist	(		self,
			playlist_id_or_name
	)

Set a playlist to be current and returns the current state.

Definition at line 122 of file media_player.py.

previous()

def homeassistant.components.itunes.media_player.Itunes.previous

(

self

)

Skip back and returns the current state.

Definition at line 114 of file media_player.py.

set_muted()

def homeassistant.components.itunes.media_player.Itunes.set_muted	(		self,
			muted
	)

Mute and returns the current state, muted True or False.

Definition at line 92 of file media_player.py.

set_shuffle()

def homeassistant.components.itunes.media_player.Itunes.set_shuffle	(		self,
			shuffle
	)

Set the shuffle mode, shuffle True or False.

Definition at line 96 of file media_player.py.

set_volume()

def homeassistant.components.itunes.media_player.Itunes.set_volume	(		self,
			level
	)

Set the volume and returns the current state, level 0-100.

Definition at line 88 of file media_player.py.

set_volume_airplay_device()

def homeassistant.components.itunes.media_player.Itunes.set_volume_airplay_device	(		self,
			device_id,
			level
	)

Set volume, returns current state of device, id,level 0-100.

Definition at line 158 of file media_player.py.

stop()

def homeassistant.components.itunes.media_player.Itunes.stop

(

self

)

Stop playback and return the current state.

Definition at line 118 of file media_player.py.

toggle_airplay_device()

def homeassistant.components.itunes.media_player.Itunes.toggle_airplay_device	(		self,
			device_id,
			toggle
	)

Toggle airplay device on or off, id, toggle True or False.

Definition at line 152 of file media_player.py.

Member Data Documentation

host

homeassistant.components.itunes.media_player.Itunes.host

Definition at line 45 of file media_player.py.

port

homeassistant.components.itunes.media_player.Itunes.port

Definition at line 46 of file media_player.py.

use_ssl

homeassistant.components.itunes.media_player.Itunes.use_ssl

Definition at line 47 of file media_player.py.

---

The documentation for this class was generated from the following file:

• core/homeassistant/components/itunes/media_player.py