Skip to content

Commit 04f1e2d

Browse files
update readme
1 parent bc6d6ed commit 04f1e2d

File tree

1 file changed

+3
-96
lines changed
  • livekit-plugins/livekit-plugins-trillet-antibot

1 file changed

+3
-96
lines changed

livekit-plugins/livekit-plugins-trillet-antibot/README.md

Lines changed: 3 additions & 96 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,6 @@
1-
# Trillet Voiceguard Plugin
1+
# Trillet Antibot Plugin
22

3-
A real-time AI voice detection plugin for LiveKit that identifies synthetic/fake voices during voice calls. This plugin analyzes audio streams during the first 30 seconds of calls and can automatically terminate calls when fake voices are detected.
4-
5-
## Features
6-
7-
- 🎯 **Real-time Voice Detection**: Analyzes audio streams in real-time using AI voice detection
8-
- 🔊 **Audio Processing**: Converts audio to optimal format (16-bit PCM, Mono, 16kHz)
9-
-**WebSocket Integration**: Streams audio data to Trillet Voiceguard service via WebSocket
10-
- 🛡️ **Automatic Call Protection**: Optionally terminates calls when fake voices are detected
11-
- 📊 **Comprehensive Reporting**: Provides detailed analysis results and summaries
12-
- 🎚️ **Configurable Parameters**: Customizable detection parameters and thresholds
13-
- 💾 **Audio Recording**: Optional audio recording for archival purposes
3+
A real-time AI voice detection plugin for LiveKit that identifies synthetic/fake voices during voice calls. This plugin analyzes audio streams during the calls and can automatically terminate calls when fake voices are detected.
144

155
## Installation
166

@@ -278,25 +268,6 @@ The final summary includes:
278268
"fake_percentage": 70.0,
279269
"average_fake_confidence": 0.78,
280270
"average_real_confidence": 0.22,
281-
# Audio contribution info (if save_audio_to_s3=True)
282-
"audio_upload": {
283-
"success": True,
284-
"filename": "voiceguard_audio_room1_20240126_143022.wav",
285-
"uploaded_at": "20240126_143022",
286-
"file_size": 960000
287-
}
288-
}
289-
```
290-
291-
### Audio Data Contribution Status
292-
When `save_audio_to_s3=True`, your contribution status contains:
293-
```python
294-
{
295-
"success": True, # or False if contribution failed
296-
"filename": "voiceguard_audio_roomname_timestamp.wav",
297-
"uploaded_at": "20240126_143022",
298-
"file_size": 960000,
299-
"error": "Error message if success=False"
300271
}
301272
```
302273

@@ -327,13 +298,6 @@ The plugin automatically handles audio format conversion:
327298
- **Participants**: Processes audio from remote participants (incoming audio)
328299
- **Model Contribution**: When enabled, records WAV files (16-bit PCM, Mono, 16kHz) to help improve AI accuracy
329300

330-
## WebSocket Connection
331-
332-
The plugin connects to the Trillet Voiceguard service via WebSocket:
333-
- **URL**: `wss://p01--trillet-voice-guard-dev--j629vb9mq7pk.ccvhxjx8pb.code.run/trillet-voiceguard/ws/detect`
334-
- **Protocol**: Binary audio data in, JSON responses out
335-
- **Auto-reconnection**: Not implemented (single-session design)
336-
337301
## Logging
338302

339303
The plugin provides detailed logging at various levels:
@@ -351,64 +315,7 @@ The plugin provides detailed logging at various levels:
351315
5. **Model Improvement**: Consider enabling `save_audio_to_s3=True` to contribute to model enhancement
352316
6. **Privacy Compliance**: When contributing audio data, ensure you have appropriate consent and comply with privacy regulations
353317

354-
## Troubleshooting
355-
356-
### Common Issues
357-
358-
#### WebSocket Connection Failures
359-
```
360-
ERROR: Failed to connect to Voiceguard websocket
361-
```
362-
- Check your API key is valid
363-
- Verify network connectivity
364-
- Ensure the service is available
365-
366-
#### No Audio Data
367-
```
368-
WARNING: No audio data being processed
369-
```
370-
- Ensure participants are speaking
371-
- Check that audio tracks are being received
372-
- Verify room has remote participants
373-
374-
#### High False Positives
375-
- Increase `confidence_threshold` parameter
376-
- Consider using longer `segment_length` for more stable results
377-
378-
#### Detection Not Running
379-
- Ensure `start_streaming()` was called
380-
- Check logs for connection errors
381-
- Verify `duration_seconds` hasn't expired
382-
383-
#### Audio Data Contribution Issues
384-
```
385-
ERROR: Error contributing audio data
386-
```
387-
- Check your API key has contribution permissions
388-
- Verify network connectivity
389-
- Check server logs for detailed error information
390-
391-
#### Audio Contribution Not Working
392-
- Ensure `save_audio_to_s3=True` is set
393-
- Check that audio data is being received from participants
394-
- Verify the room has active audio streams
395-
396-
## Requirements
397-
398-
- Python 3.8+
399-
- LiveKit Python SDK
400-
- WebSocket support (websockets >= 11.0)
401-
- NumPy (for audio processing)
402-
- aiohttp (for S3 upload functionality)
403-
- Wave support (built-in Python module)
404-
405-
## License
406-
407-
[Your license information here]
408-
409318
## Support
410319

411320
For support and questions:
412-
- Email: [Your support email]
413-
- Documentation: [Your documentation URL]
414-
- Issues: [Your issue tracker URL]
321+

0 commit comments

Comments
 (0)