新增示例库逻辑
This commit is contained in:
42
docs/zh/user-guide/api.md
Normal file
42
docs/zh/user-guide/api.md
Normal file
@@ -0,0 +1,42 @@
|
||||
# API 使用
|
||||
|
||||
Pixelle-Video 提供完整的 Python API,方便集成到你的项目中。
|
||||
|
||||
---
|
||||
|
||||
## 快速开始
|
||||
|
||||
```python
|
||||
from pixelle_video.service import PixelleVideoCore
|
||||
import asyncio
|
||||
|
||||
async def main():
|
||||
# 初始化
|
||||
pixelle = PixelleVideoCore()
|
||||
await pixelle.initialize()
|
||||
|
||||
# 生成视频
|
||||
result = await pixelle.generate_video(
|
||||
text="为什么要养成阅读习惯",
|
||||
mode="generate",
|
||||
n_scenes=5
|
||||
)
|
||||
|
||||
print(f"视频已生成: {result.video_path}")
|
||||
|
||||
# 运行
|
||||
asyncio.run(main())
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## API 参考
|
||||
|
||||
详细 API 文档请查看 [API 概览](../reference/api-overview.md)。
|
||||
|
||||
---
|
||||
|
||||
## 示例
|
||||
|
||||
更多使用示例请参考项目的 `examples/` 目录。
|
||||
|
||||
48
docs/zh/user-guide/templates.md
Normal file
48
docs/zh/user-guide/templates.md
Normal file
@@ -0,0 +1,48 @@
|
||||
# 模板开发
|
||||
|
||||
如何创建自定义视频模板。
|
||||
|
||||
---
|
||||
|
||||
## 模板简介
|
||||
|
||||
视频模板使用 HTML 定义视频画面的布局和样式。
|
||||
|
||||
---
|
||||
|
||||
## 模板结构
|
||||
|
||||
模板位于 `templates/` 目录,按尺寸分组:
|
||||
|
||||
```
|
||||
templates/
|
||||
├── 1080x1920/ # 竖屏
|
||||
├── 1920x1080/ # 横屏
|
||||
└── 1080x1080/ # 方形
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 创建模板
|
||||
|
||||
1. 复制现有模板文件
|
||||
2. 修改 HTML 和 CSS
|
||||
3. 保存到对应尺寸目录
|
||||
4. 在 Web 界面中选择使用
|
||||
|
||||
---
|
||||
|
||||
## 模板变量
|
||||
|
||||
模板支持以下变量:
|
||||
|
||||
- `{{ title }}` - 视频标题
|
||||
- `{{ text }}` - 分镜文本
|
||||
- `{{ image }}` - 分镜图片
|
||||
|
||||
---
|
||||
|
||||
## 更多信息
|
||||
|
||||
详细的模板开发指南即将推出。
|
||||
|
||||
77
docs/zh/user-guide/web-ui.md
Normal file
77
docs/zh/user-guide/web-ui.md
Normal file
@@ -0,0 +1,77 @@
|
||||
# Web 界面使用指南
|
||||
|
||||
详细介绍 Pixelle-Video Web 界面的各项功能。
|
||||
|
||||
---
|
||||
|
||||
## 界面布局
|
||||
|
||||
Web 界面采用三栏布局:
|
||||
|
||||
- **左侧栏**: 内容输入与音频设置
|
||||
- **中间栏**: 语音与视觉设置
|
||||
- **右侧栏**: 视频生成与预览
|
||||
|
||||
---
|
||||
|
||||
## 系统配置
|
||||
|
||||
首次使用需要配置 LLM 和图像生成服务。详见 [配置说明](../getting-started/configuration.md)。
|
||||
|
||||
---
|
||||
|
||||
## 内容输入
|
||||
|
||||
### 生成模式
|
||||
|
||||
- **AI 生成内容**: 输入主题,AI 自动创作文案
|
||||
- **固定文案内容**: 直接输入完整文案
|
||||
|
||||
### 背景音乐
|
||||
|
||||
- 支持内置音乐
|
||||
- 支持自定义音乐文件
|
||||
|
||||
---
|
||||
|
||||
## 语音设置
|
||||
|
||||
### TTS 工作流
|
||||
|
||||
- 选择 TTS 工作流
|
||||
- 支持 Edge-TTS、Index-TTS 等
|
||||
|
||||
### 参考音频
|
||||
|
||||
- 上传参考音频进行声音克隆
|
||||
- 支持 MP3/WAV/FLAC 等格式
|
||||
|
||||
---
|
||||
|
||||
## 视觉设置
|
||||
|
||||
### 图像生成
|
||||
|
||||
- 选择图像生成工作流
|
||||
- 设置图像尺寸
|
||||
- 调整提示词前缀控制风格
|
||||
|
||||
### 视频模板
|
||||
|
||||
- 选择视频模板
|
||||
- 支持竖屏/横屏/方形
|
||||
- 可预览模板效果
|
||||
|
||||
---
|
||||
|
||||
## 生成视频
|
||||
|
||||
点击「生成视频」按钮后,系统会:
|
||||
|
||||
1. 生成视频文案
|
||||
2. 为每个分镜生成配图
|
||||
3. 合成语音解说
|
||||
4. 合成最终视频
|
||||
|
||||
生成完成后自动预览。
|
||||
|
||||
37
docs/zh/user-guide/workflows.md
Normal file
37
docs/zh/user-guide/workflows.md
Normal file
@@ -0,0 +1,37 @@
|
||||
# 工作流定制
|
||||
|
||||
如何自定义 ComfyUI 工作流以实现特定功能。
|
||||
|
||||
---
|
||||
|
||||
## 工作流简介
|
||||
|
||||
Pixelle-Video 基于 ComfyUI 架构,支持自定义工作流。
|
||||
|
||||
---
|
||||
|
||||
## 工作流类型
|
||||
|
||||
### TTS 工作流
|
||||
|
||||
位于 `workflows/selfhost/` 或 `workflows/runninghub/`
|
||||
|
||||
### 图像生成工作流
|
||||
|
||||
位于 `workflows/selfhost/` 或 `workflows/runninghub/`
|
||||
|
||||
---
|
||||
|
||||
## 自定义工作流
|
||||
|
||||
1. 在 ComfyUI 中设计你的工作流
|
||||
2. 导出为 JSON 文件
|
||||
3. 放置到 `workflows/` 目录
|
||||
4. 在 Web 界面中选择使用
|
||||
|
||||
---
|
||||
|
||||
## 更多信息
|
||||
|
||||
即将推出更详细的工作流定制指南。
|
||||
|
||||
Reference in New Issue
Block a user