> ## Documentation Index
> Fetch the complete documentation index at: https://docs.youka.io/llms.txt
> Use this file to discover all available pages before exploring further.

# 预设

> 管理可复用的渲染配置

预设是一种可复用的渲染配置——背景、字幕样式、布局以及其他视觉设置——你可以将它应用到任何项目或导出中。当你希望在许多轨道中保持一致的视觉风格时，预设非常适合。

查看 [Render settings reference](/en/render-settings-reference) 以获取完整的
`preset` 结构以及每个由枚举支持的选项。

## `preset schema`

返回预设设置的 JSON Schema。在创建或更新预设之前，用它来发现有效字段。

```bash theme={null}
youka preset schema --json
```

<Tip>
  Agent 在修改预设之前应先调用 `preset schema`，以便了解准确的字段名称和值类型。
</Tip>

## `preset list`

列出经过身份验证的账户所拥有的所有预设。

```bash theme={null}
youka preset list --json
```

## `preset show`

通过 ID 获取单个预设。

```bash theme={null}
youka preset show <presetId> --json
```

## `preset create`

创建一个新预设。

```bash theme={null}
youka preset create [options]
```

### Options

| 选项                 | 说明                  |
| ------------------ | ------------------- |
| `--name <name>`    | 预设名称                |
| `--default`        | 将新预设标记为默认预设         |
| `--body <file\|->` | 从文件或 stdin 读取完整的请求体 |

<Note>
  请求体应包含完整的 `preset` 对象。对于较大的载荷，建议使用 `--body` 而不是内联 JSON。
</Note>

### Examples

<CodeGroup>
  ```bash from-file theme={null}
  youka preset create \
    --name "Neon Night" \
    --body ./neon-preset.json \
    --json
  ```

  ```bash make-default theme={null}
  youka preset create \
    --name "Red Cinema" \
    --body ./red-cinema.json \
    --default \
    --json
  ```

  ```bash from-stdin theme={null}
  cat ./preset.json | youka preset create --name "From stdin" --body - --json
  ```
</CodeGroup>

CLI 标志会覆盖 `--body` 中对应的字段。

## `preset update`

更新一个现有预设。

```bash theme={null}
youka preset update <presetId> [options]
```

| 选项                 | 说明                  |
| ------------------ | ------------------- |
| `--name <name>`    | 新名称                 |
| `--body <file\|->` | 从文件或 stdin 读取完整的请求体 |

示例：

```bash theme={null}
youka preset update $PRESET_ID \
  --name "Neon Night v2" \
  --body ./neon-v2.json \
  --json
```

## `preset delete`

通过 ID 删除一个预设。

```bash theme={null}
youka preset delete <presetId> --json
```

<Warning>
  删除预设不会删除此前使用该预设渲染的项目或导出。未来引用已删除预设的导出将失败。
</Warning>

## `preset default`

获取或设置默认预设。

```bash theme={null}
youka preset default --json
youka preset default <presetId> --json
```

不带参数时，该命令会返回当前默认预设或 `null`。提供预设 ID 时，会将该预设标记为默认预设。

## 应用预设

使用 `--preset` 将预设应用到项目或导出：

<CodeGroup>
  ```bash on-create theme={null}
  youka project create ./song.mp3 --preset $PRESET_ID --wait
  ```

  ```bash on-settings-update theme={null}
  youka project settings $PROJECT_ID --preset $PRESET_ID
  ```

  ```bash on-export theme={null}
  youka export create $PROJECT_ID --preset $PRESET_ID --wait
  ```
</CodeGroup>

## 下一步

* [Render settings reference](/en/render-settings-reference) - 所有共享的预设字段
* [Projects](/zh/cli/projects) - 将预设应用到项目设置
* [Exports](/zh/cli/exports) - 在渲染时应用预设
* [Media](/zh/cli/media) - 预设引用的可复用媒体