Inheritance diagram for homeassistant.components.soundtouch.media_player.SoundTouchMediaPlayer:

Collaboration diagram for homeassistant.components.soundtouch.media_player.SoundTouchMediaPlayer:

Public Member Functions
None	__init__ (self, SoundTouchDevice device)

def	add_zone_slave (self, slaves)

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_play_media (self, MediaType\|str media_type, str media_id, **Any kwargs)

def	create_zone (self, slaves)

def	device (self)

def	extra_state_attributes (self)

def	get_zone_info (self)

def	is_volume_muted (self)

def	media_album_name (self)

def	media_artist (self)

def	media_duration (self)

def	media_image_url (self)

None	media_next_track (self)

None	media_pause (self)

None	media_play (self)

None	media_play_pause (self)

None	media_previous_track (self)

def	media_title (self)

def	media_track (self)

None	mute_volume (self, bool mute)

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

def	remove_zone_slave (self, slaves)

None	select_source (self, str source)

None	set_volume_level (self, float volume)

def	source (self)

MediaPlayerState\|None	state (self)

None	turn_off (self)

None	turn_on (self)

None	update (self)

None	volume_down (self)

def	volume_level (self)

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

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

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

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

RepeatMode\|str\|None	repeat (self)

None	select_sound_mode (self, str sound_mode)

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)

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

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
def	_build_zone_info (self, master, zone_slaves)

def	_get_instance_by_id (self, instance_id)

def	_get_instance_by_ip (self, ip_address)

Private Attributes
	_attr_device_info

	_attr_unique_id

	_device

	_status

	_volume

	_zone

Static Private Attributes
	_attr_device_class = MediaPlayerDeviceClass.SPEAKER

bool	_attr_has_entity_name = True

	_attr_name = None

list	_attr_source_list

tuple	_attr_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

Representation of a SoundTouch Bose device.

Definition at line 61 of file media_player.py.

Constructor & Destructor Documentation

◆ init()

None homeassistant.components.soundtouch.media_player.SoundTouchMediaPlayer.__init__	(		self,
		SoundTouchDevice	device
	)

Create SoundTouch media player entity.

Definition at line 86 of file media_player.py.

Member Function Documentation

◆ _build_zone_info()

def homeassistant.components.soundtouch.media_player.SoundTouchMediaPlayer._build_zone_info	(	self,
		master,
		zone_slaves
	)

private

Build the exposed zone attributes.

Definition at line 403 of file media_player.py.

◆ _get_instance_by_id()

def homeassistant.components.soundtouch.media_player.SoundTouchMediaPlayer._get_instance_by_id	(	self,
		instance_id
	)

private

Search and return a SoundTouchDevice instance by it's ID (aka MAC address).

Definition at line 396 of file media_player.py.

◆ _get_instance_by_ip()

def homeassistant.components.soundtouch.media_player.SoundTouchMediaPlayer._get_instance_by_ip	(	self,
		ip_address
	)

private

Search and return a SoundTouchDevice instance by it's IP address.

Definition at line 389 of file media_player.py.

◆ add_zone_slave()

def homeassistant.components.soundtouch.media_player.SoundTouchMediaPlayer.add_zone_slave	(	self,
		slaves
	)

Add slave(s) to and existing zone (multi-room).

Zone must already exist and slaves array cannot be empty.

:param slaves:slaves to add

Definition at line 319 of file media_player.py.

◆ async_added_to_hass()

None homeassistant.components.soundtouch.media_player.SoundTouchMediaPlayer.async_added_to_hass ( self )

Populate zone info which requires entity_id.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 222 of file media_player.py.

◆ async_browse_media()

BrowseMedia homeassistant.components.soundtouch.media_player.SoundTouchMediaPlayer.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 349 of file media_player.py.

◆ async_play_media()

None homeassistant.components.soundtouch.media_player.SoundTouchMediaPlayer.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 234 of file media_player.py.

◆ create_zone()

def homeassistant.components.soundtouch.media_player.SoundTouchMediaPlayer.create_zone	(	self,
		slaves
	)

Create a zone (multi-room)  and play on selected devices.

:param slaves: slaves on which to play

Definition at line 283 of file media_player.py.

◆ device()

def homeassistant.components.soundtouch.media_player.SoundTouchMediaPlayer.device ( self )

Return SoundTouch device.

Definition at line 107 of file media_player.py.

◆ extra_state_attributes()

