Installation
Prerequisites
-
ESP-IDF v5.4 or higher — Install from Espressif's documentation.
-
ESP32-S3 device — This SDK is tested on this chip.
-
Stream account — Sign up at getstream.io.
Installation
Add the SDK as a git dependency in your project's idf_component.yml:
dependencies:
stream-video:
git: "https://github.com/GetStream/stream-video-esp32.git"
path: "components/stream-video"
version: "v0.1.0"Then add stream-video to REQUIRES in your main component's CMakeLists.txt.
Component dependencies
The SDK pulls in the following components automatically:
| Component | Purpose |
|---|---|
espressif/esp_peer |
WebRTC |
espressif/esp_capture |
Camera and microphone capture |
espressif/esp_video_codec |
H.264 video encoder |
espressif/esp_audio_codec |
Opus audio encoder |
espressif/esp_websocket_client |
Signaling over WebSocket |
espressif/cjson |
JSON parsing |
livekit/nanopb |
Protobuf (signaling messages) |
You do not need to add these manually.
Next steps
- Quickstart — Application flow and minimal example.
- Client auth — Set up tokens and authentication.