Inheritance diagram for homeassistant.components.sonos.media_player.SonosMediaPlayerEntity:

Collaboration diagram for homeassistant.components.sonos.media_player.SonosMediaPlayerEntity:

Public Member Functions
int	__hash__ (self)

None	__init__ (self, SonosSpeaker speaker)

None	async_added_to_hass (self)

BrowseMedia	async_browse_media (self, MediaType\|str\|None media_content_type=None, str\|None media_content_id=None)

tuple[bytes\|None, str\|None]	async_get_browse_image (self, MediaType\|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_play_media (self, MediaType\|str media_type, str media_id, **Any kwargs)

None	async_unjoin_player (self)

None	async_write_media_state (self, str uid)

bool	available (self)

None	clear_playlist (self)

None	clear_sleep_timer (self)

SonosSpeaker	coordinator (self)

dict[str, Any]	extra_state_attributes (self)

list[dict]	get_queue (self)

list[str]\|None	group_members (self)

bool\|None	is_volume_muted (self)

SonosMedia	media (self)

str\|None	media_album_name (self)

str\|None	media_artist (self)

str\|None	media_channel (self)

str\|None	media_content_id (self)

int\|None	media_duration (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)

datetime.datetime\|None	media_position_updated_at (self)

None	media_previous_track (self)

None	media_seek (self, float position)

None	media_stop (self)

str\|None	media_title (self)

None	mute_volume (self, bool mute)

None	play_queue (self, int queue_position=0)

None	remove_from_queue (self, int queue_position=0)

RepeatMode\|None	repeat (self)

None	select_source (self, str source)

None	set_alarm (self, int alarm_id, datetime.datetime\|None time=None, float\|None volume=None, bool\|None enabled=None, bool\|None include_linked_zones=None)

None	set_repeat (self, RepeatMode repeat)

None	set_shuffle (self, bool shuffle)

None	set_sleep_timer (self, int sleep_time)

None	set_volume_level (self, float volume)

bool\|None	shuffle (self)

str\|None	source (self)

list[str]	source_list (self)

MediaPlayerState	state (self)

None	volume_down (self)

float\|None	volume_level (self)

None	volume_up (self)

Public Member Functions inherited from homeassistant.components.sonos.entity.SonosEntity
None	async_fallback_poll (self, datetime.datetime now)

None	async_will_remove_from_hass (self)

DeviceInfo	device_info (self)

SoCo	soco (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)

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)

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_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_volume_down (self)

None	async_volume_up (self)

dict[str, Any]	capability_attributes (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)

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_season (self)

str\|None	media_series_title (self)

int\|None	media_track (self)

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

None	select_sound_mode (self, str sound_mode)

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)

Private Member Functions
None	_async_fallback_poll (self)

None	_play_favorite (self, DidlFavorite favorite)

None	_play_favorite_by_name (self, str name)

None	_play_media (self, MediaType\|str media_type, str media_id, bool is_radio, **Any kwargs)

def	_play_media_queue (self, SoCo soco, MusicServiceItem item, MediaPlayerEnqueue enqueue)

None	_update (self)

Private Attributes
	_attr_unique_id

Static Private Attributes
	_attr_device_class = MediaPlayerDeviceClass.SPEAKER

	_attr_media_content_type = MediaType.MUSIC

	_attr_name = None

tuple	_attr_supported_features

Additional Inherited Members
Public Attributes inherited from homeassistant.components.sonos.entity.SonosEntity
	speaker

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

Representation of a Sonos entity.

Definition at line 207 of file media_player.py.

Constructor & Destructor Documentation

◆ init()

None homeassistant.components.sonos.media_player.SonosMediaPlayerEntity.__init__	(		self,
		SonosSpeaker	speaker
	)

Initialize the media player entity.

Reimplemented from homeassistant.components.sonos.entity.SonosEntity.

Definition at line 233 of file media_player.py.

Member Function Documentation

◆ hash()

int homeassistant.components.sonos.media_player.SonosMediaPlayerEntity.__hash__ ( self )

Return a hash of self.

Definition at line 274 of file media_player.py.

