homeassistant.components.roku.browse_media Namespace Reference

Functions
BrowseMedia	async_browse_media (HomeAssistant hass, RokuDataUpdateCoordinator coordinator, GetBrowseImageUrlType get_browse_image_url, str|None media_content_id, str|None media_content_type)
BrowseMedia|None	build_item_response (RokuDataUpdateCoordinator coordinator, dict payload, GetBrowseImageUrlType get_browse_image_url)
str|None	get_thumbnail_url_full (RokuDataUpdateCoordinator coordinator, bool is_internal, GetBrowseImageUrlType get_browse_image_url, str media_content_type, str media_content_id, str|None media_image_id=None)
BrowseMedia	item_payload (dict item, RokuDataUpdateCoordinator coordinator, GetBrowseImageUrlType get_browse_image_url)
BrowseMedia	root_payload (HomeAssistant hass, RokuDataUpdateCoordinator coordinator, GetBrowseImageUrlType get_browse_image_url)

Variables
dictionary	CONTAINER_TYPES_SPECIFIC_MEDIA_CLASS
dictionary	CONTENT_TYPE_MEDIA_CLASS
list	EXPANDABLE_MEDIA_TYPES
	GetBrowseImageUrlType
list	PLAYABLE_MEDIA_TYPES

Detailed Description

Support for media browsing.

Function Documentation

async_browse_media()

BrowseMedia homeassistant.components.roku.browse_media.async_browse_media	(	HomeAssistant	hass,
		RokuDataUpdateCoordinator	coordinator,
		GetBrowseImageUrlType	get_browse_image_url,
		str | None	media_content_id,
		str | None	media_content_type
	)

Browse media.

Definition at line 67 of file browse_media.py.

build_item_response()

BrowseMedia | None homeassistant.components.roku.browse_media.build_item_response	(	RokuDataUpdateCoordinator	coordinator,
		dict	payload,
		GetBrowseImageUrlType	get_browse_image_url
	)

Create response payload for the provided media query.

Definition at line 168 of file browse_media.py.

get_thumbnail_url_full()

str | None homeassistant.components.roku.browse_media.get_thumbnail_url_full	(	RokuDataUpdateCoordinator	coordinator,
		bool	is_internal,
		GetBrowseImageUrlType	get_browse_image_url,
		str	media_content_type,
		str	media_content_id,
		str | None	media_image_id = None
	)

Get thumbnail URL.

Definition at line 46 of file browse_media.py.

item_payload()

BrowseMedia homeassistant.components.roku.browse_media.item_payload	(	dict	item,
		RokuDataUpdateCoordinator	coordinator,
		GetBrowseImageUrlType	get_browse_image_url
	)

Create response payload for a single media item.

Used by async_browse_media.

Definition at line 221 of file browse_media.py.

root_payload()

BrowseMedia homeassistant.components.roku.browse_media.root_payload	(	HomeAssistant	hass,
		RokuDataUpdateCoordinator	coordinator,
		GetBrowseImageUrlType	get_browse_image_url
	)

Return root payload for Roku.

Definition at line 108 of file browse_media.py.

Variable Documentation

CONTAINER_TYPES_SPECIFIC_MEDIA_CLASS

dictionary homeassistant.components.roku.browse_media.CONTAINER_TYPES_SPECIFIC_MEDIA_CLASS

Initial value:

=  {
    MediaType.APPS: MediaClass.DIRECTORY,
    MediaType.CHANNELS: MediaClass.DIRECTORY,
}

Definition at line 28 of file browse_media.py.

CONTENT_TYPE_MEDIA_CLASS

dictionary homeassistant.components.roku.browse_media.CONTENT_TYPE_MEDIA_CLASS

Initial value:

=  {
    MediaType.APP: MediaClass.APP,
    MediaType.APPS: MediaClass.APP,
    MediaType.CHANNEL: MediaClass.CHANNEL,
    MediaType.CHANNELS: MediaClass.CHANNEL,
}

Definition at line 21 of file browse_media.py.

EXPANDABLE_MEDIA_TYPES

list homeassistant.components.roku.browse_media.EXPANDABLE_MEDIA_TYPES

Initial value:

=  [
    MediaType.APPS,
    MediaType.CHANNELS,
]

Definition at line 38 of file browse_media.py.

GetBrowseImageUrlType

homeassistant.components.roku.browse_media.GetBrowseImageUrlType

Definition at line 43 of file browse_media.py.

PLAYABLE_MEDIA_TYPES

list homeassistant.components.roku.browse_media.PLAYABLE_MEDIA_TYPES

Initial value:

=  [
    MediaType.APP,
    MediaType.CHANNEL,
]

Definition at line 33 of file browse_media.py.