homeassistant.components.androidtv_remote.media_player.AndroidTVRemoteMediaPlayerEntity Class Reference

Inheritance diagram for homeassistant.components.androidtv_remote.media_player.AndroidTVRemoteMediaPlayerEntity:

Collaboration diagram for homeassistant.components.androidtv_remote.media_player.AndroidTVRemoteMediaPlayerEntity:

Public Member Functions
None	__init__ (self, AndroidTVRemote api, AndroidTVRemoteConfigEntry config_entry)
None	async_added_to_hass (self)
BrowseMedia	async_browse_media (self, MediaType|str|None media_content_type=None, str|None media_content_id=None)
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_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_turn_off (self)
None	async_turn_on (self)
None	async_volume_down (self)
None	async_volume_up (self)
None	async_will_remove_from_hass (self)
MediaPlayerState	state (self)
Public Member Functions inherited from homeassistant.components.androidtv_remote.entity.AndroidTVRemoteBaseEntity
None	__init__ (self, AndroidTVRemote api, ConfigEntry config_entry)
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_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)
str|None	app_id (self)
str|None	app_name (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)
tuple[bytes|None, str|None]	async_get_media_image (self)
None	async_join_players (self, list[str] group_members)
None	async_media_seek (self, float position)
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_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_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)
None	set_volume_level (self, float volume)
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	turn_off (self)
None	turn_on (self)
None	unjoin_player (self)
float|None	volume_level (self)
float	volume_step (self)

Private Member Functions
None	_current_app_updated (self, str current_app)
None	_send_key_commands (self, list[str] key_codes, float delay_secs=0.1)
None	_update_current_app (self, str current_app)
None	_update_volume_info (self, dict[str, str|bool] volume_info)
None	_volume_info_updated (self, dict[str, str|bool] volume_info)

Private Attributes
	_attr_app_id
	_attr_app_name
	_attr_is_volume_muted
	_attr_volume_level
	_channel_set_task

Static Private Attributes
bool	_attr_assumed_state = True
	_attr_device_class = MediaPlayerDeviceClass.TV
tuple	_attr_supported_features

Additional Inherited Members
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.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

Android TV Remote Media Player Entity.

Definition at line 40 of file media_player.py.

Constructor & Destructor Documentation

__init__()

None homeassistant.components.androidtv_remote.media_player.AndroidTVRemoteMediaPlayerEntity.__init__	(		self,
		AndroidTVRemote	api,
		AndroidTVRemoteConfigEntry	config_entry
	)

Initialize the entity.

Definition at line 59 of file media_player.py.

Member Function Documentation

_current_app_updated()

None homeassistant.components.androidtv_remote.media_player.AndroidTVRemoteMediaPlayerEntity._current_app_updated (   self, str  current_app  )

private

Update the state when the current app changes.

Definition at line 90 of file media_player.py.

_send_key_commands()

None homeassistant.components.androidtv_remote.media_player.AndroidTVRemoteMediaPlayerEntity._send_key_commands (   self, list[str]  key_codes, float   delay_secs = 0.1  )

private

Send a key press sequence to Android TV.

The delay is necessary because device may ignore
some commands if we send the sequence without delay.

Definition at line 222 of file media_player.py.

_update_current_app()

None homeassistant.components.androidtv_remote.media_player.AndroidTVRemoteMediaPlayerEntity._update_current_app (   self, str  current_app  )

private

Update current app info.

Definition at line 69 of file media_player.py.

_update_volume_info()

None homeassistant.components.androidtv_remote.media_player.AndroidTVRemoteMediaPlayerEntity._update_volume_info (   self, dict[str, str | bool]  volume_info  )

private

Update volume info.

Definition at line 78 of file media_player.py.

_volume_info_updated()

None homeassistant.components.androidtv_remote.media_player.AndroidTVRemoteMediaPlayerEntity._volume_info_updated (   self, dict[str, str | bool]  volume_info  )

private

Update the state when the volume info changes.

Definition at line 96 of file media_player.py.

async_added_to_hass()

None homeassistant.components.androidtv_remote.media_player.AndroidTVRemoteMediaPlayerEntity.async_added_to_hass

(

self

)

Register callbacks.

Reimplemented from homeassistant.components.androidtv_remote.entity.AndroidTVRemoteBaseEntity.

Definition at line 101 of file media_player.py.

async_browse_media()

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

Browse apps.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 193 of file media_player.py.

async_media_next_track()

None homeassistant.components.androidtv_remote.media_player.AndroidTVRemoteMediaPlayerEntity.async_media_next_track

(

self

)

Send next track command.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 168 of file media_player.py.

async_media_pause()

None homeassistant.components.androidtv_remote.media_player.AndroidTVRemoteMediaPlayerEntity.async_media_pause

(

self

)

Send pause command.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 152 of file media_player.py.

async_media_play()

None homeassistant.components.androidtv_remote.media_player.AndroidTVRemoteMediaPlayerEntity.async_media_play

(

self

)

Send play command.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 148 of file media_player.py.