◆ _async_fallback_poll()

None homeassistant.components.sonos.media_player.SonosMediaPlayerEntity._async_fallback_poll ( self )

private

Retrieve latest state by polling.

Reimplemented from homeassistant.components.sonos.entity.SonosEntity.

Definition at line 298 of file media_player.py.

◆ _play_favorite()

None homeassistant.components.sonos.media_player.SonosMediaPlayerEntity._play_favorite	(		self,
		DidlFavorite	favorite
	)

private

Play a favorite.

Definition at line 461 of file media_player.py.

◆ _play_favorite_by_name()

None homeassistant.components.sonos.media_player.SonosMediaPlayerEntity._play_favorite_by_name	(		self,
		str	name
	)

private

Play a favorite by name.

Definition at line 445 of file media_player.py.

◆ _play_media()

None homeassistant.components.sonos.media_player.SonosMediaPlayerEntity._play_media	(		self,
		MediaType \| str	media_type,
		str	media_id,
		bool	is_radio,
		**Any	kwargs
	)

private

Wrap sync calls to async_play_media.

Definition at line 588 of file media_player.py.

◆ _play_media_queue()

def homeassistant.components.sonos.media_player.SonosMediaPlayerEntity._play_media_queue	(		self,
		SoCo	soco,
		MusicServiceItem	item,
		MediaPlayerEnqueue	enqueue
	)

private

Manage adding, replacing, playing items onto the sonos queue.

Definition at line 707 of file media_player.py.

◆ _update()

None homeassistant.components.sonos.media_player.SonosMediaPlayerEntity._update ( self )

private

Retrieve latest state by polling.

Definition at line 305 of file media_player.py.

◆ async_added_to_hass()

None homeassistant.components.sonos.media_player.SonosMediaPlayerEntity.async_added_to_hass ( self )

Handle common setup when added to hass.

Reimplemented from homeassistant.components.sonos.entity.SonosEntity.

Definition at line 238 of file media_player.py.

◆ async_browse_media()

BrowseMedia homeassistant.components.sonos.media_player.SonosMediaPlayerEntity.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 831 of file media_player.py.

◆ async_get_browse_image()

tuple[bytes \| None, str \| None] homeassistant.components.sonos.media_player.SonosMediaPlayerEntity.async_get_browse_image	(		self,
		MediaType \| str	media_content_type,
		str	media_content_id,
		str \| None	media_image_id = `None`
	)

Fetch media browser image to serve via proxy.

Definition at line 809 of file media_player.py.

◆ async_join_players()

None homeassistant.components.sonos.media_player.SonosMediaPlayerEntity.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 846 of file media_player.py.

◆ async_play_media()

None homeassistant.components.sonos.media_player.SonosMediaPlayerEntity.async_play_media	(		self,
		MediaType \| str	media_type,
		str	media_id,
		**Any	kwargs
	)

Send the play_media command to the media player.

If media_id is a Plex payload, attempt Plex->Sonos playback.

If media_id is an Apple Music, Deezer, Sonos, or Tidal share link,
attempt playback using the respective service.

If media_type is "playlist", media_id should be a Sonos
Playlist name.  Otherwise, media_id should be a URI.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 522 of file media_player.py.

◆ async_unjoin_player()

None homeassistant.components.sonos.media_player.SonosMediaPlayerEntity.async_unjoin_player ( self )

Remove this player from any group.

Coalesces all calls within UNJOIN_SERVICE_TIMEOUT to allow use of SonosSpeaker.unjoin_multi()
which optimizes the order in which speakers are removed from their groups.
Removing coordinators last better preserves playqueues on the speakers.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 857 of file media_player.py.

◆ async_write_media_state()

None homeassistant.components.sonos.media_player.SonosMediaPlayerEntity.async_write_media_state	(		self,
		str	uid
	)

Write media state if the provided UID is coordinator of this speaker.

Definition at line 250 of file media_player.py.

◆ available()

bool homeassistant.components.sonos.media_player.SonosMediaPlayerEntity.available ( self )

Return if the media_player is available.

