obs-auto-subtitle 项目使用教程

1. 项目的目录结构及介绍

obs-auto-subtitle 项目的目录结构如下：

obs-auto-subtitle/
├── README.md
├── LICENSE
├── src/
│   ├── main.py
│   ├── config.json
│   └── utils/
│       ├── subtitle_generator.py
│       └── audio_processor.py
└── docs/
    ├── installation.md
    ├── usage.md
    └── troubleshooting.md

目录结构介绍

• README.md: 项目的基本介绍和使用说明。
• LICENSE: 项目的开源许可证文件。
• src/: 项目的源代码目录。
  • main.py: 项目的启动文件。
  • config.json: 项目的配置文件。
  • utils/: 包含项目使用的辅助工具和模块。
    • subtitle_generator.py: 字幕生成模块。
    • audio_processor.py: 音频处理模块。
• docs/: 项目的文档目录，包含安装、使用和故障排除的文档。

2. 项目的启动文件介绍

项目的启动文件是 src/main.py。该文件负责初始化项目并启动字幕生成服务。以下是 main.py 的主要功能：

import os
from utils.subtitle_generator import SubtitleGenerator
from utils.audio_processor import AudioProcessor

def main():
    config_path = 'src/config.json'
    config = load_config(config_path)
    audio_processor = AudioProcessor(config)
    subtitle_generator = SubtitleGenerator(config)
    
    # 启动字幕生成服务
    subtitle_generator.start()

if __name__ == '__main__':
    main()

主要功能

• 加载配置文件: 从 config.json 文件中加载配置信息。
• 初始化音频处理器: 使用配置信息初始化 AudioProcessor 对象。
• 初始化字幕生成器: 使用配置信息初始化 SubtitleGenerator 对象。
• 启动字幕生成服务: 调用 SubtitleGenerator 的 start 方法启动字幕生成服务。

3. 项目的配置文件介绍

项目的配置文件是 src/config.json。该文件包含了项目运行所需的各种配置信息。以下是 config.json 的一个示例：

{
    "audio_input": "input.wav",
    "subtitle_output": "output.srt",
    "language": "zh",
    "api_key": "your_api_key_here"
}

配置项介绍

• audio_input: 输入音频文件的路径。
• subtitle_output: 输出字幕文件的路径。
• language: 字幕的语言，支持多种语言代码。
• api_key: 用于访问语音识别API的密钥。

通过修改 config.json 文件中的配置项，可以调整项目的输入输出路径、语言设置和API密钥等信息。

---

以上是 obs-auto-subtitle 项目的基本使用教程，涵盖了项目的目录结构、启动文件和配置文件的介绍。希望这些信息能帮助你更好地理解和使用该项目。