homeassistant.components.itunes.media_player.ItunesDevice Class Reference

Inheritance diagram for homeassistant.components.itunes.media_player.ItunesDevice:

Collaboration diagram for homeassistant.components.itunes.media_player.ItunesDevice:

Public Member Functions
def	__init__ (self, name, host, port, use_ssl, add_entities)
def	is_volume_muted (self)
def	media_album_name (self)
def	media_artist (self)
def	media_content_id (self)
def	media_image_url (self)
None	media_next_track (self)
None	media_pause (self)
None	media_play (self)
def	media_playlist (self)
None	media_previous_track (self)
def	media_title (self)
None	mute_volume (self, bool mute)
def	name (self)
None	play_media (self, MediaType|str media_type, str media_id, **Any kwargs)
None	set_shuffle (self, bool shuffle)
None	set_volume_level (self, float volume)
def	shuffle (self)
def	state (self)
None	turn_off (self)
None	update (self)
def	update_state (self, state_hash)
def	volume_level (self)
Public Member Functions inherited from homeassistant.components.media_player.MediaPlayerEntity
str	access_token (self)
str|None	app_id (self)
str|None	app_name (self)
BrowseMedia	async_browse_media (self, MediaType|str|None media_content_type=None, str|None media_content_id=None)
None	async_clear_playlist (self)
tuple[bytes|None, str|None]	async_get_browse_image (self, str media_content_type, str media_content_id, str|None media_image_id=None)
tuple[bytes|None, str|None]	async_get_media_image (self)
None	async_join_players (self, list[str] group_members)
None	async_media_next_track (self)
None	async_media_pause (self)
None	async_media_play (self)
None	async_media_play_pause (self)
None	async_media_previous_track (self)
None	async_media_seek (self, float position)
None	async_media_stop (self)
None	async_mute_volume (self, bool mute)
None	async_play_media (self, MediaType|str media_type, str media_id, **Any kwargs)
None	async_select_sound_mode (self, str sound_mode)
None	async_select_source (self, str source)
None	async_set_repeat (self, RepeatMode repeat)
None	async_set_shuffle (self, bool shuffle)
None	async_set_volume_level (self, float volume)
None	async_toggle (self)
None	async_turn_off (self)
None	async_turn_on (self)
None	async_unjoin_player (self)
None	async_volume_down (self)
None	async_volume_up (self)
dict[str, Any]	capability_attributes (self)
None	clear_playlist (self)
MediaPlayerDeviceClass|None	device_class (self)
str|None	entity_picture (self)
str	get_browse_image_url (self, str media_content_type, str media_content_id, str|None media_image_id=None)
list[str]|None	group_members (self)
None	join_players (self, list[str] group_members)
str|None	media_album_artist (self)
str|None	media_channel (self)
MediaType|str|None	media_content_type (self)
int|None	media_duration (self)
str|None	media_episode (self)
str|None	media_image_hash (self)
str|None	media_image_local (self)
bool	media_image_remotely_accessible (self)
int|None	media_position (self)
dt.datetime|None	media_position_updated_at (self)
str|None	media_season (self)
None	media_seek (self, float position)
str|None	media_series_title (self)
None	media_stop (self)
int|None	media_track (self)
RepeatMode|str|None	repeat (self)
None	select_sound_mode (self, str sound_mode)
None	select_source (self, str source)
None	set_repeat (self, RepeatMode repeat)
str|None	sound_mode (self)
list[str]|None	sound_mode_list (self)
str|None	source (self)
list[str]|None	source_list (self)
dict[str, Any]	state_attributes (self)
bool	support_clear_playlist (self)
bool	support_grouping (self)
bool	support_next_track (self)
bool	support_pause (self)
bool	support_play (self)
bool	support_play_media (self)
bool	support_previous_track (self)
bool	support_seek (self)
bool	support_select_sound_mode (self)
bool	support_select_source (self)
bool	support_shuffle_set (self)
bool	support_stop (self)
bool	support_volume_mute (self)
bool	support_volume_set (self)
MediaPlayerEntityFeature	supported_features (self)
MediaPlayerEntityFeature	supported_features_compat (self)
None	turn_on (self)
None	unjoin_player (self)
float	volume_step (self)
Public Member Functions inherited from homeassistant.helpers.entity.Entity
None	__init_subclass__ (cls, **Any kwargs)
str	__repr__ (self)
None	add_to_platform_abort (self)
None	add_to_platform_finish (self)
None	add_to_platform_start (self, HomeAssistant hass, EntityPlatform platform, asyncio.Semaphore|None parallel_updates)
bool	assumed_state (self)
None	async_added_to_hass (self)
None	async_device_update (self, bool warning=True)
None	async_internal_added_to_hass (self)
None	async_internal_will_remove_from_hass (self)
None	async_on_remove (self, CALLBACK_TYPE func)
None	async_registry_entry_updated (self)
None	async_remove (self, *bool force_remove=False)
None	async_removed_from_registry (self)
None	async_schedule_update_ha_state (self, bool force_refresh=False)
None	async_set_context (self, Context context)
None	async_update_ha_state (self, bool force_refresh=False)
None	async_will_remove_from_hass (self)
None	async_write_ha_state (self)
str|None	attribution (self)
bool	available (self)
DeviceInfo|None	device_info (self)
bool	enabled (self)
EntityCategory|None	entity_category (self)
bool	entity_registry_enabled_default (self)
bool	entity_registry_visible_default (self)
Mapping[str, Any]|None	extra_state_attributes (self)
bool	force_update (self)
HassJobType	get_hassjob_type (self, str function_name)
er.EntityOptionsType|None	get_initial_entity_options (self)
bool	has_entity_name (self)
str|None	icon (self)
None	schedule_update_ha_state (self, bool force_refresh=False)
bool	should_poll (self)
str|None	suggested_object_id (self)
str|None	translation_key (self)
Mapping[str, str]	translation_placeholders (self)
str|None	unique_id (self)
str|None	unit_of_measurement (self)
bool	use_device_name (self)
Public Member Functions inherited from homeassistant.helpers.entity.CachedProperties
None	__init__ (cls, str name, tuple[type,...] bases, dict[Any, Any] namespace, **Any kwargs)
Any	__new__ (mcs, str name, tuple[type,...] bases, dict[Any, Any] namespace, set[str]|None cached_properties=None, **Any kwargs)

