Merge pull request sipeed#158 from 916BGAI/dev

add webrtc stream support

Author: lxowalle

docs/doc/en/sidebar.yaml

@@ -155,6 +155,8 @@ items:
         label: RTMP streaming
     -   file: video/uvc_streaming.md
         label: UVC streaming
+    -   file: video/webrtc_streaming.md
+        label: WebRTC streaming
 
 -   label: Network
     items:

docs/doc/en/video/webrtc_streaming.md

@@ -0,0 +1,72 @@
+---
+title: MaixCAM MaixPy Video Streaming WebRTC Push Streaming
+update:
+  - date: 2025-12-12
+    author: 916BGAI
+    version: 1.0.0
+    content: Initial documentation
+---
+
+<br/>
+
+> WebRTC streaming requires a browser that supports the WebRTC protocol. Please use the latest version of Chrome for testing.
+
+## Introduction
+
+This document explains how to push camera video using WebRTC.
+
+## Usage
+
+```python
+from maix import time, webrtc, camera, image
+
+cam = camera.Camera(640, 480, image.Format.FMT_YVU420SP)
+server = webrtc.WebRTC()
+server.bind_camera(cam)
+server.start()
+
+print(server.get_url())
+
+while True:
+    time.sleep(1)
+```
+
+Steps:
+
+1. Import the `time`, `webrtc`, `camera`, and `image` modules
+
+   ```python
+   from maix import time, webrtc, camera, image
+   ```
+
+2. Initialize the camera
+
+   ```python
+   # Initialize the camera with output resolution 640x480 and NV21 format
+
+   cam = camera.Camera(640, 480, image.Format.FMT_YVU420SP)
+   ```
+
+   - Note: The WebRTC module currently only supports NV21 format, so the camera must be configured to output NV21.
+
+3. Initialize and start the WebRTC server
+
+   ```python
+   server = webrtc.WebRTC()
+   server.bind_camera(cam)
+   server.start()
+   ```
+
+   - `server = webrtc.WebRTC()` creates a `WebRTC` instance.
+   - `server.bind_camera(cam)` binds a `Camera` instance to the WebRTC server. After binding, the original `Camera` object should no longer be used directly.
+   - `server.start()` starts the WebRTC streaming service.
+
+4. Print the WebRTC stream URL
+
+   ```python
+   print(server.get_url())
+   ```
+
+   - `server.get_url()` returns the playback URL for the WebRTC stream.
+
+5. Done — after running the script above, open the printed URL in your browser to view the camera stream.

docs/doc/zh/sidebar.yaml

@@ -155,6 +155,8 @@ items:
         label: RTMP 串流
     -   file: video/uvc_streaming.md
         label: UVC 串流
+    -   file: video/webrtc_streaming.md
+        label: WebRTC 串流
 
 -   label: 网络通信
     items:

docs/doc/zh/video/webrtc_streaming.md

@@ -0,0 +1,72 @@
+---
+title: MaixCAM MaixPy 视频流 WebRTC 推流
+update:
+  - date: 2025-12-11
+    author: 916BGAI
+    version: 1.0.0
+    content: 初版文档
+---
+
+<br/>
+
+> WebRTC 推流需要浏览器支持 WebRTC 协议，请使用最新版本的 Chrome 浏览器进行测试。
+
+## 简介
+
+本文档提供通过 WebRTC 推流摄像头画面的方法
+
+## 使用方法
+
+```python
+from maix import time, webrtc, camera, image
+
+cam = camera.Camera(640, 480, image.Format.FMT_YVU420SP)
+server = webrtc.WebRTC()
+server.bind_camera(cam)
+server.start()
+
+print(server.get_url())
+
+while True:
+    time.sleep(1)
+```
+
+步骤：
+
+1. 导入 time, webrtc, camera 和 image 模块
+
+   ```python
+   from maix import time, webrtc, camera, image
+   ```
+
+2. 初始化摄像头
+
+   ```python
+   # 初始化摄像头，输出分辨率640x480 NV21格式
+
+   cam = camera.Camera(640, 480, image.Format.FMT_YVU420SP)
+   ```
+
+   - 注意 WebRTC 模块目前只支持 NV21 格式， 因此摄像头需要配置为 NV21 格式输出
+
+3. 初始化并启动 WebRTC 对象
+
+   ```python
+   server = webrtc.WebRTC()
+   server.bind_camera(cam)
+   server.start()
+   ```
+
+   - `server = webrtc.WebRTC()` 用来创建一个 `WebRTC` 对象
+   - `server.bind_camera(cam)` 用来绑定一个 `Camera` 对象， 绑定后原 `Camera` 对象将不能再使用
+   - `server.start()` 用来启动 `webrtc` 推流
+
+4. 打印当前WebRTC流的URL
+
+   ```python
+   print(server.get_url())
+   ```
+
+   - `server.get_url()` 用来获取 `WebRTC` 的 `播放地址`。
+
+6. 完成，运行上须代码后, 你可以通过浏览器访问打印出的URL地址来查看摄像头画面

examples/vision/streaming/webrtc.py

@@ -0,0 +1,11 @@
+from maix import time, webrtc, camera, image
+
+cam = camera.Camera(640, 480, image.Format.FMT_YVU420SP)
+server = webrtc.WebRTC()
+server.bind_camera(cam)
+server.start()
+
+print(server.get_url())
+
+while True:
+    time.sleep(1)

projects/webrtc_stream/app.yaml

@@ -0,0 +1,12 @@
+id: webrtc_stream
+name: WebRTC Stream
+name[zh]: WebRTC 推流
+version: 1.0.0
+author: Sipeed Ltd
+icon: app.png
+desc: WebRTC Stream
+desc[zh]: WebRTC 推流
+files:
+  - assets
+  - app.yaml
+  - main.py