Functions
BrowseMedia	async_browse_media (HomeAssistant hass, SonosSpeaker speaker, SonosMedia media, GetBrowseImageUrlType get_browse_image_url, str\|None media_content_id, str\|None media_content_type)

BrowseMedia\|None	build_item_response (MusicLibrary media_library, dict[str, str] payload, get_thumbnail_url=None)

bool	can_expand (DidlObject item)

bool	can_play (DidlObject item)

BrowseMedia	favorites_folder_payload (SonosFavorites favorites, str media_content_id)

BrowseMedia	favorites_payload (SonosFavorites favorites)

str	fix_image_url (str url)

str	get_content_id (DidlObject item)

MusicServiceItem\|None	get_media (MusicLibrary media_library, str item_id, str search_type)

str	get_media_type (DidlObject item)

str\|None	get_thumbnail_url_full (SonosMedia media, bool is_internal, GetBrowseImageUrlType get_browse_image_url, str media_content_type, str media_content_id, str\|None media_image_id=None, MusicServiceItem\|None item=None)

BrowseMedia	item_payload (DidlObject item, get_thumbnail_url=None)

BrowseMedia	library_payload (MusicLibrary media_library, get_thumbnail_url=None)

bool	media_source_filter (BrowseMedia item)

BrowseMedia	root_payload (HomeAssistant hass, SonosSpeaker speaker, SonosMedia media, GetBrowseImageUrlType get_browse_image_url)

Variables
	_LOGGER = logging.getLogger(__name__)

	GetBrowseImageUrlType

Detailed Description

Support for media browsing.

Function Documentation

◆ async_browse_media()

BrowseMedia homeassistant.components.sonos.media_browser.async_browse_media	(	HomeAssistant	hass,
		SonosSpeaker	speaker,
		SonosMedia	media,
		GetBrowseImageUrlType	get_browse_image_url,
		str \| None	media_content_id,
		str \| None	media_content_type
	)

Browse media.

Definition at line 108 of file media_browser.py.

◆ build_item_response()

BrowseMedia \| None homeassistant.components.sonos.media_browser.build_item_response	(	MusicLibrary	media_library,
		dict[str, str]	payload,
			get_thumbnail_url = `None`
	)

Create response payload for the provided media query.

Definition at line 190 of file media_browser.py.

◆ can_expand()

bool homeassistant.components.sonos.media_browser.can_expand ( DidlObject item )

Test if expandable.

Used by async_browse_media.

Definition at line 507 of file media_browser.py.

◆ can_play()

bool homeassistant.components.sonos.media_browser.can_play ( DidlObject item )

Test if playable.

Used by async_browse_media.

Definition at line 499 of file media_browser.py.

◆ favorites_folder_payload()

BrowseMedia homeassistant.components.sonos.media_browser.favorites_folder_payload	(	SonosFavorites	favorites,
		str	media_content_id
	)

Create response payload to describe all items of a type of favorite.

Used by async_browse_media.

Definition at line 445 of file media_browser.py.

◆ favorites_payload()

BrowseMedia homeassistant.components.sonos.media_browser.favorites_payload ( SonosFavorites favorites )

Create response payload to describe contents of a specific library.

Used by async_browse_media.

Definition at line 408 of file media_browser.py.

◆ fix_image_url()

str homeassistant.components.sonos.media_browser.fix_image_url ( str url )

Update the image url to fully encode characters to allow image display in media_browser UI.

Images whose file path contains characters such as ',()+ are not loaded without escaping them.

Definition at line 49 of file media_browser.py.

◆ get_content_id()

str homeassistant.components.sonos.media_browser.get_content_id ( DidlObject item )

Extract content id or uri.

Definition at line 521 of file media_browser.py.

◆ get_media()

MusicServiceItem \| None homeassistant.components.sonos.media_browser.get_media	(	MusicLibrary	media_library,
		str	item_id,
		str	search_type
	)

Fetch a single media/album.

Definition at line 528 of file media_browser.py.

◆ get_media_type()

str homeassistant.components.sonos.media_browser.get_media_type ( DidlObject item )

Extract media type of item.

Definition at line 481 of file media_browser.py.

◆ get_thumbnail_url_full()

str \| None homeassistant.components.sonos.media_browser.get_thumbnail_url_full	(	SonosMedia	media,
		bool	is_internal,
		GetBrowseImageUrlType	get_browse_image_url,
		str	media_content_type,
		str	media_content_id,
		str \| None	media_image_id = `None`,
		MusicServiceItem \| None	item = `None`
	)

Get thumbnail URL.

Definition at line 75 of file media_browser.py.

◆ item_payload()

BrowseMedia homeassistant.components.sonos.media_browser.item_payload	(	DidlObject	item,
			get_thumbnail_url = `None`
	)

Create response payload for a single media item.

Used by async_browse_media.

Definition at line 271 of file media_browser.py.

◆ library_payload()

BrowseMedia homeassistant.components.sonos.media_browser.library_payload	(	MusicLibrary	media_library,
			get_thumbnail_url = `None`
	)

Create response payload to describe contents of a specific library.

Used by async_browse_media.

Definition at line 387 of file media_browser.py.

◆ media_source_filter()

bool homeassistant.components.sonos.media_browser.media_source_filter ( BrowseMedia item )

Filter media sources.

Definition at line 103 of file media_browser.py.

◆ root_payload()

BrowseMedia homeassistant.components.sonos.media_browser.root_payload	(	HomeAssistant	hass,
		SonosSpeaker	speaker,
		SonosMedia	media,
		GetBrowseImageUrlType	get_browse_image_url
	)

Return root payload for Sonos.

Definition at line 299 of file media_browser.py.

Variable Documentation

◆ _LOGGER

homeassistant.components.sonos.media_browser._LOGGER = logging.getLogger(__name__)

private

Definition at line 44 of file media_browser.py.

◆ GetBrowseImageUrlType

homeassistant.components.sonos.media_browser.GetBrowseImageUrlType

Definition at line 46 of file media_browser.py.

Home Assistant Unofficial Reference 2024.12.1

Functions

Variables