Every option can be given either as a command-line flag or as a key in a YAML config file. Command-line arguments always win over the file.

The camera control options are compatible with the official rpicam-apps, so the Raspberry Pi camera control documentation applies here too.

• Camera and Video Input
• Sub-stream
• Audio
• Image Controls
• Recording
• WebRTC
• IPC
• Signaling
• Object Detection and Tracking
• Config File
• Multi-camera

Camera and Video Input複製段落連結

Sub-stream複製段落連結

A second, usually smaller, capture stream from the same camera. Live streaming and recording can each be pointed at either stream, so you can (for example) record at full resolution while streaming a downscaled copy, or feed a small stream to the detector while the viewer still gets the full picture.

The sub-stream is off unless both --sub-width and --sub-height are set. If either exceeds the main stream's dimensions it is clamped to the main stream.

Audio複製段落連結

Image Controls複製段落連結

These are available on builds with libcamera support. They have no effect on a V4L2 or libargus camera.

Recording複製段落連結

See Recording for the directory layout, rotation policy, and the DataChannel commands that drive on-demand capture.

WebRTC複製段落連結

IPC複製段落連結

Bridges a WebRTC DataChannel to a local Unix socket, so processes on the device can exchange messages with the browser. See Advanced Usage and Gamepad Input.

Signaling複製段落連結

At least one signaling transport must be enabled or the process exits. See Signaling for the connection flows.

MQTT複製段落連結

WHEP複製段落連結

LiveKit複製段落連結

Cloudflare Realtime SFU複製段落連結

The device API relays the handshake and holds the session a viewer has to pull. See Signaling for the exchange and Broadcasting to many viewers for a worked example.

The App ID and Secret are what let a device handshake with Cloudflare itself instead of going through the relay, and only the sponsor build carries that logic.

Object Detection and Tracking複製段落連結

Available in the sponsor build on NVIDIA Jetson.

Config File複製段落連結

--config points at a YAML file. Every long-form option is accepted as a key, without the leading --, and boolean flags take true / false.

/path/to/pi-webrtc --config=/path/to/config.yml

A starting point ships as config/config.yml:

# ── Video input ──
camera: libcamera:0
fps: 60
width: 1920
height: 1080

# ── Hardware / encoding ──
hw-accel: true # Set to false on Raspberry Pi 5, which has no hardware encoder
no-adaptive: false

# ── Audio ──
no-audio: true

# ── Device identity ──
uid: your-device-uid

# ── MQTT signaling ──
use-mqtt: true
mqtt-host: your-mqtt-broker.example.com
mqtt-port: 8883
mqtt-username: your-mqtt-username
mqtt-password: your-mqtt-password

# ── IPC ──
enable-ipc: true

# ── Recording ──
record-path: /path/to/recording/output

Things worth knowing:

• Command-line arguments take priority. A flag on the command line overrides the same key in the file, which makes the file a good place for defaults you occasionally override.
• Unknown keys are ignored rather than treated as errors, so a config file can carry comments-as-keys or settings for a newer version without breaking an older binary.
• Only scalar values are read. Nested mappings and sequences are skipped, with the single exception of the cameras: list below.

Multi-camera複製段落連結

^* Sponsor build.

Use cameras: to run multiple cameras from a single pi-webrtc process. Each camera inherits the global camera settings and can override them individually.

uid: home-jetson-orin

cameras:
  - camera: libargus:0
    alias: front
    fps: 60
    width: 1920
    height: 1080
    sub-width: 720
    sub-height: 480
    record-source: main
    webrtc-source: sub
    webrtc: true
    record: true
  - camera: libargus:1
    alias: side
    fps: 60
    width: 1280
    height: 720
    webrtc: false
    record: true

record-path: /home/nx/video
use-whep: true
whep-port: 8080

Each camera can enable or disable WebRTC and recording independently:

Each camera is recorded in its own subdirectory. In this example, the front camera is recorded to /home/nx/video/front/, while the side camera is recorded to /home/nx/video/side/.

Each camera with webrtc: true is available build webrtc connections at its own path. In this example, http://<device-ip>:8080/front plays the front camera, while the root path http://<device-ip>:8080/ plays the first webrtc: true camera. The side camera is not available through WHEP because of webrtc:false.

Sponsor Build複製段落連結

Options marked ^* above are part of the sponsor build. See SPONSORS.md for what is included.