新增示例库逻辑
This commit is contained in:
52
docs/zh/reference/api-overview.md
Normal file
52
docs/zh/reference/api-overview.md
Normal file
@@ -0,0 +1,52 @@
|
||||
# API 概览
|
||||
|
||||
Pixelle-Video Python API 参考文档。
|
||||
|
||||
---
|
||||
|
||||
## 核心类
|
||||
|
||||
### PixelleVideoCore
|
||||
|
||||
主要服务类,提供视频生成功能。
|
||||
|
||||
```python
|
||||
from pixelle_video.service import PixelleVideoCore
|
||||
|
||||
pixelle = PixelleVideoCore()
|
||||
await pixelle.initialize()
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 主要方法
|
||||
|
||||
### generate_video()
|
||||
|
||||
生成视频的主要方法。
|
||||
|
||||
**参数**:
|
||||
|
||||
- `text` (str): 主题或完整文案
|
||||
- `mode` (str): 生成模式 ("generate" 或 "fixed")
|
||||
- `n_scenes` (int): 分镜数量
|
||||
- `title` (str, optional): 视频标题
|
||||
- `tts_workflow` (str): TTS 工作流
|
||||
- `image_workflow` (str): 图像生成工作流
|
||||
- `frame_template` (str): 视频模板
|
||||
- `bgm_path` (str, optional): BGM 文件路径
|
||||
|
||||
**返回**: `VideoResult` 对象
|
||||
|
||||
---
|
||||
|
||||
## 示例
|
||||
|
||||
查看 `examples/` 目录获取更多示例。
|
||||
|
||||
---
|
||||
|
||||
## 更多信息
|
||||
|
||||
详细的 API 文档即将推出。
|
||||
|
||||
60
docs/zh/reference/config-schema.md
Normal file
60
docs/zh/reference/config-schema.md
Normal file
@@ -0,0 +1,60 @@
|
||||
# 配置文件详解
|
||||
|
||||
`config.yaml` 配置文件的详细说明。
|
||||
|
||||
---
|
||||
|
||||
## 配置结构
|
||||
|
||||
```yaml
|
||||
llm:
|
||||
provider: openai
|
||||
api_key: "your-api-key"
|
||||
base_url: "https://dashscope.aliyuncs.com/compatible-mode/v1"
|
||||
model: "qwen-plus"
|
||||
|
||||
comfyui:
|
||||
comfyui_url: "http://127.0.0.1:8188"
|
||||
runninghub_api_key: ""
|
||||
|
||||
image:
|
||||
default_workflow: "runninghub/image_flux.json"
|
||||
prompt_prefix: "Minimalist illustration style"
|
||||
|
||||
tts:
|
||||
default_workflow: "selfhost/tts_edge.json"
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## LLM 配置
|
||||
|
||||
- `provider`: 提供商(目前仅支持 openai 兼容接口)
|
||||
- `api_key`: API 密钥
|
||||
- `base_url`: API 服务地址
|
||||
- `model`: 模型名称
|
||||
|
||||
---
|
||||
|
||||
## ComfyUI 配置
|
||||
|
||||
### 基础配置
|
||||
|
||||
- `comfyui_url`: 本地 ComfyUI 地址
|
||||
- `runninghub_api_key`: RunningHub API 密钥(可选)
|
||||
|
||||
### 图像配置
|
||||
|
||||
- `default_workflow`: 默认图像生成工作流
|
||||
- `prompt_prefix`: 提示词前缀
|
||||
|
||||
### TTS 配置
|
||||
|
||||
- `default_workflow`: 默认 TTS 工作流
|
||||
|
||||
---
|
||||
|
||||
## 更多信息
|
||||
|
||||
配置文件会自动在首次运行时创建。
|
||||
|
||||
Reference in New Issue
Block a user