homeassistant.components.apple_tv.media_player.AppleTvMediaPlayer Class Reference

Inheritance diagram for homeassistant.components.apple_tv.media_player.AppleTvMediaPlayer:

Collaboration diagram for homeassistant.components.apple_tv.media_player.AppleTvMediaPlayer:

Public Member Functions
None	__init__ (self, str name, str identifier, AppleTVManager manager)
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_device_connected (self, AppleTV atv)
None	async_device_disconnected (self)
tuple[bytes|None, str|None]	async_get_media_image (self)
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_play_media (self, MediaType|str media_type, str media_id, **Any kwargs)
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_turn_off (self)
None	async_turn_on (self)
None	async_volume_down (self)
None	async_volume_up (self)
str|None	media_album_name (self)
str|None	media_artist (self)
str|None	media_content_id (self)
MediaType|None	media_content_type (self)
int|None	media_duration (self)
str|None	media_episode (self)
str|None	media_image_hash (self)
int|None	media_position (self)
datetime|None	media_position_updated_at (self)
str|None	media_season (self)
str|None	media_series_title (self)
str|None	media_title (self)
None	outputdevices_update (self, list[OutputDevice] old_devices, list[OutputDevice] new_devices)
None	playstatus_error (self, PushUpdater updater, Exception exception)
None	playstatus_update (self, PushUpdater updater, Playing playstatus)
None	powerstate_update (self, PowerState old_state, PowerState new_state)
RepeatMode|None	repeat (self)
bool|None	shuffle (self)
list[str]	source_list (self)
MediaPlayerState|None	state (self)
float|None	volume_level (self)
None	volume_update (self, float old_level, float new_level)
Public Member Functions inherited from homeassistant.components.apple_tv.entity.AppleTVEntity
None	async_added_to_hass (self)
None	async_device_connected (self, AppleTVInterface atv)
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_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)
str|UndefinedType|None	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 Member Functions inherited from homeassistant.components.media_player.MediaPlayerEntity
str	access_token (self)
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)
None	async_join_players (self, list[str] group_members)
None	async_mute_volume (self, bool mute)
None	async_select_sound_mode (self, str sound_mode)
None	async_toggle (self)
None	async_unjoin_player (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_channel (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)
None	media_previous_track (self)
None	media_seek (self, float position)
None	media_stop (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)
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)
None	set_volume_level (self, float volume)
str|None	sound_mode (self)
list[str]|None	sound_mode_list (self)
str|None	source (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_off (self)
None	turn_on (self)
None	unjoin_player (self)
float	volume_step (self)

Private Member Functions
bool	_is_feature_available (self, FeatureName feature)
None	_update_app_list (self)

Private Attributes
	_app_list
	_playing

Static Private Attributes
	_attr_supported_features = SUPPORT_APPLE_TV

Additional Inherited Members
Public Attributes inherited from homeassistant.components.apple_tv.entity.AppleTVEntity
	atv
	manager
Public Attributes inherited from homeassistant.helpers.entity.Entity
	device_entry
	entity_id
	hass
	parallel_updates
	platform
	registry_entry
Public Attributes inherited from homeassistant.components.media_player.MediaPlayerEntity
	state
Static Public Attributes inherited from homeassistant.components.apple_tv.entity.AppleTVEntity
	None
Static Public Attributes inherited from homeassistant.helpers.entity.Entity
	bool
	EntityPlatform
	HomeAssistant
	None
	StateInfo
	StateType
	str
Static Public Attributes inherited from homeassistant.components.media_player.MediaPlayerEntity
	bool
	MediaPlayerEntityFeature
	None

Detailed Description

Representation of an Apple TV media player.

Definition at line 112 of file media_player.py.

Constructor & Destructor Documentation

__init__()

None homeassistant.components.apple_tv.media_player.AppleTvMediaPlayer.__init__	(		self,
		str	name,
		str	identifier,
		AppleTVManager	manager
	)

Initialize the Apple TV media player.

Reimplemented from homeassistant.components.apple_tv.entity.AppleTVEntity.

Definition at line 119 of file media_player.py.

Member Function Documentation

_is_feature_available()

bool homeassistant.components.apple_tv.media_player.AppleTvMediaPlayer._is_feature_available (   self, FeatureName  feature  )

private

Return if a feature is available.

Definition at line 442 of file media_player.py.

_update_app_list()

None homeassistant.components.apple_tv.media_player.AppleTvMediaPlayer._update_app_list (   self )

private

Definition at line 159 of file media_player.py.

app_id()

str | None homeassistant.components.apple_tv.media_player.AppleTvMediaPlayer.app_id

(

self

)

ID of the current running app.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 250 of file media_player.py.

app_name()

str | None homeassistant.components.apple_tv.media_player.AppleTvMediaPlayer.app_name

(

self

)

Name of the current running app.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 261 of file media_player.py.

async_browse_media()

BrowseMedia homeassistant.components.apple_tv.media_player.AppleTvMediaPlayer.async_browse_media	(		self,
		MediaType | str | None	media_content_type = None,
		str | None	media_content_id = None
	)

Implement the websocket media browsing helper.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 448 of file media_player.py.

async_device_connected()

None homeassistant.components.apple_tv.media_player.AppleTvMediaPlayer.async_device_connected	(		self,
		AppleTV	atv
	)

Handle when connection is made to device.

Definition at line 126 of file media_player.py.

async_device_disconnected()

None homeassistant.components.apple_tv.media_player.AppleTvMediaPlayer.async_device_disconnected

(

self

)

Handle when connection was lost to device.

Reimplemented from homeassistant.components.apple_tv.entity.AppleTVEntity.

Definition at line 178 of file media_player.py.

async_get_media_image()

tuple[bytes | None, str | None] homeassistant.components.apple_tv.media_player.AppleTvMediaPlayer.async_get_media_image

(

self

)

Fetch media image of current playing image.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 365 of file media_player.py.

async_media_next_track()

None homeassistant.components.apple_tv.media_player.AppleTvMediaPlayer.async_media_next_track

(

self

)

Send next track command.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 523 of file media_player.py.

async_media_pause()

None homeassistant.components.apple_tv.media_player.AppleTvMediaPlayer.async_media_pause

(

self

)

Pause the media player.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 518 of file media_player.py.

async_media_play()

None homeassistant.components.apple_tv.media_player.AppleTvMediaPlayer.async_media_play

(

self

)

Play media.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 508 of file media_player.py.

async_media_play_pause()

None homeassistant.components.apple_tv.media_player.AppleTvMediaPlayer.async_media_play_pause

(

self

)

Pause media on media player.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 503 of file media_player.py.

async_media_previous_track()

None homeassistant.components.apple_tv.media_player.AppleTvMediaPlayer.async_media_previous_track

(

self

)

Send previous track command.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 528 of file media_player.py.

async_media_seek()

None homeassistant.components.apple_tv.media_player.AppleTvMediaPlayer.async_media_seek	(		self,
		float	position
	)

Send seek command.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 533 of file media_player.py.

async_media_stop()

None homeassistant.components.apple_tv.media_player.AppleTvMediaPlayer.async_media_stop

(

self

)

Stop the media player.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 513 of file media_player.py.

async_play_media()

None homeassistant.components.apple_tv.media_player.AppleTvMediaPlayer.async_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 322 of file media_player.py.

async_select_source()

None homeassistant.components.apple_tv.media_player.AppleTvMediaPlayer.async_select_source	(		self,
		str	source
	)

Select input source.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 570 of file media_player.py.

async_set_repeat()

None homeassistant.components.apple_tv.media_player.AppleTvMediaPlayer.async_set_repeat	(		self,
		RepeatMode	repeat
	)

Set repeat mode.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 554 of file media_player.py.

async_set_shuffle()

None homeassistant.components.apple_tv.media_player.AppleTvMediaPlayer.async_set_shuffle	(		self,
		bool	shuffle
	)

Enable/disable shuffle mode.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 563 of file media_player.py.

async_set_volume_level()

None homeassistant.components.apple_tv.media_player.AppleTvMediaPlayer.async_set_volume_level	(		self,
		float	volume
	)

Set volume level, range 0..1.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 548 of file media_player.py.

async_turn_off()

None homeassistant.components.apple_tv.media_player.AppleTvMediaPlayer.async_turn_off

(

self

)

Turn the media player off.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 491 of file media_player.py.

async_turn_on()

None homeassistant.components.apple_tv.media_player.AppleTvMediaPlayer.async_turn_on

(

self

)

Turn the media player on.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 486 of file media_player.py.

async_volume_down()

None homeassistant.components.apple_tv.media_player.AppleTvMediaPlayer.async_volume_down

(

self

)

Turn volume down for media player.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 543 of file media_player.py.

async_volume_up()

None homeassistant.components.apple_tv.media_player.AppleTvMediaPlayer.async_volume_up

(

self

)

Turn volume up for media player.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 538 of file media_player.py.

media_album_name()

str | None homeassistant.components.apple_tv.media_player.AppleTvMediaPlayer.media_album_name

(

self

)

Album name of current playing media, music track only.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 394 of file media_player.py.

media_artist()

str | None homeassistant.components.apple_tv.media_player.AppleTvMediaPlayer.media_artist

(

self

)

Artist of current playing media, music track only.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 387 of file media_player.py.

media_content_id()

str | None homeassistant.components.apple_tv.media_player.AppleTvMediaPlayer.media_content_id

(

self

)

Content ID of current playing media.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 288 of file media_player.py.

media_content_type()

MediaType | None homeassistant.components.apple_tv.media_player.AppleTvMediaPlayer.media_content_type

(

self

)

Content type of current playing media.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 277 of file media_player.py.

media_duration()

int | None homeassistant.components.apple_tv.media_player.AppleTvMediaPlayer.media_duration

(

self

)

Duration of current playing media in seconds.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 302 of file media_player.py.

media_episode()

str | None homeassistant.components.apple_tv.media_player.AppleTvMediaPlayer.media_episode

(

self

)

Episode of current playing media, TV show only.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 415 of file media_player.py.

media_image_hash()

str | None homeassistant.components.apple_tv.media_player.AppleTvMediaPlayer.media_image_hash

(

self

)

Hash value for media image.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 353 of file media_player.py.

media_position()

int | None homeassistant.components.apple_tv.media_player.AppleTvMediaPlayer.media_position

(

self

)

Position of current playing media in seconds.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 309 of file media_player.py.

media_position_updated_at()

datetime | None homeassistant.components.apple_tv.media_player.AppleTvMediaPlayer.media_position_updated_at

(

self

)

Last valid time of media position.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 316 of file media_player.py.

media_season()

str | None homeassistant.components.apple_tv.media_player.AppleTvMediaPlayer.media_season

(

self

)

Season of current playing media, TV show only.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 408 of file media_player.py.

media_series_title()

str | None homeassistant.components.apple_tv.media_player.AppleTvMediaPlayer.media_series_title

(

self

)

Title of series of current playing media, TV show only.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 401 of file media_player.py.

media_title()

str | None homeassistant.components.apple_tv.media_player.AppleTvMediaPlayer.media_title

(

self

)

Title of current playing media.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 380 of file media_player.py.

outputdevices_update()

None homeassistant.components.apple_tv.media_player.AppleTvMediaPlayer.outputdevices_update	(		self,
		list[OutputDevice]	old_devices,
		list[OutputDevice]	new_devices
	)

Output devices were updated.

This is a callback function from pyatv.interface.AudioListener.

Definition at line 241 of file media_player.py.

playstatus_error()

None homeassistant.components.apple_tv.media_player.AppleTvMediaPlayer.playstatus_error	(		self,
		PushUpdater	updater,
		Exception	exception
	)

Inform about an error and restart push updates.

This is a callback function from pyatv.interface.PushListener.

Definition at line 215 of file media_player.py.

playstatus_update()

None homeassistant.components.apple_tv.media_player.AppleTvMediaPlayer.playstatus_update	(		self,
		PushUpdater	updater,
		Playing	playstatus
	)

Print what is currently playing when it changes.

This is a callback function from pyatv.interface.PushListener.

Definition at line 206 of file media_player.py.

powerstate_update()

None homeassistant.components.apple_tv.media_player.AppleTvMediaPlayer.powerstate_update	(		self,
		PowerState	old_state,
		PowerState	new_state
	)

Update power state when it changes.

This is a callback function from pyatv.interface.PowerListener.

Definition at line 225 of file media_player.py.

repeat()

RepeatMode | None homeassistant.components.apple_tv.media_player.AppleTvMediaPlayer.repeat

(

self

)

Return current repeat mode.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 422 of file media_player.py.

shuffle()

bool | None homeassistant.components.apple_tv.media_player.AppleTvMediaPlayer.shuffle

(

self

)

Boolean if shuffle is enabled.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 436 of file media_player.py.

source_list()

list[str] homeassistant.components.apple_tv.media_player.AppleTvMediaPlayer.source_list

(

self

)

List of available input sources.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 272 of file media_player.py.

state()

MediaPlayerState | None homeassistant.components.apple_tv.media_player.AppleTvMediaPlayer.state

(

self

)

Return the state of the device.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 183 of file media_player.py.

volume_level()

float | None homeassistant.components.apple_tv.media_player.AppleTvMediaPlayer.volume_level

(

self

)

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

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 295 of file media_player.py.

volume_update()

None homeassistant.components.apple_tv.media_player.AppleTvMediaPlayer.volume_update	(		self,
		float	old_level,
		float	new_level
	)

Update volume when it changes.

This is a callback function from pyatv.interface.AudioListener.

Definition at line 233 of file media_player.py.

Member Data Documentation

_app_list

homeassistant.components.apple_tv.media_player.AppleTvMediaPlayer._app_list

private

Definition at line 170 of file media_player.py.

_attr_supported_features

homeassistant.components.apple_tv.media_player.AppleTvMediaPlayer._attr_supported_features = SUPPORT_APPLE_TV

staticprivate

Definition at line 117 of file media_player.py.

_playing

homeassistant.components.apple_tv.media_player.AppleTvMediaPlayer._playing

private

Definition at line 211 of file media_player.py.

---

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

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