homeassistant.components.rtsp_to_webrtc Namespace Reference

Namespaces
	config_flow
	diagnostics

Functions
None	async_reload_entry (HomeAssistant hass, ConfigEntry entry)
bool	async_setup_entry (HomeAssistant hass, ConfigEntry entry)
bool	async_unload_entry (HomeAssistant hass, ConfigEntry entry)

Variables
string	_DEPRECATED = "deprecated"
	_LOGGER = logging.getLogger(__name__)
string	CONF_STUN_SERVER = "stun_server"
string	DATA_SERVER_URL = "server_url"
string	DATA_UNSUB = "unsub"
string	DOMAIN = "rtsp_to_webrtc"
int	TIMEOUT = 10

Detailed Description

RTSPtoWebRTC integration with an external RTSPToWebRTC Server.

WebRTC uses a direct communication from the client (e.g. a web browser) to a
camera device. Home Assistant acts as the signal path for initial set up,
passing through the client offer and returning a camera answer, then the client
and camera communicate directly.

However, not all cameras natively support WebRTC. This integration is a shim
for camera devices that support RTSP streams only, relying on an external
server RTSPToWebRTC that is a proxy. Home Assistant does not participate in
the offer/answer SDP protocol, other than as a signal path pass through.

Other integrations may use this integration with these steps:
- Check if this integration is loaded
- Call is_supported_stream_source for compatibility
- Call async_offer_for_stream_source to get back an answer for a client offer

Function Documentation

async_reload_entry()

None homeassistant.components.rtsp_to_webrtc.async_reload_entry	(	HomeAssistant	hass,
		ConfigEntry	entry
	)

Reload config entry when options change.

Definition at line 120 of file __init__.py.

async_setup_entry()

bool homeassistant.components.rtsp_to_webrtc.async_setup_entry	(	HomeAssistant	hass,
		ConfigEntry	entry
	)

Set up RTSPtoWebRTC from a config entry.

Definition at line 47 of file __init__.py.

async_unload_entry()

bool homeassistant.components.rtsp_to_webrtc.async_unload_entry	(	HomeAssistant	hass,
		ConfigEntry	entry
	)

Unload a config entry.

Definition at line 112 of file __init__.py.

Variable Documentation

_DEPRECATED

string homeassistant.components.rtsp_to_webrtc._DEPRECATED = "deprecated"

private

Definition at line 44 of file __init__.py.

_LOGGER

homeassistant.components.rtsp_to_webrtc._LOGGER = logging.getLogger(__name__)

private

Definition at line 36 of file __init__.py.

CONF_STUN_SERVER

string homeassistant.components.rtsp_to_webrtc.CONF_STUN_SERVER = "stun_server"

Definition at line 42 of file __init__.py.

DATA_SERVER_URL

string homeassistant.components.rtsp_to_webrtc.DATA_SERVER_URL = "server_url"

Definition at line 39 of file __init__.py.

DATA_UNSUB

string homeassistant.components.rtsp_to_webrtc.DATA_UNSUB = "unsub"

Definition at line 40 of file __init__.py.

DOMAIN

string homeassistant.components.rtsp_to_webrtc.DOMAIN = "rtsp_to_webrtc"

Definition at line 38 of file __init__.py.

TIMEOUT

int homeassistant.components.rtsp_to_webrtc.TIMEOUT = 10

Definition at line 41 of file __init__.py.