Installation

Prerequisites

  1. ESP-IDF v5.4 or higher — Install from Espressif's documentation.

  2. ESP32-S3 device — This SDK is tested on this chip.

  3. 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:

ComponentPurpose
espressif/esp_peerWebRTC
espressif/esp_captureCamera and microphone capture
espressif/esp_video_codecH.264 video encoder
espressif/esp_audio_codecOpus audio encoder
espressif/esp_websocket_clientSignaling over WebSocket
espressif/cjsonJSON parsing
livekit/nanopbProtobuf (signaling messages)

You do not need to add these manually.

Next steps