Home Assistant Unofficial Reference 2024.12.1
homeassistant.components.camera.webrtc.CameraWebRTCProvider Class Reference
Inheritance diagram for homeassistant.components.camera.webrtc.CameraWebRTCProvider:
[legend]
Collaboration diagram for homeassistant.components.camera.webrtc.CameraWebRTCProvider:
[legend]

Public Member Functions

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)
 

Detailed Description

WebRTC provider.

Definition at line 131 of file webrtc.py.

Member Function Documentation

◆ async_close_session()

None homeassistant.components.camera.webrtc.CameraWebRTCProvider.async_close_session (   self,
str  session_id 
)
Close the session.

Reimplemented in homeassistant.components.go2rtc.WebRTCProvider.

Definition at line 161 of file webrtc.py.

◆ async_handle_async_webrtc_offer()

None homeassistant.components.camera.webrtc.CameraWebRTCProvider.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 145 of file webrtc.py.

◆ async_is_supported()

bool homeassistant.components.camera.webrtc.CameraWebRTCProvider.async_is_supported (   self,
str  stream_source 
)
Determine if the provider supports the stream source.

Reimplemented in homeassistant.components.go2rtc.WebRTCProvider.

Definition at line 141 of file webrtc.py.

◆ async_on_webrtc_candidate()

None homeassistant.components.camera.webrtc.CameraWebRTCProvider.async_on_webrtc_candidate (   self,
str  session_id,
RTCIceCandidateInit   candidate 
)
Handle the WebRTC candidate.

Reimplemented in homeassistant.components.go2rtc.WebRTCProvider.

Definition at line 155 of file webrtc.py.

◆ domain()

str homeassistant.components.camera.webrtc.CameraWebRTCProvider.domain (   self)
Return the integration domain of the provider.

Reimplemented in homeassistant.components.go2rtc.WebRTCProvider.

Definition at line 136 of file webrtc.py.


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