homeassistant.components.heos.media_player.HeosMediaPlayer Class Reference

Inheritance diagram for homeassistant.components.heos.media_player.HeosMediaPlayer:

Collaboration diagram for homeassistant.components.heos.media_player.HeosMediaPlayer:

Public Member Functions
def	__init__ (self, player)
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_clear_playlist (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_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_select_source (self, str source)
None	async_set_shuffle (self, bool shuffle)
None	async_set_volume_level (self, float volume)
None	async_unjoin_player (self)
None	async_update (self)
None	async_will_remove_from_hass (self)
bool	available (self)
dict[str, Any]	extra_state_attributes (self)
list[str]	group_members (self)
bool	is_volume_muted (self)
str	media_album_name (self)
str	media_artist (self)
str	media_content_id (self)
def	media_duration (self)
str|None	media_image_url (self)
def	media_position (self)
def	media_position_updated_at (self)
str	media_title (self)
bool	shuffle (self)
str	source (self)
list[str]	source_list (self)
MediaPlayerState	state (self)
float	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)
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_media_play_pause (self)
None	async_media_seek (self, float position)
None	async_select_sound_mode (self, str sound_mode)
None	async_set_repeat (self, RepeatMode repeat)
None	async_toggle (self)
None	async_turn_off (self)
None	async_turn_on (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)
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)
str|None	media_episode (self)
str|None	media_image_hash (self)
str|None	media_image_local (self)
bool	media_image_remotely_accessible (self)
None	media_next_track (self)
None	media_pause (self)
None	media_play (self)
str|None	media_playlist (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)
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)
str|None	sound_mode (self)
list[str]|None	sound_mode_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	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_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)
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)
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)

Private Member Functions
None	_heos_updated (self)
def	_player_update (self, player_id, event)

Private Attributes
	_attr_device_info
	_attr_unique_id
	_group_manager
	_media_position_updated_at
	_player
	_signals
	_source_manager

Static Private Attributes
bool	_attr_has_entity_name = True
	_attr_media_content_type = MediaType.MUSIC
bool	_attr_media_image_remotely_accessible = True
	_attr_name = None
bool	_attr_should_poll = False
	_attr_supported_features = BASE_SUPPORTED_FEATURES

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

The HEOS player.

Definition at line 113 of file media_player.py.

Constructor & Destructor Documentation

__init__()

def homeassistant.components.heos.media_player.HeosMediaPlayer.__init__	(		self,
			player
	)

Initialize.

Definition at line 123 of file media_player.py.

Member Function Documentation

_heos_updated()

None homeassistant.components.heos.media_player.HeosMediaPlayer._heos_updated (   self )

private

Handle sources changed.

Definition at line 147 of file media_player.py.

_player_update()

def homeassistant.components.heos.media_player.HeosMediaPlayer._player_update (   self,   player_id,   event  )

private

Handle player attribute updated.

Definition at line 139 of file media_player.py.

async_added_to_hass()

None homeassistant.components.heos.media_player.HeosMediaPlayer.async_added_to_hass

(

self

)

Device added to hass.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 151 of file media_player.py.

async_browse_media()

BrowseMedia homeassistant.components.heos.media_player.HeosMediaPlayer.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 416 of file media_player.py.

async_clear_playlist()

None homeassistant.components.heos.media_player.HeosMediaPlayer.async_clear_playlist

(

self

)

Clear players playlist.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 170 of file media_player.py.

async_join_players()

None homeassistant.components.heos.media_player.HeosMediaPlayer.async_join_players	(		self,
		list[str]	group_members
	)

Join `group_members` as a player group with the current player.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 175 of file media_player.py.

async_media_next_track()

None homeassistant.components.heos.media_player.HeosMediaPlayer.async_media_next_track

(

self

)

Send next track command.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 195 of file media_player.py.

async_media_pause()

None homeassistant.components.heos.media_player.HeosMediaPlayer.async_media_pause

(

self

)

Send pause command.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 180 of file media_player.py.

async_media_play()

None homeassistant.components.heos.media_player.HeosMediaPlayer.async_media_play

(

self

)

Send play command.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 185 of file media_player.py.

async_media_previous_track()

None homeassistant.components.heos.media_player.HeosMediaPlayer.async_media_previous_track

(

self

)

Send previous track command.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 190 of file media_player.py.

async_media_stop()

None homeassistant.components.heos.media_player.HeosMediaPlayer.async_media_stop

(

self

)

Send stop command.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 200 of file media_player.py.

async_mute_volume()

None homeassistant.components.heos.media_player.HeosMediaPlayer.async_mute_volume	(		self,
		bool	mute
	)

Mute the volume.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 205 of file media_player.py.

async_play_media()

None homeassistant.components.heos.media_player.HeosMediaPlayer.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 210 of file media_player.py.

async_select_source()

None homeassistant.components.heos.media_player.HeosMediaPlayer.async_select_source	(		self,
		str	source
	)

Select input source.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 275 of file media_player.py.

async_set_shuffle()

None homeassistant.components.heos.media_player.HeosMediaPlayer.async_set_shuffle	(		self,
		bool	shuffle
	)

Enable/disable shuffle mode.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 280 of file media_player.py.

async_set_volume_level()

None homeassistant.components.heos.media_player.HeosMediaPlayer.async_set_volume_level	(		self,
		float	volume
	)

Set volume level, range 0..1.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 285 of file media_player.py.

async_unjoin_player()

None homeassistant.components.heos.media_player.HeosMediaPlayer.async_unjoin_player

(

self

)

Remove this player from any group.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 304 of file media_player.py.

async_update()

None homeassistant.components.heos.media_player.HeosMediaPlayer.async_update

(

self

)

Update supported features of the player.

Definition at line 289 of file media_player.py.

async_will_remove_from_hass()

None homeassistant.components.heos.media_player.HeosMediaPlayer.async_will_remove_from_hass

(

self

)

Disconnect the device when removed.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 308 of file media_player.py.

available()

bool homeassistant.components.heos.media_player.HeosMediaPlayer.available

(

self

)

Return True if the device is available.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 315 of file media_player.py.

extra_state_attributes()

dict[str, Any] homeassistant.components.heos.media_player.HeosMediaPlayer.extra_state_attributes

(

self

)

Get additional attribute about the state.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 320 of file media_player.py.

group_members()

list[str] homeassistant.components.heos.media_player.HeosMediaPlayer.group_members

(

self

)

List of players which are grouped together.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 331 of file media_player.py.

is_volume_muted()

bool homeassistant.components.heos.media_player.HeosMediaPlayer.is_volume_muted

(

self

)

Boolean if volume is currently muted.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 336 of file media_player.py.

media_album_name()

str homeassistant.components.heos.media_player.HeosMediaPlayer.media_album_name

(

self

)

Album name of current playing media, music track only.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 341 of file media_player.py.

media_artist()

str homeassistant.components.heos.media_player.HeosMediaPlayer.media_artist

(

self

)

Artist of current playing media, music track only.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 346 of file media_player.py.

media_content_id()

str homeassistant.components.heos.media_player.HeosMediaPlayer.media_content_id

(

self

)

Content ID of current playing media.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 351 of file media_player.py.

media_duration()

def homeassistant.components.heos.media_player.HeosMediaPlayer.media_duration

(

self

)

Duration of current playing media in seconds.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 356 of file media_player.py.

media_image_url()

str | None homeassistant.components.heos.media_player.HeosMediaPlayer.media_image_url

(

self

)

Image url of current playing media.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 380 of file media_player.py.

media_position()

def homeassistant.components.heos.media_player.HeosMediaPlayer.media_position

(

self

)

Position of current playing media in seconds.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 364 of file media_player.py.

media_position_updated_at()

def homeassistant.components.heos.media_player.HeosMediaPlayer.media_position_updated_at

(

self

)

When was the position of the current playing media valid.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 372 of file media_player.py.

media_title()

str homeassistant.components.heos.media_player.HeosMediaPlayer.media_title

(

self

)

Title of current playing media.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 387 of file media_player.py.

shuffle()

bool homeassistant.components.heos.media_player.HeosMediaPlayer.shuffle

(

self

)

Boolean if shuffle is enabled.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 392 of file media_player.py.

source()

str homeassistant.components.heos.media_player.HeosMediaPlayer.source

(

self

)

Name of the current input source.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 397 of file media_player.py.

source_list()

list[str] homeassistant.components.heos.media_player.HeosMediaPlayer.source_list

(

self

)

List of available input sources.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 402 of file media_player.py.

state()

MediaPlayerState homeassistant.components.heos.media_player.HeosMediaPlayer.state

(

self

)

State of the player.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 407 of file media_player.py.

volume_level()

float homeassistant.components.heos.media_player.HeosMediaPlayer.volume_level

(

self

)

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

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 412 of file media_player.py.

Member Data Documentation

_attr_device_info

homeassistant.components.heos.media_player.HeosMediaPlayer._attr_device_info

private

Definition at line 131 of file media_player.py.

_attr_has_entity_name

bool homeassistant.components.heos.media_player.HeosMediaPlayer._attr_has_entity_name = True

staticprivate

Definition at line 120 of file media_player.py.

_attr_media_content_type

homeassistant.components.heos.media_player.HeosMediaPlayer._attr_media_content_type = MediaType.MUSIC

staticprivate

Definition at line 116 of file media_player.py.

_attr_media_image_remotely_accessible

bool homeassistant.components.heos.media_player.HeosMediaPlayer._attr_media_image_remotely_accessible = True

staticprivate

Definition at line 119 of file media_player.py.

_attr_name

homeassistant.components.heos.media_player.HeosMediaPlayer._attr_name = None

staticprivate

Definition at line 121 of file media_player.py.

_attr_should_poll

bool homeassistant.components.heos.media_player.HeosMediaPlayer._attr_should_poll = False

staticprivate

Definition at line 117 of file media_player.py.

_attr_supported_features

homeassistant.components.heos.media_player.HeosMediaPlayer._attr_supported_features = BASE_SUPPORTED_FEATURES

staticprivate

Definition at line 118 of file media_player.py.

_attr_unique_id

homeassistant.components.heos.media_player.HeosMediaPlayer._attr_unique_id

private

Definition at line 130 of file media_player.py.

_group_manager

homeassistant.components.heos.media_player.HeosMediaPlayer._group_manager

private

Definition at line 129 of file media_player.py.

_media_position_updated_at

homeassistant.components.heos.media_player.HeosMediaPlayer._media_position_updated_at

private

Definition at line 125 of file media_player.py.

_player

homeassistant.components.heos.media_player.HeosMediaPlayer._player

private

Definition at line 126 of file media_player.py.

_signals

homeassistant.components.heos.media_player.HeosMediaPlayer._signals

private

Definition at line 127 of file media_player.py.

_source_manager

homeassistant.components.heos.media_player.HeosMediaPlayer._source_manager

private

Definition at line 128 of file media_player.py.

---

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

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