async_media_play_pause()

None homeassistant.components.androidtv_remote.media_player.AndroidTVRemoteMediaPlayerEntity.async_media_play_pause

(

self

)

Send play/pause command.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 156 of file media_player.py.

async_media_previous_track()

None homeassistant.components.androidtv_remote.media_player.AndroidTVRemoteMediaPlayerEntity.async_media_previous_track

(

self

)

Send previous track command.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 164 of file media_player.py.

async_media_stop()

None homeassistant.components.androidtv_remote.media_player.AndroidTVRemoteMediaPlayerEntity.async_media_stop

(

self

)

Send stop command.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 160 of file media_player.py.

async_mute_volume()

None homeassistant.components.androidtv_remote.media_player.AndroidTVRemoteMediaPlayerEntity.async_mute_volume	(		self,
		bool	mute
	)

Mute the volume.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 143 of file media_player.py.

async_play_media()

None homeassistant.components.androidtv_remote.media_player.AndroidTVRemoteMediaPlayerEntity.async_play_media	(		self,
		MediaType | str	media_type,
		str	media_id,
		**Any	kwargs
	)

Play a piece of media.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 172 of file media_player.py.

async_turn_off()

None homeassistant.components.androidtv_remote.media_player.AndroidTVRemoteMediaPlayerEntity.async_turn_off

(

self

)

Turn the Android TV off.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 130 of file media_player.py.

async_turn_on()

None homeassistant.components.androidtv_remote.media_player.AndroidTVRemoteMediaPlayerEntity.async_turn_on

(

self

)

Turn the Android TV on.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 125 of file media_player.py.

async_volume_down()

None homeassistant.components.androidtv_remote.media_player.AndroidTVRemoteMediaPlayerEntity.async_volume_down

(

self

)

Turn volume down for media player.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 139 of file media_player.py.

async_volume_up()

None homeassistant.components.androidtv_remote.media_player.AndroidTVRemoteMediaPlayerEntity.async_volume_up

(

self

)

Turn volume up for media player.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 135 of file media_player.py.

async_will_remove_from_hass()

None homeassistant.components.androidtv_remote.media_player.AndroidTVRemoteMediaPlayerEntity.async_will_remove_from_hass

(

self

)

Remove callbacks.

Reimplemented from homeassistant.components.androidtv_remote.entity.AndroidTVRemoteBaseEntity.

Definition at line 111 of file media_player.py.

state()

MediaPlayerState homeassistant.components.androidtv_remote.media_player.AndroidTVRemoteMediaPlayerEntity.state

(

self

)

Return the state of the device.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 119 of file media_player.py.

Member Data Documentation

_attr_app_id

homeassistant.components.androidtv_remote.media_player.AndroidTVRemoteMediaPlayerEntity._attr_app_id

private

Definition at line 71 of file media_player.py.

_attr_app_name

homeassistant.components.androidtv_remote.media_player.AndroidTVRemoteMediaPlayerEntity._attr_app_name

private

Definition at line 72 of file media_player.py.

_attr_assumed_state

bool homeassistant.components.androidtv_remote.media_player.AndroidTVRemoteMediaPlayerEntity._attr_assumed_state = True

staticprivate

Definition at line 43 of file media_player.py.

_attr_device_class

homeassistant.components.androidtv_remote.media_player.AndroidTVRemoteMediaPlayerEntity._attr_device_class = MediaPlayerDeviceClass.TV

staticprivate

Definition at line 44 of file media_player.py.

_attr_is_volume_muted

homeassistant.components.androidtv_remote.media_player.AndroidTVRemoteMediaPlayerEntity._attr_is_volume_muted

private

Definition at line 84 of file media_player.py.

_attr_supported_features

tuple homeassistant.components.androidtv_remote.media_player.AndroidTVRemoteMediaPlayerEntity._attr_supported_features

staticprivate

Initial value:

=  (
        MediaPlayerEntityFeature.PAUSE
        | MediaPlayerEntityFeature.VOLUME_STEP
        | MediaPlayerEntityFeature.VOLUME_MUTE
        | MediaPlayerEntityFeature.PREVIOUS_TRACK
        | MediaPlayerEntityFeature.NEXT_TRACK
        | MediaPlayerEntityFeature.TURN_ON
        | MediaPlayerEntityFeature.TURN_OFF
        | MediaPlayerEntityFeature.PLAY
        | MediaPlayerEntityFeature.STOP
        | MediaPlayerEntityFeature.PLAY_MEDIA
        | MediaPlayerEntityFeature.BROWSE_MEDIA
    )

Definition at line 45 of file media_player.py.

_attr_volume_level

homeassistant.components.androidtv_remote.media_player.AndroidTVRemoteMediaPlayerEntity._attr_volume_level

private

Definition at line 81 of file media_player.py.

_channel_set_task

homeassistant.components.androidtv_remote.media_player.AndroidTVRemoteMediaPlayerEntity._channel_set_task

private

Definition at line 181 of file media_player.py.

---

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

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