新增示例库逻辑
This commit is contained in:
52
docs/en/reference/api-overview.md
Normal file
52
docs/en/reference/api-overview.md
Normal file
@@ -0,0 +1,52 @@
|
||||
# API Overview
|
||||
|
||||
Pixelle-Video Python API reference documentation.
|
||||
|
||||
---
|
||||
|
||||
## Core Classes
|
||||
|
||||
### PixelleVideoCore
|
||||
|
||||
Main service class providing video generation functionality.
|
||||
|
||||
```python
|
||||
from pixelle_video.service import PixelleVideoCore
|
||||
|
||||
pixelle = PixelleVideoCore()
|
||||
await pixelle.initialize()
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Main Methods
|
||||
|
||||
### generate_video()
|
||||
|
||||
Primary method for generating videos.
|
||||
|
||||
**Parameters**:
|
||||
|
||||
- `text` (str): Topic or complete script
|
||||
- `mode` (str): Generation mode ("generate" or "fixed")
|
||||
- `n_scenes` (int): Number of scenes
|
||||
- `title` (str, optional): Video title
|
||||
- `tts_workflow` (str): TTS workflow
|
||||
- `image_workflow` (str): Image generation workflow
|
||||
- `frame_template` (str): Video template
|
||||
- `bgm_path` (str, optional): BGM file path
|
||||
|
||||
**Returns**: `VideoResult` object
|
||||
|
||||
---
|
||||
|
||||
## Examples
|
||||
|
||||
Check the `examples/` directory for more examples.
|
||||
|
||||
---
|
||||
|
||||
## More Information
|
||||
|
||||
Detailed API documentation coming soon.
|
||||
|
||||
60
docs/en/reference/config-schema.md
Normal file
60
docs/en/reference/config-schema.md
Normal file
@@ -0,0 +1,60 @@
|
||||
# Config Schema
|
||||
|
||||
Detailed explanation of the `config.yaml` configuration file.
|
||||
|
||||
---
|
||||
|
||||
## Configuration Structure
|
||||
|
||||
```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 Configuration
|
||||
|
||||
- `provider`: Provider (currently only supports openai-compatible interfaces)
|
||||
- `api_key`: API key
|
||||
- `base_url`: API service address
|
||||
- `model`: Model name
|
||||
|
||||
---
|
||||
|
||||
## ComfyUI Configuration
|
||||
|
||||
### Basic Configuration
|
||||
|
||||
- `comfyui_url`: Local ComfyUI address
|
||||
- `runninghub_api_key`: RunningHub API key (optional)
|
||||
|
||||
### Image Configuration
|
||||
|
||||
- `default_workflow`: Default image generation workflow
|
||||
- `prompt_prefix`: Prompt prefix
|
||||
|
||||
### TTS Configuration
|
||||
|
||||
- `default_workflow`: Default TTS workflow
|
||||
|
||||
---
|
||||
|
||||
## More Information
|
||||
|
||||
The configuration file is automatically created on first run.
|
||||
|
||||
Reference in New Issue
Block a user