Projekte

Projekte sind die übergeordnete Ressource in Youka. Jedes Projekt besitzt seine Quelldatei, getrennte Stems, synchronisierte Lyrics, Exporte und Projekteinstellungen.

Ein Projekt erstellen

Für die meisten Anwendungsfälle verwende client.projects.create() — das übernimmt Uploads für dich.

const operation = await client.projects.create({
  source: { type: "path", path: "./song.mp3" },
  lyricsSource: { type: "transcribe" },
});
// => ProjectOperation

Source-Typen

path
bytes
url

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. Standardmäßig ist es 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 für keine Begrenzung.

Unter Node.js und Bun stellt das SDK bei der ersten Verwendung automatisch die erforderlichen URL-Abhängigkeits-Binaries (ffmpeg, ffprobe, yt-dlp) sicher. Das CLI-Äquivalent ist youka deps ensure --for url.

Weitere Felder

string

Projekttitel. Standardmäßig der Dateiname der Quelle.

SplitModel

Modell zur Stem-Separation. Standardmäßig mdx23c. Siehe Split-Model-Referenz.

string

Wende beim Erstellen ein wiederverwendbares Preset an.

LyricsSource

Konfiguriere die Lyrics-Synchronisation. 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(input, options?)`

client.projects.create() akzeptiert auch 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",
});

`client.projects.quote(input, options?)`

Schätze die Credits, die zum Erstellen eines Projekts benötigt werden, ohne es zu erstellen.

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 Quote hochladen möchtest, ü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?)`

Führe ein PUT der Datei-Bytes auf die signierte URL aus.

await client.uploads.upload(upload.uploadUrl, fileBuffer, {
  contentType: "audio/mpeg",
  signal: abortController.signal,
});

FetchBody

required

Beliebiger fetch-kompatibler Body: Blob, File, ArrayBuffer, Uint8Array, ReadableStream oder string.

Wirft YoukaRequestError mit 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"],
});

Übergebe mindestens eines von title oder artists.

`client.projects.list(options?)`

Liste jedes Projekt auf, das dem authentifizierten Account gehört.

const projects = await client.projects.list();
projects.forEach((p) => console.log(p.id, p.title));

Gibt ein Array von Projekt-Listeneinträgen zurück (eine schlankere Form als 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 dauerhaft. Kombiniere es mit einem Idempotency-Key, damit Retries sicher sind.

Was als Nächstes

Stems — Stem-Separation erneut ausführen
Lyrics sync — Lyrics erneut synchronisieren
Exports — fertige Videos rendern
Tasks — auf Projekt-Operationen warten mit client.projects.wait

Overview

How To

Customization

Audio

Settings

Exporting

Account

Ein Projekt erstellen

Source-Typen

Weitere Felder

Lyrics-Quellen

`client.projects.create(input, options?)`

`client.projects.quote(input, options?)`

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

`client.uploads.upload(uploadUrl, body, options?)`

`client.projects.get(projectId, options?)`

`client.projects.update(projectId, body, options?)`

`client.projects.list(options?)`

`client.projects.delete(projectId, options?)`

Was als Nächstes

​Ein Projekt erstellen

​Source-Typen

​Weitere Felder

​Lyrics-Quellen

​client.projects.create(input, options?)

​client.projects.quote(input, options?)

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

​client.uploads.upload(uploadUrl, body, options?)

​client.projects.get(projectId, options?)

​client.projects.update(projectId, body, options?)

​client.projects.list(options?)

​client.projects.delete(projectId, options?)

​Was als Nächstes

Ein Projekt erstellen

Source-Typen

Weitere Felder

Lyrics-Quellen

`client.projects.create(input, options?)`

`client.projects.quote(input, options?)`

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

`client.uploads.upload(uploadUrl, body, options?)`

`client.projects.get(projectId, options?)`

`client.projects.update(projectId, body, options?)`

`client.projects.list(options?)`

`client.projects.delete(projectId, options?)`

Was als Nächstes