homeassistant.components.sonos.media.SonosMedia Class Reference

Public Member Functions
None	__init__ (self, HomeAssistant hass, SoCo soco)
None	clear (self)
None	clear_position (self)
MusicLibrary	library (self)
None	poll_media (self)
dict[str, Any]	poll_track_info (self)
None	set_basic_track_info (self, bool update_position=False)
None	update_media_from_event (self, dict[str, Any] evars)
None	update_media_position (self, dict[str, int] position_info, bool force_update=False)
None	write_media_player_states (self)

Public Attributes
	album_name
	artist
	channel
	duration
	hass
	image_url
	play_mode
	playback_status
	playlist_name
	position
	position_updated_at
	queue_position
	queue_size
	soco
	source_name
	title
	uri

Detailed Description

Representation of the current Sonos media.

Definition at line 54 of file media.py.

Constructor & Destructor Documentation

__init__()

None homeassistant.components.sonos.media.SonosMedia.__init__	(		self,
		HomeAssistant	hass,
		SoCo	soco
	)

Initialize a SonosMedia.

Definition at line 57 of file media.py.

Member Function Documentation

clear()

None homeassistant.components.sonos.media.SonosMedia.clear

(

self

)

Clear basic media info.

Definition at line 80 of file media.py.

clear_position()

None homeassistant.components.sonos.media.SonosMedia.clear_position

(

self

)

Clear the position attributes.

Definition at line 94 of file media.py.

library()

MusicLibrary homeassistant.components.sonos.media.SonosMedia.library

(

self

)

Return the soco MusicLibrary instance.

Definition at line 100 of file media.py.

poll_media()

None homeassistant.components.sonos.media.SonosMedia.poll_media

(

self

)

Poll information about currently playing media.

Definition at line 186 of file media.py.

poll_track_info()

dict[str, Any] homeassistant.components.sonos.media.SonosMedia.poll_track_info

(

self

)

Poll the speaker for current track info, add converted position values.

Definition at line 105 of file media.py.

set_basic_track_info()

None homeassistant.components.sonos.media.SonosMedia.set_basic_track_info	(		self,
		bool	update_position = False
	)

Query the speaker to update media metadata and position info.

Definition at line 116 of file media.py.

update_media_from_event()

None homeassistant.components.sonos.media.SonosMedia.update_media_from_event	(		self,
		dict[str, Any]	evars
	)

Update information about currently playing media using an event payload.

Definition at line 144 of file media.py.

update_media_position()

None homeassistant.components.sonos.media.SonosMedia.update_media_position	(		self,
		dict[str, int]	position_info,
		bool	force_update = False
	)

Update state when playing music tracks.

Definition at line 202 of file media.py.

write_media_player_states()

None homeassistant.components.sonos.media.SonosMedia.write_media_player_states

(

self

)

Send a signal to media player(s) to write new states.

Definition at line 112 of file media.py.

Member Data Documentation

album_name

homeassistant.components.sonos.media.SonosMedia.album_name

Definition at line 82 of file media.py.

artist

homeassistant.components.sonos.media.SonosMedia.artist

Definition at line 83 of file media.py.

channel

homeassistant.components.sonos.media.SonosMedia.channel

Definition at line 84 of file media.py.

duration

homeassistant.components.sonos.media.SonosMedia.duration

Definition at line 85 of file media.py.

hass

homeassistant.components.sonos.media.SonosMedia.hass

Definition at line 59 of file media.py.

image_url

homeassistant.components.sonos.media.SonosMedia.image_url

Definition at line 86 of file media.py.

play_mode

homeassistant.components.sonos.media.SonosMedia.play_mode

Definition at line 149 of file media.py.

playback_status

homeassistant.components.sonos.media.SonosMedia.playback_status

Definition at line 150 of file media.py.

playlist_name

homeassistant.components.sonos.media.SonosMedia.playlist_name

Definition at line 87 of file media.py.

position

homeassistant.components.sonos.media.SonosMedia.position

Definition at line 96 of file media.py.

position_updated_at

homeassistant.components.sonos.media.SonosMedia.position_updated_at

Definition at line 97 of file media.py.

queue_position

homeassistant.components.sonos.media.SonosMedia.queue_position

Definition at line 88 of file media.py.

queue_size

homeassistant.components.sonos.media.SonosMedia.queue_size

Definition at line 89 of file media.py.

soco

homeassistant.components.sonos.media.SonosMedia.soco

Definition at line 60 of file media.py.

source_name

homeassistant.components.sonos.media.SonosMedia.source_name

Definition at line 90 of file media.py.

title

homeassistant.components.sonos.media.SonosMedia.title

Definition at line 91 of file media.py.

uri

homeassistant.components.sonos.media.SonosMedia.uri

Definition at line 92 of file media.py.

---

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

• core/homeassistant/components/sonos/media.py