Reimplemented from homeassistant.components.sonos.entity.SonosEntity.

Definition at line 256 of file media_player.py.

◆ clear_playlist()

None homeassistant.components.sonos.media_player.SonosMediaPlayerEntity.clear_playlist ( self )

Clear players playlist.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 518 of file media_player.py.

◆ clear_sleep_timer()

None homeassistant.components.sonos.media_player.SonosMediaPlayerEntity.clear_sleep_timer ( self )

Clear the timer on the player.

Definition at line 738 of file media_player.py.

◆ coordinator()

SonosSpeaker homeassistant.components.sonos.media_player.SonosMediaPlayerEntity.coordinator ( self )

Return the current coordinator SonosSpeaker.

Definition at line 265 of file media_player.py.

◆ extra_state_attributes()

dict[str, Any] homeassistant.components.sonos.media_player.SonosMediaPlayerEntity.extra_state_attributes ( self )

Return entity specific state attributes.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 794 of file media_player.py.

◆ get_queue()

list[dict] homeassistant.components.sonos.media_player.SonosMediaPlayerEntity.get_queue ( self )

Get the queue.

Definition at line 780 of file media_player.py.

◆ group_members()

list[str] | None homeassistant.components.sonos.media_player.SonosMediaPlayerEntity.group_members ( self )

List of entity_ids which are currently grouped together.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 270 of file media_player.py.

◆ is_volume_muted()

bool | None homeassistant.components.sonos.media_player.SonosMediaPlayerEntity.is_volume_muted ( self )

Return true if volume is muted.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 318 of file media_player.py.

◆ media()

SonosMedia homeassistant.components.sonos.media_player.SonosMediaPlayerEntity.media ( self )

Return the SonosMedia object from the coordinator speaker.

Definition at line 334 of file media_player.py.

◆ media_album_name()

str | None homeassistant.components.sonos.media_player.SonosMediaPlayerEntity.media_album_name ( self )

Album name of current playing media, music track only.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 379 of file media_player.py.

◆ media_artist()

str | None homeassistant.components.sonos.media_player.SonosMediaPlayerEntity.media_artist ( self )

Artist of current playing media, music track only.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 374 of file media_player.py.

◆ media_channel()

str | None homeassistant.components.sonos.media_player.SonosMediaPlayerEntity.media_channel ( self )

Channel currently playing.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 364 of file media_player.py.

◆ media_content_id()

str | None homeassistant.components.sonos.media_player.SonosMediaPlayerEntity.media_content_id ( self )

Content id of current playing media.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 339 of file media_player.py.

◆ media_duration()

int | None homeassistant.components.sonos.media_player.SonosMediaPlayerEntity.media_duration ( self )

Duration of current playing media in seconds.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 344 of file media_player.py.

◆ media_image_url()

str | None homeassistant.components.sonos.media_player.SonosMediaPlayerEntity.media_image_url ( self )

Image url of current playing media.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 359 of file media_player.py.

◆ media_next_track()

None homeassistant.components.sonos.media_player.SonosMediaPlayerEntity.media_next_track ( self )

Send next track command.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 503 of file media_player.py.

◆ media_pause()

None homeassistant.components.sonos.media_player.SonosMediaPlayerEntity.media_pause ( self )

Send pause command.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 498 of file media_player.py.

◆ media_play()

None homeassistant.components.sonos.media_player.SonosMediaPlayerEntity.media_play ( self )

Send play command.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 488 of file media_player.py.

◆ media_playlist()

str | None homeassistant.components.sonos.media_player.SonosMediaPlayerEntity.media_playlist ( self )

Title of playlist currently playing.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 369 of file media_player.py.

◆ media_position()

int | None homeassistant.components.sonos.media_player.SonosMediaPlayerEntity.media_position ( self )

Position of current playing media in seconds.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 349 of file media_player.py.

◆ media_position_updated_at()

datetime.datetime | None homeassistant.components.sonos.media_player.SonosMediaPlayerEntity.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 354 of file media_player.py.

◆ media_previous_track()

None homeassistant.components.sonos.media_player.SonosMediaPlayerEntity.media_previous_track ( self )

