Home Assistant Unofficial Reference 2024.12.1
homeassistant.components.go2rtc.WebRTCProvider Class Reference
Inheritance diagram for homeassistant.components.go2rtc.WebRTCProvider:
[legend]
Collaboration diagram for homeassistant.components.go2rtc.WebRTCProvider:
[legend]

Public Member Functions

None __init__ (self, HomeAssistant hass, str url)
 
None async_close_session (self, str session_id)
 
None async_handle_async_webrtc_offer (self, Camera camera, str offer_sdp, str session_id, WebRTCSendMessage send_message)
 
bool async_is_supported (self, str stream_source)
 
None async_on_webrtc_candidate (self, str session_id, RTCIceCandidateInit candidate)
 
str domain (self)
 
- Public Member Functions inherited from homeassistant.components.camera.webrtc.CameraWebRTCProvider
None async_handle_async_webrtc_offer (self, Camera camera, str offer_sdp, str session_id, WebRTCSendMessage send_message)
 

Private Attributes

 _hass
 
 _rest_client
 
 _session
 
 _url
 

Detailed Description

WebRTC provider.

Definition at line 206 of file __init__.py.

Constructor & Destructor Documentation

◆ __init__()

None homeassistant.components.go2rtc.WebRTCProvider.__init__ (   self,
HomeAssistant  hass,
str  url 
)
Initialize the WebRTC provider.

Definition at line 209 of file __init__.py.

Member Function Documentation

◆ async_close_session()

None homeassistant.components.go2rtc.WebRTCProvider.async_close_session (   self,
str  session_id 
)
Close the session.

Reimplemented from homeassistant.components.camera.webrtc.CameraWebRTCProvider.

Definition at line 290 of file __init__.py.

◆ async_handle_async_webrtc_offer()

None homeassistant.components.go2rtc.WebRTCProvider.async_handle_async_webrtc_offer (   self,
Camera  camera,
str  offer_sdp,
str  session_id,
WebRTCSendMessage  send_message 
)
Handle the WebRTC offer and return the answer via the provided callback.

Definition at line 227 of file __init__.py.

◆ async_is_supported()

bool homeassistant.components.go2rtc.WebRTCProvider.async_is_supported (   self,
str  stream_source 
)
Return if this provider is supports the Camera as source.

Reimplemented from homeassistant.components.camera.webrtc.CameraWebRTCProvider.

Definition at line 223 of file __init__.py.

◆ async_on_webrtc_candidate()

None homeassistant.components.go2rtc.WebRTCProvider.async_on_webrtc_candidate (   self,
str  session_id,
RTCIceCandidateInit   candidate 
)
Handle the WebRTC candidate.

Reimplemented from homeassistant.components.camera.webrtc.CameraWebRTCProvider.

Definition at line 279 of file __init__.py.

◆ domain()

str homeassistant.components.go2rtc.WebRTCProvider.domain (   self)
Return the integration domain of the provider.

Reimplemented from homeassistant.components.camera.webrtc.CameraWebRTCProvider.

Definition at line 218 of file __init__.py.

Member Data Documentation

◆ _hass

homeassistant.components.go2rtc.WebRTCProvider._hass
private

Definition at line 211 of file __init__.py.

◆ _rest_client

homeassistant.components.go2rtc.WebRTCProvider._rest_client
private

Definition at line 214 of file __init__.py.

◆ _session

homeassistant.components.go2rtc.WebRTCProvider._session
private

Definition at line 213 of file __init__.py.

◆ _url

homeassistant.components.go2rtc.WebRTCProvider._url
private

Definition at line 212 of file __init__.py.


The documentation for this class was generated from the following file: