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

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

Public Member Functions
def	__init__ (self, device_id, client)

def	icon (self)

def	name (self)

None	set_volume_level (self, float volume)

MediaPlayerState	state (self)

None	turn_off (self)

None	turn_on (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)

bool\|None	is_volume_muted (self)

None	join_players (self, list[str] group_members)

str\|None	media_album_artist (self)

str\|None	media_album_name (self)

str\|None	media_artist (self)

str\|None	media_channel (self)

str\|None	media_content_id (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)

str\|None	media_image_url (self)

None	media_next_track (self)

None	media_pause (self)

None	media_play (self)

str\|None	media_playlist (self)

int\|None	media_position (self)

dt.datetime\|None	media_position_updated_at (self)

None	media_previous_track (self)

str\|None	media_season (self)

None	media_seek (self, float position)

str\|None	media_series_title (self)

None	media_stop (self)

str\|None	media_title (self)

int\|None	media_track (self)

None	mute_volume (self, bool mute)

None	play_media (self, MediaType\|str media_type, str media_id, **Any kwargs)

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)

None	set_shuffle (self, bool shuffle)

bool\|None	shuffle (self)

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	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)

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
	active

	client

	device_name

	kind

	player_state

	selected

	supports_audio

	supports_video

	volume

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
	_id

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 an AirPlay device via an iTunes API instance.

Definition at line 398 of file media_player.py.

Constructor & Destructor Documentation

◆ init()

def homeassistant.components.itunes.media_player.AirPlayDevice.__init__	(	self,
		device_id,
		client
	)

Initialize the AirPlay device.

Definition at line 408 of file media_player.py.

Member Function Documentation

◆ icon()

def homeassistant.components.itunes.media_player.AirPlayDevice.icon ( self )

Return the icon to use in the frontend, if any.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 454 of file media_player.py.

◆ name()

def homeassistant.components.itunes.media_player.AirPlayDevice.name ( self )

Return the name of the device.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 449 of file media_player.py.

◆ set_volume_level()

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

Set volume level, range 0..1.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 477 of file media_player.py.

◆ state()

MediaPlayerState homeassistant.components.itunes.media_player.AirPlayDevice.state ( self )

Return the state of the device.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 462 of file media_player.py.

◆ turn_off()

None homeassistant.components.itunes.media_player.AirPlayDevice.turn_off ( self )

Deselect AirPlay.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 490 of file media_player.py.

◆ turn_on()

None homeassistant.components.itunes.media_player.AirPlayDevice.turn_on ( self )

Select AirPlay.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 483 of file media_player.py.

◆ update()

None homeassistant.components.itunes.media_player.AirPlayDevice.update ( self )

Retrieve latest state.

Definition at line 469 of file media_player.py.

◆ update_state()

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

Update all the state properties with the passed in dictionary.

Definition at line 421 of file media_player.py.

◆ volume_level()

def homeassistant.components.itunes.media_player.AirPlayDevice.volume_level ( self )

Return the volume.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 473 of file media_player.py.

Member Data Documentation

◆ _attr_media_content_type

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

staticprivate

Definition at line 401 of file media_player.py.

◆ _attr_supported_features

tuple homeassistant.components.itunes.media_player.AirPlayDevice._attr_supported_features

staticprivate

Initial value:

=  (
        MediaPlayerEntityFeature.VOLUME_SET
        | MediaPlayerEntityFeature.TURN_ON
        | MediaPlayerEntityFeature.TURN_OFF
    )

Definition at line 402 of file media_player.py.

◆ _id

homeassistant.components.itunes.media_player.AirPlayDevice._id

private

Definition at line 410 of file media_player.py.

◆ active

homeassistant.components.itunes.media_player.AirPlayDevice.active

Definition at line 414 of file media_player.py.

◆ client

homeassistant.components.itunes.media_player.AirPlayDevice.client

Definition at line 411 of file media_player.py.

◆ device_name

homeassistant.components.itunes.media_player.AirPlayDevice.device_name

Definition at line 412 of file media_player.py.

◆ kind

homeassistant.components.itunes.media_player.AirPlayDevice.kind

Definition at line 413 of file media_player.py.

◆ player_state

homeassistant.components.itunes.media_player.AirPlayDevice.player_state

Definition at line 419 of file media_player.py.

◆ selected

homeassistant.components.itunes.media_player.AirPlayDevice.selected

Definition at line 415 of file media_player.py.

◆ supports_audio

homeassistant.components.itunes.media_player.AirPlayDevice.supports_audio

Definition at line 417 of file media_player.py.

◆ supports_video

homeassistant.components.itunes.media_player.AirPlayDevice.supports_video

Definition at line 418 of file media_player.py.

◆ volume

homeassistant.components.itunes.media_player.AirPlayDevice.volume

Definition at line 416 of file media_player.py.

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

core/homeassistant/components/itunes/media_player.py

Home Assistant Unofficial Reference 2024.12.1

Public Member Functions

Public Attributes

Private Attributes

Static Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __init__()

Member Function Documentation

◆ icon()

◆ name()

◆ set_volume_level()

◆ state()

◆ turn_off()

◆ turn_on()

◆ update()

◆ update_state()

◆ volume_level()

Member Data Documentation

◆ _attr_media_content_type

◆ _attr_supported_features

◆ _id

◆ active

◆ client

◆ device_name

◆ kind

◆ player_state

◆ selected

◆ supports_audio

◆ supports_video

◆ volume

◆ init()