69 lines
1.6 KiB
Markdown
69 lines
1.6 KiB
Markdown
# 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
|
||
```bash
|
||
cd server
|
||
```
|
||
|
||
#### 🔧 Set Up the Environment
|
||
1. Create and activate a virtual environment:
|
||
```bash
|
||
python3 -m venv venv
|
||
source venv/bin/activate # On Windows: venv\Scripts\activate
|
||
```
|
||
|
||
2. Install dependencies:
|
||
```bash
|
||
pip install -r requirements.txt
|
||
```
|
||
|
||
3. Configure environment variables:
|
||
- Copy `env.example` to `.env`
|
||
```bash
|
||
cp env.example .env
|
||
```
|
||
- Add your API keys
|
||
|
||
#### ▶️ Run the Server
|
||
```bash
|
||
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](client/typescript/README.md).
|
||
- [iOS Guide](client/ios/README.md).
|
||
|
||
## ⚠️ 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! 🎉 |