Local-Voice/QUICKSTART.md
2025-09-21 18:33:36 +08:00

101 lines
2.7 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

# 快速启动指南
## 一键启动(推荐)
```bash
# 直接运行,系统会自动校准和启动监听
python multiprocess_recorder.py
# 指定角色
python multiprocess_recorder.py -c libai
# 详细模式
python multiprocess_recorder.py -v
```
## 编程方式启动
### 最简单的方式
```python
from control_system import ControlSystem
# 创建控制系统
control_system = ControlSystem()
# 一键启动(自动校准 + 自动监听)
control_system.start()
```
### 自定义配置
```python
from control_system import ControlSystem
config = {
'system': {'log_level': "INFO"},
'audio': {'sample_rate': 16000, 'channels': 1, 'chunk_size': 1024},
'recording': {'min_duration': 2.0, 'max_duration': 30.0, 'silence_threshold': 3.0},
'processing': {'enable_asr': True, 'enable_llm': True, 'enable_tts': True, 'character': 'libai'}
}
control_system = ControlSystem(config)
# 启动选项:
# auto_calibration=True - 自动校准语音检测器
# auto_monitoring=True - 自动启动音频监听
control_system.start(auto_calibration=True, auto_monitoring=True)
```
## 手动控制
```python
from control_system import ControlSystem
control_system = ControlSystem()
# 只启动进程,不自动校准和监听
control_system._start_processes()
# 手动步骤:
control_system.start_calibration() # 1. 启动校准
control_system.wait_for_calibration_complete() # 2. 等待校准完成
control_system.start_monitoring() # 3. 启动监听
# 运行中可以随时控制:
control_system.stop_monitoring() # 停止监听
control_system.start_monitoring() # 重新启动监听
# 查询状态:
status = control_system.get_calibration_status() # 获取校准状态
status = control_system.get_monitoring_status() # 获取监听状态
# 关闭系统:
control_system.shutdown()
```
## 启动流程
系统启动时会按以下顺序执行:
1. **启动进程** - 创建输入进程和输出进程
2. **自动校准** - 校准语音检测器约3-5秒
3. **启动监听** - 启用音频监听功能
4. **开始运行** - 进入主控制循环,开始检测语音
## 注意事项
- **校准时间**首次启动需要3-5秒进行语音检测器校准
- **音频权限**:确保麦克风权限已授予
- **环境安静**:校准时请保持环境安静
- **API密钥**如需LLM功能请设置 `ARK_API_KEY` 环境变量
## 故障排除
如果校准失败:
- 检查麦克风是否正常工作
- 确保环境安静,无背景噪音
- 尝试重新启动系统
如果监听失败:
- 检查音频设备是否被其他程序占用
- 尝试重启程序
- 查看日志文件排查问题