def homeassistant.components.soundtouch.media_player.SoundTouchMediaPlayer.extra_state_attributes ( self )

Return entity specific state attributes.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 336 of file media_player.py.

◆ get_zone_info()

def homeassistant.components.soundtouch.media_player.SoundTouchMediaPlayer.get_zone_info ( self )

Return the current zone info.

Definition at line 357 of file media_player.py.

◆ is_volume_muted()

def homeassistant.components.soundtouch.media_player.SoundTouchMediaPlayer.is_volume_muted ( self )

Boolean if volume is currently muted.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 139 of file media_player.py.

◆ media_album_name()

def homeassistant.components.soundtouch.media_player.SoundTouchMediaPlayer.media_album_name ( self )

Album name of current playing media.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 218 of file media_player.py.

◆ media_artist()

def homeassistant.components.soundtouch.media_player.SoundTouchMediaPlayer.media_artist ( self )

Artist of current playing media.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 208 of file media_player.py.

◆ media_duration()

def homeassistant.components.soundtouch.media_player.SoundTouchMediaPlayer.media_duration ( self )

Duration of current playing media in seconds.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 203 of file media_player.py.

◆ media_image_url()

def homeassistant.components.soundtouch.media_player.SoundTouchMediaPlayer.media_image_url ( self )

Image url of current playing media.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 188 of file media_player.py.

◆ media_next_track()

None homeassistant.components.soundtouch.media_player.SoundTouchMediaPlayer.media_next_track ( self )

Send next track command.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 179 of file media_player.py.

◆ media_pause()

None homeassistant.components.soundtouch.media_player.SoundTouchMediaPlayer.media_pause ( self )

Send media pause command to media player.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 175 of file media_player.py.

◆ media_play()

None homeassistant.components.soundtouch.media_player.SoundTouchMediaPlayer.media_play ( self )

Send play command.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 171 of file media_player.py.

◆ media_play_pause()

None homeassistant.components.soundtouch.media_player.SoundTouchMediaPlayer.media_play_pause ( self )

Simulate play pause media player.

Definition at line 167 of file media_player.py.

◆ media_previous_track()

None homeassistant.components.soundtouch.media_player.SoundTouchMediaPlayer.media_previous_track ( self )

Send the previous track command.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 183 of file media_player.py.

◆ media_title()

def homeassistant.components.soundtouch.media_player.SoundTouchMediaPlayer.media_title ( self )

Title of current playing media.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 193 of file media_player.py.

◆ media_track()

def homeassistant.components.soundtouch.media_player.SoundTouchMediaPlayer.media_track ( self )

Artist of current playing media.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 213 of file media_player.py.

◆ mute_volume()

None homeassistant.components.soundtouch.media_player.SoundTouchMediaPlayer.mute_volume	(		self,
		bool	mute
	)

Send mute command.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 163 of file media_player.py.

◆ play_media()

None homeassistant.components.soundtouch.media_player.SoundTouchMediaPlayer.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 248 of file media_player.py.

◆ remove_zone_slave()

def homeassistant.components.soundtouch.media_player.SoundTouchMediaPlayer.remove_zone_slave	(	self,
		slaves
	)

Remove slave(s) from and existing zone (multi-room).

Zone must already exist and slaves array cannot be empty.
Note: If removing last slave, the zone will be deleted and you'll have
to create a new one. You will not be able to add a new slave anymore

:param slaves: slaves to remove from the zone

Definition at line 295 of file media_player.py.

◆ select_source()

None homeassistant.components.soundtouch.media_player.SoundTouchMediaPlayer.select_source	(		self,
		str	source
	)

Select input source.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 272 of file media_player.py.

◆ set_volume_level()

None homeassistant.components.soundtouch.media_player.SoundTouchMediaPlayer.set_volume_level	(		self,
		float	volume
	)

Set volume level, range 0..1.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 159 of file media_player.py.

◆ source()

def homeassistant.components.soundtouch.media_player.SoundTouchMediaPlayer.source ( self )

Name of the current input source.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 134 of file media_player.py.

◆ state()

MediaPlayerState | None homeassistant.components.soundtouch.media_player.SoundTouchMediaPlayer.state ( self )

Return the state of the device.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 123 of file media_player.py.

◆ turn_off()

None homeassistant.components.soundtouch.media_player.SoundTouchMediaPlayer.turn_off ( self )

Turn off media player.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 143 of file media_player.py.

◆ turn_on()

