Skip to content

Commit 4aa680b

Browse files
committed
Update readme about new features
1 parent aa75a77 commit 4aa680b

File tree

1 file changed

+17
-6
lines changed

1 file changed

+17
-6
lines changed

README.md

+17-6
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,7 @@ Component **doesn't create devices and entities**. It creates only two services
8181
8282
## Custom card
8383
84-
As a `url` you can use any protocol supported in go2rtc or specify the stream name from the go2rtc config.
84+
As a `url` you can use any protocol supported in go2rtc or **specify the stream name** from the go2rtc config.
8585
As a `entity` you can use almost any camera from Hass.
8686

8787
**Minimal**
@@ -93,6 +93,13 @@ url: 'rtsp://rtsp:[email protected]:554/av_stream/ch0'
9393

9494
**or**
9595

96+
```yaml
97+
type: 'custom:webrtc-camera'
98+
url: 'camera1' # stream name from go2rtc.yaml
99+
```
100+
101+
**or**
102+
96103
```yaml
97104
type: 'custom:webrtc-camera'
98105
entity: camera.generic_stream # change to your camera entity_id
@@ -104,22 +111,28 @@ entity: camera.generic_stream # change to your camera entity_id
104111
type: 'custom:webrtc-camera'
105112
streams:
106113
- url: go2rtc_stream_hd
107-
name: HD
114+
name: HD # name is optional
108115
mode: webrtc # mode is optional
109116
- url: go2rtc_stream_sd
110117
name: SD
111-
mode: mse
118+
mode: mse
112119
```
113120

114121
**Full**
115122

123+
**All settings optional!** Only required setting - `url` or `entity` or `streams`.
124+
116125
```yaml
117126
type: 'custom:webrtc-camera'
127+
118128
url: 'rtsp://rtsp:[email protected]:554/av_stream/ch0'
129+
entity: camera.generic_stream
130+
mode: webrtc,webrtc/tcp,mse,hls,mjpeg # stream technology, default all of them
131+
server: http://192.168.1.123:1984/ # custom go2rtc server address, default empty
119132
120133
ui: true # custom video controls, default false
121134
122-
digital_ptz: # digital zoom and pan via mouse/touch. Defaults to:
135+
digital_ptz: # digital zoom and pan via mouse/touch, defaults:
123136
mouse_drag_pan: true
124137
mouse_wheel_zoom: true
125138
mouse_double_click_zoom: true
@@ -143,8 +156,6 @@ shortcuts: # custom shortcuts, default none
143156
service: switch.toggle
144157
service_data:
145158
entity_id: switch.camera_record
146-
147-
mode: webrtc,mse,hls,mjpeg # also available - webrtc/tcp
148159
```
149160

150161
Pan, tilt, zoom controls: [PTZ config examples](https://github.com/AlexxIT/WebRTC/wiki/PTZ-Config-Examples).

0 commit comments

Comments
 (0)