Public Attributes
	airplay_devices
	client
	content_id
	current_album
	current_artist
	current_playlist
	current_title
	current_volume
	muted
	player_state
	shuffled
Public Attributes inherited from homeassistant.components.media_player.MediaPlayerEntity
	state
Public Attributes inherited from homeassistant.helpers.entity.Entity
	device_entry
	entity_id
	hass
	parallel_updates
	platform
	registry_entry

Private Attributes
	_add_entities
	_host
	_name
	_port
	_use_ssl

Static Private Attributes
	_attr_media_content_type = MediaType.MUSIC
tuple	_attr_supported_features

Additional Inherited Members
Static Public Attributes inherited from homeassistant.components.media_player.MediaPlayerEntity
	bool
	MediaPlayerEntityFeature
	None
Static Public Attributes inherited from homeassistant.helpers.entity.Entity
	bool
	EntityPlatform
	HomeAssistant
	None
	StateInfo
	StateType
	str

Detailed Description

Representation of an iTunes API instance.

Definition at line 184 of file media_player.py.

Constructor & Destructor Documentation

__init__()

def homeassistant.components.itunes.media_player.ItunesDevice.__init__	(		self,
			name,
			host,
			port,
			use_ssl,
			add_entities
	)

Initialize the iTunes device.

Definition at line 201 of file media_player.py.

Member Function Documentation

is_volume_muted()

def homeassistant.components.itunes.media_player.ItunesDevice.is_volume_muted

(

self

)

Boolean if volume is currently muted.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 291 of file media_player.py.

media_album_name()

def homeassistant.components.itunes.media_player.ItunesDevice.media_album_name

(

self

)

Album of current playing media (Music track only).

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 335 of file media_player.py.

media_artist()

def homeassistant.components.itunes.media_player.ItunesDevice.media_artist

(

self

)

Artist of current playing media (Music track only).

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 330 of file media_player.py.

media_content_id()

def homeassistant.components.itunes.media_player.ItunesDevice.media_content_id

(

self

)

Content ID of current playing media.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 301 of file media_player.py.

media_image_url()

def homeassistant.components.itunes.media_player.ItunesDevice.media_image_url

(

self

)

Image url of current playing media.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 306 of file media_player.py.

media_next_track()

None homeassistant.components.itunes.media_player.ItunesDevice.media_next_track

(

self

)

Send media_next command to media player.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 374 of file media_player.py.

media_pause()

None homeassistant.components.itunes.media_player.ItunesDevice.media_pause

(

self

)

Send media_pause command to media player.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 369 of file media_player.py.

media_play()

None homeassistant.components.itunes.media_player.ItunesDevice.media_play

(

self

)

Send media_play command to media player.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 364 of file media_player.py.

media_playlist()

def homeassistant.components.itunes.media_player.ItunesDevice.media_playlist

(

self

)

Title of the currently playing playlist.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 340 of file media_player.py.

media_previous_track()

None homeassistant.components.itunes.media_player.ItunesDevice.media_previous_track

(

self

)

Send media_previous command media player.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 379 of file media_player.py.

media_title()

def homeassistant.components.itunes.media_player.ItunesDevice.media_title

(

self

)

Title of current playing media.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 325 of file media_player.py.

mute_volume()

None homeassistant.components.itunes.media_player.ItunesDevice.mute_volume	(		self,
		bool	mute
	)

Mute (true) or unmute (false) media player.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 354 of file media_player.py.

