homeassistant.components.go2rtc Namespace Reference

Namespaces
	config_flow
	const
	server

Classes
class	WebRTCProvider

Functions
str|None	_get_binary (HomeAssistant hass)
None	_remove_go2rtc_entries (HomeAssistant hass)
bool	async_setup (HomeAssistant hass, ConfigType config)
bool	async_setup_entry (HomeAssistant hass, ConfigEntry entry)
bool	async_unload_entry (HomeAssistant hass, ConfigEntry entry)

Variables
	_LOGGER = logging.getLogger(__name__)
tuple	_RETRYABLE_ERRORS = (ClientConnectionError, ServerConnectionError)
	_SUPPORTED_STREAMS
	CONFIG_SCHEMA

Detailed Description

The go2rtc component.

Function Documentation

_get_binary()

str | None homeassistant.components.go2rtc._get_binary ( HomeAssistant  hass )

private

Return the binary path if found.

Definition at line 201 of file __init__.py.

_remove_go2rtc_entries()

None homeassistant.components.go2rtc._remove_go2rtc_entries ( HomeAssistant  hass )

private

Remove go2rtc config entries, if any.

Definition at line 148 of file __init__.py.

async_setup()

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

Set up WebRTC.

Definition at line 103 of file __init__.py.

async_setup_entry()

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

Set up go2rtc from a config entry.

Definition at line 154 of file __init__.py.

async_unload_entry()

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

Unload a go2rtc config entry.

Definition at line 196 of file __init__.py.

Variable Documentation

_LOGGER

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

private

Definition at line 55 of file __init__.py.

_RETRYABLE_ERRORS

tuple homeassistant.components.go2rtc._RETRYABLE_ERRORS = (ClientConnectionError, ServerConnectionError)

private

Definition at line 100 of file __init__.py.

_SUPPORTED_STREAMS

homeassistant.components.go2rtc._SUPPORTED_STREAMS

private

Initial value:

=  frozenset(
    (
        "bubble",
        "dvrip",
        "expr",
        "ffmpeg",
        "gopro",
        "homekit",
        "http",
        "https",
        "httpx",
        "isapi",
        "ivideon",
        "kasa",
        "nest",
        "onvif",
        "roborock",
        "rtmp",
        "rtmps",
        "rtmpx",
        "rtsp",
        "rtsps",
        "rtspx",
        "tapo",
        "tcp",
        "webrtc",
        "webtorrent",
    )
)

Definition at line 57 of file __init__.py.

CONFIG_SCHEMA

homeassistant.components.go2rtc.CONFIG_SCHEMA

Initial value:

=  vol.Schema(
    {
        DOMAIN: vol.Schema(
            {
                vol.Exclusive(CONF_URL, DOMAIN, DEBUG_UI_URL_MESSAGE): cv.url,
                vol.Exclusive(CONF_DEBUG_UI, DOMAIN, DEBUG_UI_URL_MESSAGE): cv.boolean,
            }
        )
    },
    extra=vol.ALLOW_EXTRA,
)

Definition at line 87 of file __init__.py.