None homeassistant.components.soundtouch.media_player.SoundTouchMediaPlayer.turn_on ( self )

Turn on media player.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 147 of file media_player.py.

◆ update()

None homeassistant.components.soundtouch.media_player.SoundTouchMediaPlayer.update ( self )

Retrieve the latest data.

Definition at line 111 of file media_player.py.

◆ volume_down()

None homeassistant.components.soundtouch.media_player.SoundTouchMediaPlayer.volume_down ( self )

Volume down media player.

Definition at line 155 of file media_player.py.

◆ volume_level()

def homeassistant.components.soundtouch.media_player.SoundTouchMediaPlayer.volume_level ( self )

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

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 118 of file media_player.py.

◆ volume_up()

None homeassistant.components.soundtouch.media_player.SoundTouchMediaPlayer.volume_up ( self )

Volume up the media player.

Definition at line 151 of file media_player.py.

Member Data Documentation

◆ _attr_device_class

homeassistant.components.soundtouch.media_player.SoundTouchMediaPlayer._attr_device_class = MediaPlayerDeviceClass.SPEAKER

staticprivate

Definition at line 78 of file media_player.py.

◆ _attr_device_info

homeassistant.components.soundtouch.media_player.SoundTouchMediaPlayer._attr_device_info

private

Definition at line 92 of file media_player.py.

◆ _attr_has_entity_name

bool homeassistant.components.soundtouch.media_player.SoundTouchMediaPlayer._attr_has_entity_name = True

staticprivate

Definition at line 79 of file media_player.py.

◆ _attr_name

homeassistant.components.soundtouch.media_player.SoundTouchMediaPlayer._attr_name = None

staticprivate

Definition at line 80 of file media_player.py.

◆ _attr_source_list

list homeassistant.components.soundtouch.media_player.SoundTouchMediaPlayer._attr_source_list

staticprivate

Initial value:

=  [
        Source.AUX.value,
        Source.BLUETOOTH.value,
    ]

Definition at line 81 of file media_player.py.

◆ _attr_supported_features

tuple homeassistant.components.soundtouch.media_player.SoundTouchMediaPlayer._attr_supported_features

staticprivate

Initial value:

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

Definition at line 64 of file media_player.py.

◆ _attr_unique_id

homeassistant.components.soundtouch.media_player.SoundTouchMediaPlayer._attr_unique_id

private

Definition at line 91 of file media_player.py.

◆ _device

homeassistant.components.soundtouch.media_player.SoundTouchMediaPlayer._device

private

Definition at line 89 of file media_player.py.

◆ _status

homeassistant.components.soundtouch.media_player.SoundTouchMediaPlayer._status

private

Definition at line 102 of file media_player.py.

◆ _volume

homeassistant.components.soundtouch.media_player.SoundTouchMediaPlayer._volume

private

Definition at line 103 of file media_player.py.

◆ _zone

homeassistant.components.soundtouch.media_player.SoundTouchMediaPlayer._zone

private

Definition at line 104 of file media_player.py.

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

core/homeassistant/components/soundtouch/media_player.py

Home Assistant Unofficial Reference 2024.12.1

Public Member Functions

Private Member Functions

Private Attributes

Static Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __init__()

Member Function Documentation

◆ _build_zone_info()

◆ _get_instance_by_id()

◆ _get_instance_by_ip()

◆ add_zone_slave()

◆ async_added_to_hass()

◆ async_browse_media()

◆ async_play_media()

◆ create_zone()

◆ device()

◆ extra_state_attributes()

◆ get_zone_info()

◆ is_volume_muted()

◆ media_album_name()

◆ media_artist()

◆ media_duration()

◆ media_image_url()

◆ media_next_track()

◆ media_pause()

◆ media_play()

◆ media_play_pause()

◆ media_previous_track()

◆ media_title()

◆ media_track()

◆ mute_volume()

◆ play_media()

◆ remove_zone_slave()

◆ select_source()

◆ set_volume_level()

◆ source()

◆ state()

◆ turn_off()

◆ turn_on()

◆ update()

◆ volume_down()

◆ volume_level()

◆ volume_up()

Member Data Documentation

◆ _attr_device_class

◆ _attr_device_info

◆ _attr_has_entity_name

◆ _attr_name

◆ _attr_source_list

◆ _attr_supported_features

◆ _attr_unique_id

◆ _device

◆ _status

◆ _volume

◆ _zone

◆ init()