name()

def homeassistant.components.itunes.media_player.ItunesDevice.name

(

self

)

Return the name of the device.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 242 of file media_player.py.

play_media()

None homeassistant.components.itunes.media_player.ItunesDevice.play_media	(		self,
		MediaType | str	media_type,
		str	media_id,
		**Any	kwargs
	)

Send the play_media command to the media player.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 384 of file media_player.py.

set_shuffle()

None homeassistant.components.itunes.media_player.ItunesDevice.set_shuffle	(		self,
		bool	shuffle
	)

Shuffle (true) or no shuffle (false) media player.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 359 of file media_player.py.

set_volume_level()

None homeassistant.components.itunes.media_player.ItunesDevice.set_volume_level	(		self,
		float	volume
	)

Set volume level, range 0..1.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 349 of file media_player.py.

shuffle()

def homeassistant.components.itunes.media_player.ItunesDevice.shuffle

(

self

)

Boolean if shuffle is enabled.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 345 of file media_player.py.

state()

def homeassistant.components.itunes.media_player.ItunesDevice.state

(

self

)

Return the state of the device.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 247 of file media_player.py.

turn_off()

None homeassistant.components.itunes.media_player.ItunesDevice.turn_off

(

self

)

Turn the media player off.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 392 of file media_player.py.

update()

None homeassistant.components.itunes.media_player.ItunesDevice.update

(

self

)

Retrieve latest state.

Definition at line 263 of file media_player.py.

update_state()

def homeassistant.components.itunes.media_player.ItunesDevice.update_state	(		self,
			state_hash
	)

Update all the state properties with the passed in dictionary.

Definition at line 226 of file media_player.py.

volume_level()

def homeassistant.components.itunes.media_player.ItunesDevice.volume_level

(

self

)

Volume level of the media player (0..1).

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 296 of file media_player.py.

Member Data Documentation

_add_entities

homeassistant.components.itunes.media_player.ItunesDevice._add_entities

private

Definition at line 207 of file media_player.py.

_attr_media_content_type

homeassistant.components.itunes.media_player.ItunesDevice._attr_media_content_type = MediaType.MUSIC

staticprivate

Definition at line 187 of file media_player.py.

_attr_supported_features

tuple homeassistant.components.itunes.media_player.ItunesDevice._attr_supported_features

staticprivate

Initial value:

=  (
        MediaPlayerEntityFeature.PAUSE
        | MediaPlayerEntityFeature.VOLUME_SET
        | MediaPlayerEntityFeature.VOLUME_MUTE
        | MediaPlayerEntityFeature.PREVIOUS_TRACK
        | MediaPlayerEntityFeature.NEXT_TRACK
        | MediaPlayerEntityFeature.SEEK
        | MediaPlayerEntityFeature.PLAY_MEDIA
        | MediaPlayerEntityFeature.PLAY
        | MediaPlayerEntityFeature.TURN_OFF
        | MediaPlayerEntityFeature.SHUFFLE_SET
    )

Definition at line 188 of file media_player.py.

_host

homeassistant.components.itunes.media_player.ItunesDevice._host

private

Definition at line 204 of file media_player.py.

_name

homeassistant.components.itunes.media_player.ItunesDevice._name

private

Definition at line 203 of file media_player.py.

_port

homeassistant.components.itunes.media_player.ItunesDevice._port

private

Definition at line 205 of file media_player.py.

_use_ssl

homeassistant.components.itunes.media_player.ItunesDevice._use_ssl

private

Definition at line 206 of file media_player.py.

airplay_devices

homeassistant.components.itunes.media_player.ItunesDevice.airplay_devices

Definition at line 222 of file media_player.py.

client

homeassistant.components.itunes.media_player.ItunesDevice.client

Definition at line 209 of file media_player.py.

content_id

homeassistant.components.itunes.media_player.ItunesDevice.content_id

Definition at line 218 of file media_player.py.

current_album

homeassistant.components.itunes.media_player.ItunesDevice.current_album

Definition at line 215 of file media_player.py.

current_artist

homeassistant.components.itunes.media_player.ItunesDevice.current_artist

Definition at line 216 of file media_player.py.

current_playlist

homeassistant.components.itunes.media_player.ItunesDevice.current_playlist

Definition at line 217 of file media_player.py.

current_title

homeassistant.components.itunes.media_player.ItunesDevice.current_title

Definition at line 214 of file media_player.py.

current_volume

homeassistant.components.itunes.media_player.ItunesDevice.current_volume

Definition at line 211 of file media_player.py.

muted

homeassistant.components.itunes.media_player.ItunesDevice.muted

Definition at line 212 of file media_player.py.

player_state

homeassistant.components.itunes.media_player.ItunesDevice.player_state

Definition at line 220 of file media_player.py.

shuffled

homeassistant.components.itunes.media_player.ItunesDevice.shuffled

Definition at line 213 of file media_player.py.

---

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

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