Update WebRTC provider documentation to reference new APIs. #2410
Conversation
📝 WalkthroughWalkthroughThe documentation for the camera entity has been revised to reflect changes in WebRTC integration. The section previously titled "RTSP to WebRTC" has been renamed to "WebRTC Providers," with accompanying content removed and replaced. The new documentation details how to use libraries from Changes
Sequence Diagram(s)sequenceDiagram
participant User
participant Camera
participant WebRTCProvider
User->>Camera: Request WebRTC stream
Camera->>WebRTCProvider: Register provider
WebRTCProvider-->>Camera: Confirmation
Camera-->>User: Stream available
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Outside diff range and nitpick comments (1)
docs/core/entity/camera.md (1)
107-110: LGTM! Consider adding a brief explanation of WebRTC Providers.The updated documentation for WebRTC Providers is clear and aligns well with the PR objectives. It effectively explains how to implement WebRTC providers using the new APIs.
To enhance clarity for developers who might be new to the concept, consider adding a brief explanation of what WebRTC Providers are and their purpose in the context of Home Assistant camera integrations.
For example, you could add:
### WebRTC Providers +WebRTC Providers allow camera integrations to offer real-time, low-latency video streaming directly to the Home Assistant frontend using the WebRTC protocol. This can provide better performance and lower latency compared to traditional streaming methods. + An integration may provide a WebRTC stream from an existing camera's stream source using the libraries in `homeassistant.components.camera.webrtc`. An integration may implement `CameraWebRTCProvider` and register it with `async_register_webrtc_provider`. The current best practice is for an integration to provide the actual stream manipulation with an Add-on or external service. The addition of the `go2rtc` integration in Home Assistant Core makes usage of these APIs rarely needed.
Proposed change
Update WebRTC provider documentation to reference new APIs added in home-assistant/core#124410 when adding
go2rtc.Type of change
Additional information
Summary by CodeRabbit
homeassistant.components.camera.webrtc.