Projekte sind die übergeordnete Ressource in Youka. Jedes Projekt besitzt seine Quelldatei, getrennte Stems, synchronisierte Lyrics, Exporte und Projekteinstellungen.
Ein Projekt erstellen
In den meisten Fällen verwendest du client.projects.create() — das übernimmt die Uploads für dich.
const operation = await client.projects.create({
source: { type: "path", path: "./song.mp3" },
lyricsSource: { type: "transcribe" },
});
// => ProjectOperation
Source-Typen
Liest eine Datei von der Festplatte.source: {
type: "path",
path: "./song.mp3",
contentType: "audio/mpeg", // optional, inferred if omitted
}
In-Memory-Blob, File, ArrayBuffer oder Uint8Array.source: {
type: "bytes",
data: fileBuffer,
filename: "song.mp3",
contentType: "audio/mpeg", // optional
}
Remote-HTTP- oder -HTTPS-URL.Welche gehosteten Seiten unterstützt werden, hängt von yt-dlp ab. Siehe die Liste unterstützter URLs.source: {
type: "url",
url: "https://example.com/song.mp4",
maxVideoQuality: "1080p", // optional: "720p", "1080p", "4k", or "best"
}
maxVideoQuality steuert die maximal heruntergeladene Videoqualität für URL-Quellen. Standard ist 1080p. Das SDK verwendet die beste verfügbare Qualität bis zu diesem Limit und fällt auf das beste verfügbare Format zurück, wenn die Plattform keinen begrenzten Stream anbietet. Verwende best, um kein Limit zu setzen.Unter Node.js und Bun stellt das SDK beim ersten Gebrauch automatisch die benötigten URL-Abhängigkeits-Binaries (ffmpeg, ffprobe, yt-dlp) sicher. Das CLI-Äquivalent ist youka deps ensure --for url.
Weitere Felder
Projekttitel. Standardmäßig der Dateiname der Quelle.
Wende beim Erstellen ein wiederverwendbares Preset an.
Konfiguriere die Lyrics-Synchronisierung. Siehe unten.
Lyrics-Quellen
// Transcribe lyrics from the audio
lyricsSource: {
type: "transcribe",
syncModel: "audioshake-transcription", // optional
language: "en", // optional
}
// Align exact lyrics to the audio
lyricsSource: {
type: "align",
lyrics: "First line\nSecond line\n...",
syncModel: "audioshake-alignment",
}
client.projects.create() akzeptiert außerdem eine Low-Level-inputFile-Quelle, wenn du bereits eine hochgeladene inputFileId hast.
const upload = await client.uploads.create({
filename: "song.mp3",
contentType: "audio/mpeg",
contentLength: buffer.byteLength,
});
await client.uploads.upload(upload.uploadUrl, buffer, {
contentType: "audio/mpeg",
});
const operation = await client.projects.create({
source: {
type: "inputFile",
inputFileId: upload.inputFileId,
filename: "song.mp3",
},
title: "My Song",
});
const quote = await client.projects.quote({
source: { type: "path", path: "./song.mp3" },
lyricsSource: { type: "transcribe", language: "en" },
splitModel: "mdx23c",
});
console.log(quote.creditsRequired, quote.sufficientBalance);
client.projects.quote(...) akzeptiert dieselben source-Formen wie client.projects.create(...), einschließlich URL-maxVideoQuality. Wenn du die Mediendauer bereits kennst und die Datei nicht nur für ein Angebot hochladen willst, übergib die Low-Level-REST-Form:
const quote = await client.projects.quote({
durationSeconds: 210,
lyricsSource: null,
splitModel: "mdx23c",
});
client.uploads.create(body, options?)
Reserviere einen Upload-Slot und erhalte eine signierte URL.
const upload = await client.uploads.create({
filename: "song.mp3",
contentType: "audio/mpeg",
contentLength: 4_521_344,
});
// => { inputFileId, uploadUrl }
client.uploads.upload(uploadUrl, body, options?)
Übertrage die Dateibytes per PUT an die signierte URL.
await client.uploads.upload(upload.uploadUrl, fileBuffer, {
contentType: "audio/mpeg",
signal: abortController.signal,
});
Jeder fetch-kompatible Body: Blob, File, ArrayBuffer, Uint8Array,
ReadableStream oder string.
YoukaRequestError mit dem Code UPLOAD_FAILED, wenn der Upload einen Nicht-2xx-Status zurückgibt.
client.projects.get(projectId, options?)
Rufe den vollständigen Projektstatus ab, einschließlich Stems, Lyrics und Exporten.
const project = await client.projects.get("prj_abc123");
console.log(project.title, project.stems, project.lyrics);
client.projects.update(projectId, body, options?)
Patche Projekt-Metadaten.
const project = await client.projects.update("prj_abc123", {
title: "Updated title",
artists: ["Artist name"],
});
title oder artists.
client.projects.list(options?)
Liste jedes Projekt auf, das dem authentifizierten Konto gehört.
const projects = await client.projects.list();
projects.forEach((p) => console.log(p.id, p.title));
getProject).
client.projects.delete(projectId, options?)
Lösche ein Projekt und alle zugehörigen Stems, Lyrics und Exporte.
await client.projects.delete("prj_abc123", {
idempotencyKey: "delete-prj_abc123",
});
Das Löschen ist endgültig. Kombiniere es mit einem Idempotency-Key, damit Wiederholungen sicher sind.
Was als Nächstes
- Stems — Stem-Trennung erneut ausführen
- Lyrics sync — Lyrics erneut synchronisieren
- Exports — fertige Videos rendern
- Tasks — auf Projektoperationen warten mit
client.projects.wait
