Projects

Ein Projekt ist die Work-in-Progress-Ressource für einen Karaoke-Track. Es enthält die Quellmedien, synchronisierte Lyrics, getrennte Stems, Render-Einstellungen und die daraus erstellten Exporte.

`project create`

Erstelle ein neues Projekt aus einer lokalen Datei oder einer URL.

youka project create <source> [options]

string

required

Ein lokaler Dateipfad (./song.mp3) oder eine HTTP/HTTPS-URL (https://example.com/song.mp4).

Options

Option	Description
`--title <title>`	Projekttitel
`--mode <mode>`	`none`, `transcribe` oder `align`
`--lyrics <text>`	Lyrics-Text
`--lang <code>`	Sprachcode
`--sync-model <model>`	Lyrics-Sync-Modell
`--split-model <model>`	Stem-Separationsmodell
`--max-video-quality <quality>`	Maximale Videoqualität für URL-Quellen: `720p`, `1080p`, `4k` oder `best`
`--preset <presetId>`	Beim Erstellen des Projekts ein Preset anwenden
`--export`	Einen Export erstellen, nachdem das Projekt bereit ist
`--download`	Einen Export erstellen, darauf warten und ihn herunterladen
`--output <path>`	Ausgabepfad für `--download`

Examples

youka project create ./song.mp3 \
  --title "My Song" \
  --mode transcribe \
  --lang en \
  --wait \
  --json

youka project create "https://example.com/song.mp4" \
  --max-video-quality 4k \
  --download \
  --output ./karaoke.mp4 \
  --json

youka project create ./song.mp3 \
  --mode align \
  --lyrics "$(cat lyrics.txt)" \
  --sync-model audioshake-alignment \
  --wait \
  --json

Regeln:

Wenn du Lyrics übergibst und --mode weglässt, verwendet die CLI standardmäßig align
align erfordert Lyrics
transcribe und none akzeptieren keine Lyrics
--download impliziert --export
--max-video-quality gilt nur für HTTP/HTTPS-URL-Quellen. Standard ist 1080p; es wird die beste verfügbare Qualität bis zu diesem Limit verwendet und auf das beste verfügbare Format zurückgefallen, wenn die Plattform keinen begrenzten Stream anbietet.

`project list`

Alle Projekte für das authentifizierte Konto auflisten.

youka project list
youka project list --json

`project quote`

Die Credits angeben, die zum Erstellen eines Projekts erforderlich sind, ohne das Projekt zu erstellen.

youka project quote <source> [options]

source akzeptiert dieselben lokalen Dateipfade oder HTTP/HTTPS-URL-Formen wie project create. Ohne --duration lädt die CLI die Quelle hoch, damit der Server die Medien exakt messen kann, erstellt jedoch kein Projekt.

Options

Option	Description
`--title <title>`	Projekttitel
`--mode <mode>`	`none`, `transcribe` oder `align`
`--lyrics <text>`	Lyrics-Text für `align`
`--lang <code>`	Sprachcode
`--sync-model <model>`	Lyrics-Sync-Modell
`--split-model <model>`	Stem-Separationsmodell
`--max-video-quality <quality>`	Maximale Videoqualität für URL-Quellen: `720p`, `1080p`, `4k` oder `best`
`--duration <seconds>`	Auf Basis einer bekannten Dauer quoten, ohne die Quelle hochzuladen

Beispiele:

youka project quote ./song.mp3 --mode transcribe --json
youka project quote https://example.com/song.mp4 --max-video-quality 4k --mode transcribe --json
youka project quote ./song.mp3 --duration 210 --mode none --json

`project show`

Den aktuellen Projektstatus abrufen, einschließlich normalisiertem state, pendingOperation, Stems, Einstellungen und Exporten.

youka project show <projectId>

string

required

Die von project create zurückgegebene Projekt-ID.

`project wait`

Ein Projekt abfragen, bis es einen Endzustand erreicht.

youka project wait <projectId> --json

`project delete`

Ein Projekt und alle zugehörigen Stems, Lyrics und Exporte löschen.

youka project delete <projectId> --idempotency-key delete-<projectId>

Das Löschen ist endgültig. Übergib --idempotency-key, um Wiederholungen sicher zu machen.

`project sync`

Lyrics-Transkription oder Alignment für ein bestehendes Projekt erneut ausführen.

youka project sync <projectId> [options]

Option	Description
`--mode <mode>`	`transcribe` oder `align`
`--text <text>`	Lyrics-Text
`--lang <code>`	Sprachcode
`--sync-model <model>`	Lyrics-Sync-Modell

Beispiel:

youka project sync $PROJECT_ID \
  --mode align \
  --text "$(cat lyrics.txt)" \
  --wait \
  --json

`project separate`

Stem-Separation für ein bestehendes Projekt erneut ausführen.

youka project separate <projectId> [--split-model <model>]

Beispiel:

youka project separate $PROJECT_ID --split-model audioshakeai --wait --json

`project settings`

Die aktiven Projekt-Einstellungen lesen oder aktualisieren.

youka project settings <projectId>
youka project settings <projectId> --preset <presetId> --body ./settings.json

Wenn weder --preset noch --body vorhanden ist, gibt der Befehl die aktuellen Einstellungen zurück. Wenn eines von beiden vorhanden ist, führt er ein Update aus. Beispiele:

youka project settings $PROJECT_ID --json

youka project settings $PROJECT_ID \
  --preset preset_abc123 \
  --body ./project-settings.json \
  --json

`project stem list`

Stems für ein Projekt auflisten.

youka project stem list <projectId>
youka project stem list <projectId> --json

`project stem download`

Eine oder mehrere Stem-Dateien auf die Festplatte herunterladen. Stems werden in ihrem original gespeicherten Format heruntergeladen; die CLI transkodiert sie nicht.

youka project stem download <projectId> <stemId> --output ./stems
youka project stem download <projectId> --type instrumental --output ./stems
youka project stem download <projectId> --type original --type backing-vocals --type vocals --output ./stems
youka project stem download <projectId> --all --output ./stems

Unterstützte --type-Werte sind original, instrumental, vocals und backing_vocals. Die CLI akzeptiert außerdem backing-vocals, backingVocals und backingvocals als Aliase.

What’s next

Exports - das fertige Karaoke rendern
Presets - wiederverwendbare Render-Konfigurationen verwalten
Render settings reference - gemeinsame Preset- und Einstellungsfelder

Overview

How To

Customization

Audio

Settings

Exporting

Account

`project create`

Options

Examples

`project list`

`project quote`

Options

`project show`

`project wait`

`project delete`

`project sync`

`project separate`

`project settings`

`project stem list`

`project stem download`

What’s next

​project create

​Options

​Examples

​project list

​project quote

​Options

​project show

​project wait

​project delete

​project sync

​project separate

​project settings

​project stem list

​project stem download

​What’s next

`project create`

Options

Examples

`project list`

`project quote`

Options

`project show`

`project wait`

`project delete`

`project sync`

`project separate`

`project settings`

`project stem list`

`project stem download`

What’s next