jeans/developers.home-assistant
jeans/developers.home-assistant
1
0
Fork 0
mirror of https://github.com/home-assistant/developers.home-assistant.git synced 2025-07-09 18:36:29 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #1092 from allenporter/camera-stream

Browse Source 
Improve `Camera` entity documentation
This commit is contained in:
Allen Porter 2021-10-22 22:28:15 -07:00 committed by GitHub
commit 36029853a3
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 30 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

31
docs/core/entity/camera.md
View File

@ -14,11 +14,23 @@ Properties should always only return information from memory and not do I/O (lik
| Name | Type | Default | Description
| ---- | ---- | ------- | -----------
| is_recording | bool | None | Indication of whether the camera is recording. Used to determine `state`.
| is_streaming | bool | None | Indication of whether the camera is streaming. Used to determine `state`.
| motion_detection_enabled | bool | False | Indication of whether the camera has motion detection enabled.
| is_on | bool | True | Indication camera is on.
| brand | str | None | The brand (manufacturer) of the camera.
| model | str | None | The model of the camera.
| frame_interval | float | 0.5 | The interval between frames of the stream.
| frontend_stream_type | str | None | Used with `SUPPORT_STREAM` to tell the frontend which type of stream to use
(`STREAM_TYPE_HLS` or `STREAM_TYPE_WEBRTC`)
### Supported features
Supported features constants are combined using the bitwise or (`|`) operator.
| Name | Bit value | Description |
| ---------------------------------- | --- | ------------------------------------------------------------------------------------------- |
| `SUPPORT_ON_OFF` | 1 | The device supports `turn_on` and `turn_off` |
| `SUPPORT_STREAM` | 2 | The device supports streaming |
## Methods
@ -53,7 +65,9 @@ class MyCamera(Camera):
### Stream Source
The stream source should return a url that is usable by ffmpeg.
The stream source should return a url that is usable by ffmpeg (e.g. an RTSP url). Requires `SUPPORT_STREAM`.
A camera entity with a stream source by default uses `STREAM_TYPE_HLS` to tell the frontend to use an HLS feed with the `stream` component. This stream source will also be used with `stream` for recording.
```python
class MyCamera(Camera):
@ -63,6 +77,21 @@ class MyCamera(Camera):
```
A common way for a camera entity to render a camera still image is to pass the stream source to `async_get_image` in the `ffmpeg` component.
### WebRTC Streams
WebRTC enabled cameras can be used by facilitating a direct connection with the home assistant frontend. This usage requires `SUPPORT_STREAM` with `frontend_stream_type` set to `STREAM_TYPE_WEB_RTC`. The integration should implement `async_handle_web_rtc_offer` which passes the frontend's SDP offer to the device and returns back the answer.
WebRTC streams do not use the `stream` component and do not support recording.
```python
class MyCamera(Camera):
async def async_handle_web_rtc_offer(self, offer_sdp: str) -> str | None:
"""Handle the WebRTC offer and return an answer."""
```
### Turn on
```python