Send next track command.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 508 of file media_player.py.

◆ media_seek()

None homeassistant.components.sonos.media_player.SonosMediaPlayerEntity.media_seek	(		self,
		float	position
	)

Send seek command.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 513 of file media_player.py.

◆ media_stop()

None homeassistant.components.sonos.media_player.SonosMediaPlayerEntity.media_stop ( self )

Send stop command.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 493 of file media_player.py.

◆ media_title()

str | None homeassistant.components.sonos.media_player.SonosMediaPlayerEntity.media_title ( self )

Title of current playing media.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 384 of file media_player.py.

◆ mute_volume()

None homeassistant.components.sonos.media_player.SonosMediaPlayerEntity.mute_volume	(		self,
		bool	mute
	)

Mute (true) or unmute (false) media player.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 427 of file media_player.py.

◆ play_queue()

None homeassistant.components.sonos.media_player.SonosMediaPlayerEntity.play_queue	(		self,
		int	queue_position = `0`
	)

Start playing the queue.

Definition at line 770 of file media_player.py.

◆ remove_from_queue()

None homeassistant.components.sonos.media_player.SonosMediaPlayerEntity.remove_from_queue	(		self,
		int	queue_position = `0`
	)

Remove item from the queue.

Definition at line 775 of file media_player.py.

◆ repeat()

RepeatMode | None homeassistant.components.sonos.media_player.SonosMediaPlayerEntity.repeat ( self )

Return current repeat mode.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 328 of file media_player.py.

◆ select_source()

None homeassistant.components.sonos.media_player.SonosMediaPlayerEntity.select_source	(		self,
		str	source
	)

Select input source.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 432 of file media_player.py.

◆ set_alarm()

None homeassistant.components.sonos.media_player.SonosMediaPlayerEntity.set_alarm	(		self,
		int	alarm_id,
		datetime.datetime \| None	time = `None`,
		float \| None	volume = `None`,
		bool \| None	enabled = `None`,
		bool \| None	include_linked_zones = `None`
	)

Set the alarm clock on the player.

Definition at line 743 of file media_player.py.

◆ set_repeat()

None homeassistant.components.sonos.media_player.SonosMediaPlayerEntity.set_repeat	(		self,
		RepeatMode	repeat
	)

Set repeat mode.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 418 of file media_player.py.

◆ set_shuffle()

None homeassistant.components.sonos.media_player.SonosMediaPlayerEntity.set_shuffle	(		self,
		bool	shuffle
	)

Enable/Disable shuffle mode.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 409 of file media_player.py.

◆ set_sleep_timer()

None homeassistant.components.sonos.media_player.SonosMediaPlayerEntity.set_sleep_timer	(		self,
		int	sleep_time
	)

Set the timer on the player.

Definition at line 733 of file media_player.py.

◆ set_volume_level()

None homeassistant.components.sonos.media_player.SonosMediaPlayerEntity.set_volume_level	(		self,
		float	volume
	)

Set volume level, range 0..1.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 404 of file media_player.py.

◆ shuffle()

bool | None homeassistant.components.sonos.media_player.SonosMediaPlayerEntity.shuffle ( self )

Shuffling state.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 323 of file media_player.py.

◆ source()

str | None homeassistant.components.sonos.media_player.SonosMediaPlayerEntity.source ( self )

Name of the current input source.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 389 of file media_player.py.

◆ source_list()

list[str] homeassistant.components.sonos.media_player.SonosMediaPlayerEntity.source_list ( self )

List of available input sources.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 476 of file media_player.py.

◆ state()

MediaPlayerState homeassistant.components.sonos.media_player.SonosMediaPlayerEntity.state ( self )

Return the state of the entity.

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 279 of file media_player.py.

◆ volume_down()

None homeassistant.components.sonos.media_player.SonosMediaPlayerEntity.volume_down ( self )

Volume down media player.

Definition at line 399 of file media_player.py.

◆ volume_level()

float | None homeassistant.components.sonos.media_player.SonosMediaPlayerEntity.volume_level ( self )

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

