Presets

Ein Preset ist eine wiederverwendbare Render-Konfiguration — Hintergrund, Untertitelstil, Layout — die du auf jedes Projekt oder jeden Export anwenden kannst. Verwende Presets, wenn du über viele Tracks hinweg ein konsistentes Erscheinungsbild haben möchtest. Siehe Render settings reference für die vollständige preset-Struktur und jede enum-basierte Option.

`client.presets.list(options?)`

Liste alle Presets auf, die dem authentifizierten Account gehören.

const presets = await client.presets.list();
presets.forEach((p) => console.log(p.id, p.name, p.isDefault));

`client.presets.get(presetId, options?)`

Rufe ein einzelnes Preset ab.

const preset = await client.presets.get("preset_abc123");

`client.presets.create(body, options?)`

Erstelle ein neues Preset.

const preset = await client.presets.create({
  name: "Neon Night",
  preset: {
    background: {
      type: "gradient",
      colors: ["#12001f", "#2f0a57"],
      angle: 90,
    },
    singerTextStyles: {
      0: {
        fontFamily: "Inter",
        textColor: "#00f5ff",
        effectColor: "#ff4fd8",
      },
    },
  },
  isDefault: false,
});

string

required

Anzeigename, der in der Youka-UI angezeigt wird.

KaraokePreset

required

Der vollständige Preset-Body. Verwende Render settings reference für die menschenlesbare Feldzuordnung oder KaraokePresetSchema.toJSONSchema() für das maschinenlesbare Schema.

boolean

Markiere das neue Preset als Account-Standard. Es kann immer nur ein Preset gleichzeitig der Standard sein.

Kombiniere das mit einem Idempotency-Key für sichere Wiederholungen:

const preset = await client.presets.create(body, {
  idempotencyKey: "create-neon-night-v1",
});

`client.presets.update(presetId, body, options?)`

Patche ein bestehendes Preset. Übergib eine beliebige Teilmenge von name, preset und isDefault.

const updated = await client.presets.update("preset_abc123", {
  name: "Neon Night v2",
  preset: {
    singerTextStyles: {
      0: { textColor: "#ff2a2a" },
    },
  },
});

`client.presets.delete(presetId, options?)`

Lösche ein Preset.

await client.presets.delete("preset_abc123", {
  idempotencyKey: "delete-preset_abc123",
});

Das Löschen eines Presets löscht keine Projekte oder Exporte, die zuvor damit gerendert wurden. Zukünftige Exporte, die auf das gelöschte Preset verweisen, werden fehlschlagen.

`client.presets.setDefault(presetId, options?)`

Markiere ein Preset als Standard für neue Projekte. Dies ist ein Convenience-Wrapper um client.presets.update(presetId, { isDefault: true }).

await client.presets.setDefault("preset_abc123");

Das Setzen eines neuen Standards hebt den vorherigen automatisch auf.

Gültige Felder ermitteln

Das SDK exportiert das Zod-Schema, das Preset-Bodies validiert. Wandle es zur Laufzeit in JSON Schema um — für Agents und Form-Builder:

import { KaraokePresetSchema } from "@youka/de/sdk";

const jsonSchema = KaraokePresetSchema.toJSONSchema();
console.log(jsonSchema);

Agent-Autor:innen: Rufe dieses Schema auf, bevor du Presets veränderst, damit das Modell die exakten Feldnamen und Werttypen kennt.

Menschenlesbare Referenz:

Ein Preset anwenden

Wende Presets an drei Stellen an:

Beim Erstellen eines Projekts
In den Projekteinstellungen
Beim Export

await client.projects.create({
  source: { type: "path", path: "./song.mp3" },
  presetId: "preset_abc123",
});

await client.projects.updateSettings("prj_abc123", {
  presetId: "preset_abc123",
});

await client.exports.create("prj_abc123", {
  presetId: "preset_abc123",
  resolution: "1080p",
});

Was als Nächstes

Render settings reference — alle gemeinsamen Feldpfade und Enum-Werte
Media — aus Preset-Bodies referenziert
Project settings — Presets auf ein Projekt anwenden
API presets — derselbe Ablauf über rohes HTTP
CLI presets — derselbe Ablauf aus dem Terminal
Exports — mit einem Preset rendern

Overview

How To

Customization

Audio

Settings

Exporting

Account

`client.presets.list(options?)`

`client.presets.get(presetId, options?)`

`client.presets.create(body, options?)`

`client.presets.update(presetId, body, options?)`

`client.presets.delete(presetId, options?)`

`client.presets.setDefault(presetId, options?)`

Gültige Felder ermitteln

Ein Preset anwenden

Was als Nächstes

​client.presets.list(options?)

​client.presets.get(presetId, options?)

​client.presets.create(body, options?)

​client.presets.update(presetId, body, options?)

​client.presets.delete(presetId, options?)

​client.presets.setDefault(presetId, options?)

​Gültige Felder ermitteln

​Ein Preset anwenden

​Was als Nächstes

`client.presets.list(options?)`

`client.presets.get(presetId, options?)`

`client.presets.create(body, options?)`

`client.presets.update(presetId, body, options?)`

`client.presets.delete(presetId, options?)`

`client.presets.setDefault(presetId, options?)`

Gültige Felder ermitteln

Ein Preset anwenden

Was als Nächstes