Skip to content

Commit 0f2fb00

Browse files
committed
Added video demo to docs intro
1 parent bc631a2 commit 0f2fb00

File tree

5 files changed

+14
-4
lines changed

5 files changed

+14
-4
lines changed

docs/_static/control_example.m4v

2.07 MB
Binary file not shown.

docs/index.rst

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,9 +9,19 @@ all the way to a powerful system that offloads complex computation to a desktop
99

1010
All communication happens through `WebRTC <https://en.wikipedia.org/wiki/WebRTC>`_,
1111
using Python 3's asyncio and the wonderful `aiortc <https://aiortc.readthedocs.io/en/latest/index.html>`_ library,
12-
meaning that your robot can be controlled with low latency both from the browser and through Python,
12+
meaning that your robot can be controlled both from the browser and through Python,
1313
even when it is not connected to your local network.
1414

15+
.. raw:: html
16+
17+
<h2><a href="examples/basics/README.html"> Start The Tutorials</a></h2>
18+
<video playsinline loop autoplay muted style="max-width: 100%; margin-bottom: 10px; margin-top: 10px;">
19+
<source src="_static/control_example.m4v" type="video/mp4">
20+
</video>
21+
22+
Documentation
23+
================
24+
1525
.. toctree::
1626
:maxdepth: 2
1727

docs/installing.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ Then, you can complete the installation with pip::
2424

2525
.. note::
2626
It is recommended that you use the Pi 4 with RTCBot. While it was tested to work down to the Raspberry Pi 3B, it was observed to have
27-
extra latency, since the CPU had difficulty keeping up with encoding the video stream.
27+
extra latency, since the CPU had difficulty keeping up with encoding the video stream while processing controller input.
2828
This is because RTCBot currently cannot take advantage of the Pi's hardware acceleration,
2929
meaning that all video encoding is done in software.
3030

examples/mobile/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -193,7 +193,7 @@ The Pion server is easy to set up on Windows,Mac and Linux - all you need to do
193193

194194
**Linux/Mac**:
195195
```bash
196-
chmod +x ./simple-turn # allow executing the downloaded file
196+
chmod +x ./simple-turn-linux-amd64 # allow executing the downloaded file
197197
export USERS='myusername=mypassword'
198198
export REALM=my.server.ip
199199
export UDP_PORT=3478

examples/streaming/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -183,7 +183,7 @@ Also, remember to subscribe/put all subscriptions into `conn` _before_ initializ
183183

184184
## Adding Audio
185185

186-
Now let's add an audio stream. Be aware that a Pi 3 with USB microphone might struggle a bit sending both audio and video at the same time. Try the code on your desktop/laptop first to make sure it works before attempting use with the Raspberry Pi.
186+
Now let's add an audio stream. Be aware that a Pi 3 with USB microphone might struggle a bit sending both audio and video at the same time. Try the code on your desktop/laptop or a Pi 4 first to make sure it works before attempting use with the Pi 3.
187187

188188
Based on what you know of RTCBot so far, and knowing that you can use a microphone with the `Microphone` class, do you think you can figure out audio just looking at the video code above?
189189

0 commit comments

Comments
 (0)