pipecat/examples/p2p-webrtc/video-transform/README.md

Video Transform

A Pipecat example demonstrating how to send and receive audio and video using SmallWebRTCTransport. This project also applies image processing to video frames using OpenCV.

🚀 Quick Start

1️⃣ Start the Bot Server

📂 Navigate to the Server Directory

cd server

🔧 Set Up the Environment

1. Create and activate a virtual environment:

   python3 -m venv venv
   source venv/bin/activate  # On Windows: venv\Scripts\activate
   

2. Install dependencies:

   pip install -r requirements.txt
   

3. Configure environment variables:

   • Copy env.example to .env

   cp env.example .env
   

   • Add your API keys

▶️ Run the Server

python server.py

2️⃣ Test with SmallWebRTC Prebuilt UI

You can quickly test your bot using the SmallWebRTCPrebuiltUI:

• Open your browser and navigate to: 👉 http://localhost:7860
  • (Or use your custom port, if configured)

3️⃣ Connect Using a Custom Client App

For client-side setup, refer to the:

• Typescript Guide.
• iOS Guide.

⚠️ Important Note

Ensure the bot server is running before using any client implementations.

📌 Requirements

• Python 3.10+
• Node.js 16+ (for JavaScript components)
• Google API Key
• Modern web browser with WebRTC support

---

💡 Notes

• Ensure all dependencies are installed before running the server.
• Check the .env file for missing configurations.
• WebRTC requires a secure environment (HTTPS) for full functionality in production.

Happy coding! 🎉