Reimplemented from homeassistant.components.media_player.MediaPlayerEntity.

Definition at line 313 of file media_player.py.

◆ volume_up()

None homeassistant.components.sonos.media_player.SonosMediaPlayerEntity.volume_up ( self )

Volume up media player.

Definition at line 394 of file media_player.py.

Member Data Documentation

◆ _attr_device_class

homeassistant.components.sonos.media_player.SonosMediaPlayerEntity._attr_device_class = MediaPlayerDeviceClass.SPEAKER

staticprivate

Definition at line 231 of file media_player.py.

◆ _attr_media_content_type

homeassistant.components.sonos.media_player.SonosMediaPlayerEntity._attr_media_content_type = MediaType.MUSIC

staticprivate

Definition at line 230 of file media_player.py.

◆ _attr_name

homeassistant.components.sonos.media_player.SonosMediaPlayerEntity._attr_name = None

staticprivate

Definition at line 210 of file media_player.py.

◆ _attr_supported_features

tuple homeassistant.components.sonos.media_player.SonosMediaPlayerEntity._attr_supported_features

staticprivate

Initial value:

=  (
        MediaPlayerEntityFeature.BROWSE_MEDIA
        | MediaPlayerEntityFeature.CLEAR_PLAYLIST
        | MediaPlayerEntityFeature.GROUPING
        | MediaPlayerEntityFeature.MEDIA_ANNOUNCE
        | MediaPlayerEntityFeature.MEDIA_ENQUEUE
        | MediaPlayerEntityFeature.NEXT_TRACK
        | MediaPlayerEntityFeature.PAUSE
        | MediaPlayerEntityFeature.PLAY
        | MediaPlayerEntityFeature.PLAY_MEDIA
        | MediaPlayerEntityFeature.PREVIOUS_TRACK
        | MediaPlayerEntityFeature.REPEAT_SET
        | MediaPlayerEntityFeature.SEEK
        | MediaPlayerEntityFeature.SELECT_SOURCE
        | MediaPlayerEntityFeature.SHUFFLE_SET
        | MediaPlayerEntityFeature.STOP
        | MediaPlayerEntityFeature.VOLUME_MUTE
        | MediaPlayerEntityFeature.VOLUME_SET
    )

Definition at line 211 of file media_player.py.

◆ _attr_unique_id

homeassistant.components.sonos.media_player.SonosMediaPlayerEntity._attr_unique_id

private

Definition at line 236 of file media_player.py.

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

core/homeassistant/components/sonos/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

◆ __hash__()

◆ _async_fallback_poll()

◆ _play_favorite()

◆ _play_favorite_by_name()

◆ _play_media()

◆ _play_media_queue()

◆ _update()

◆ async_added_to_hass()

◆ async_browse_media()

◆ async_get_browse_image()

◆ async_join_players()

◆ async_play_media()

◆ async_unjoin_player()

◆ async_write_media_state()

◆ available()

◆ clear_playlist()

◆ clear_sleep_timer()

◆ coordinator()

◆ extra_state_attributes()

◆ get_queue()

◆ group_members()

◆ is_volume_muted()

◆ media()

◆ media_album_name()

◆ media_artist()

◆ media_channel()

◆ media_content_id()

◆ media_duration()

◆ media_image_url()

◆ media_next_track()

◆ media_pause()

◆ media_play()

◆ media_playlist()

◆ media_position()

◆ media_position_updated_at()

◆ media_previous_track()

◆ media_seek()

◆ media_stop()

◆ media_title()

◆ mute_volume()

◆ play_queue()

◆ remove_from_queue()

◆ repeat()

◆ select_source()

◆ set_alarm()

◆ set_repeat()

◆ set_shuffle()

◆ set_sleep_timer()

◆ set_volume_level()

◆ shuffle()

◆ source()

◆ source_list()

◆ state()

◆ volume_down()

◆ volume_level()

◆ volume_up()

Member Data Documentation

◆ _attr_device_class

◆ _attr_media_content_type

◆ _attr_name

◆ _attr_supported_features

◆ _attr_unique_id

◆ init()

◆ hash()