homeassistant.components.media_source Namespace Reference

Namespaces
	const
	error
	local_source
	models

Classes
class	MediaSourceProtocol

Functions
MediaSourceItem	_get_media_item (HomeAssistant hass, str|None media_content_id, str|None target_media_player)
None	_process_media_source_platform (HomeAssistant hass, str domain, MediaSourceProtocol platform)
BrowseMediaSource	async_browse_media (HomeAssistant hass, str|None media_content_id, *Callable[[BrowseMedia], bool]|None content_filter=None)
PlayMedia	async_resolve_media (HomeAssistant hass, str media_content_id, str|None|UndefinedType target_media_player=UNDEFINED)
bool	async_setup (HomeAssistant hass, ConfigType config)
str	generate_media_source_id (str domain, str identifier)
bool	is_media_source_id (str media_content_id)
None	websocket_browse_media (HomeAssistant hass, ActiveConnection connection, dict[str, Any] msg)
None	websocket_resolve_media (HomeAssistant hass, ActiveConnection connection, dict[str, Any] msg)

Variables
list	__all__
	CONFIG_SCHEMA = cv.empty_config_schema(DOMAIN)

Detailed Description

The media_source integration.

Function Documentation

_get_media_item()

MediaSourceItem homeassistant.components.media_source._get_media_item ( HomeAssistant  hass, str | None  media_content_id, str | None   target_media_player  )

private

Return media item.

Definition at line 104 of file __init__.py.

_process_media_source_platform()

None homeassistant.components.media_source._process_media_source_platform ( HomeAssistant  hass, str  domain, MediaSourceProtocol  platform  )

private

Process a media source platform.

Definition at line 94 of file __init__.py.

async_browse_media()

BrowseMediaSource homeassistant.components.media_source.async_browse_media	(	HomeAssistant	hass,
		str | None	media_content_id,
		*Callable[[BrowseMedia], bool] | None	content_filter = None
	)

Return media player browse media results.

Definition at line 122 of file __init__.py.

async_resolve_media()

PlayMedia homeassistant.components.media_source.async_resolve_media	(	HomeAssistant	hass,
		str	media_content_id,
		str | None | UndefinedType	target_media_player = UNDEFINED
	)

Get info to play media.

Definition at line 149 of file __init__.py.

async_setup()

bool homeassistant.components.media_source.async_setup	(	HomeAssistant	hass,
		ConfigType	config
	)

Set up the media_source component.

Definition at line 79 of file __init__.py.

generate_media_source_id()

str homeassistant.components.media_source.generate_media_source_id	(	str	domain,
		str	identifier
	)

Generate a media source ID.

Definition at line 71 of file __init__.py.

is_media_source_id()

bool homeassistant.components.media_source.is_media_source_id

(

str

media_content_id

)

Test if identifier is a media source.

Definition at line 66 of file __init__.py.

websocket_browse_media()

None homeassistant.components.media_source.websocket_browse_media	(	HomeAssistant	hass,
		ActiveConnection	connection,
		dict[str, Any]	msg
	)

Browse available media.

Definition at line 180 of file __init__.py.

websocket_resolve_media()

None homeassistant.components.media_source.websocket_resolve_media	(	HomeAssistant	hass,
		ActiveConnection	connection,
		dict[str, Any]	msg
	)

Resolve media.

Definition at line 202 of file __init__.py.

Variable Documentation

__all__

list homeassistant.components.media_source.__all__

private

Initial value:

=  [
    "DOMAIN",
    "is_media_source_id",
    "generate_media_source_id",
    "async_browse_media",
    "async_resolve_media",
    "BrowseMediaSource",
    "PlayMedia",
    "MediaSourceItem",
    "Unresolvable",
    "MediaSource",
    "MediaSourceError",
    "MEDIA_CLASS_MAP",
    "MEDIA_MIME_TYPES",
]

Definition at line 39 of file __init__.py.

CONFIG_SCHEMA

homeassistant.components.media_source.CONFIG_SCHEMA = cv.empty_config_schema(DOMAIN)

Definition at line 56 of file __init__.py.