Projects

I progetti sono la risorsa di livello più alto in Youka. Ogni progetto possiede il suo file sorgente, i testi, le esportazioni e le impostazioni del progetto. I progetti karaoke contengono anche le tracce separate (stems).

Creazione di un progetto

Nella maggior parte dei casi, usa client.projects.create() — gestisce i caricamenti per te.

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

Tipi di sorgente

path
bytes
url

Legge un file dal disco.

source: {
  type: "path",
  path: "./song.mp3",
  contentType: "audio/mpeg", // optional, inferred if omitted
}

Blob, File, ArrayBuffer o Uint8Array in memoria.

source: {
  type: "bytes",
  data: fileBuffer,
  filename: "song.mp3",
  contentType: "audio/mpeg", // optional
}

URL HTTP o HTTPS remoto.Le pagine ospitate supportate dipendono da yt-dlp. Vedi l’elenco degli URL supportati.

source: {
  type: "url",
  url: "https://example.com/song.mp4",
  maxVideoQuality: "1080p", // optional: "720p", "1080p", "4k", or "best"
}

maxVideoQuality controlla la qualità video massima scaricata per le sorgenti URL. Il valore predefinito è 1080p. L’SDK usa la migliore qualità disponibile fino a quel limite e, se la piattaforma non espone uno stream con limite, ripiega sul miglior formato disponibile. Usa best per non imporre limiti.

Su Node.js e Bun, l’SDK assicura automaticamente i binari di dipendenza richiesti per gli URL (ffmpeg, ffprobe, yt-dlp) al primo utilizzo. L’equivalente nella CLI è youka deps ensure --for url.

Altri campi

string

Titolo del progetto. Per impostazione predefinita è il nome del file sorgente.

karaoke | lyric-video

Workflow. Il valore predefinito è karaoke. lyric-video usa l’audio originale senza separazione degli stem.

SplitModel

Modello di separazione degli stem per il karaoke. Il valore predefinito è mdx23c. Rifiutato per lyric-video. Vedi il riferimento del modello di split reference.

string

Applica un preset riutilizzabile al momento della creazione.

LyricsSource

Configura la sincronizzazione dei testi. Vedi sotto.

Sorgenti dei testi

// 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() accetta anche una sorgente inputFile di basso livello quando hai già un inputFileId caricato.

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?)`

Stima i crediti necessari per creare un progetto senza crearlo.

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(...) accetta le stesse forme di source di client.projects.create(...), inclusa maxVideoQuality per gli URL. Se conosci già la durata del file multimediale e non vuoi caricare il file solo per ottenere una stima, passa la forma REST di basso livello:

const quote = await client.projects.quote({
  durationSeconds: 210,
  lyricsSource: null,
  splitModel: "mdx23c",
});

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

Alloca uno slot di caricamento e ottieni un URL firmato.

const upload = await client.uploads.create({
  filename: "song.mp3",
  contentType: "audio/mpeg",
  contentLength: 4_521_344,
});
// => { inputFileId, uploadUrl }

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

Esegui una PUT dei byte del file sull’URL firmato.

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

FetchBody

required

Qualsiasi body compatibile con fetch: Blob, File, ArrayBuffer, Uint8Array, ReadableStream o string.

Genera YoukaRequestError con codice UPLOAD_FAILED se il caricamento restituisce uno status non 2xx.

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

Recupera lo stato completo del progetto, inclusi stem, testi ed esportazioni.

const project = await client.projects.get("prj_abc123");
console.log(project.title, project.stems, project.lyrics);

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

Applica una patch ai metadati del progetto.

const project = await client.projects.update("prj_abc123", {
  title: "Updated title",
  artists: ["Artist name"],
});

Passa almeno uno tra title o artists.

`client.projects.list(options?)`

Elenca tutti i progetti posseduti dall’account autenticato.

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

Restituisce un array di elementi di elenco dei progetti (una forma più snella rispetto a getProject).

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

Elimina un progetto e tutti gli stem, i testi e le esportazioni associati.

await client.projects.delete("prj_abc123", {
  idempotencyKey: "delete-prj_abc123",
});

L’eliminazione è permanente. Abbinala a una chiave di idempotenza così i tentativi di ripetizione sono sicuri.

Cosa c’è dopo

Stems — riesegui la separazione degli stem
Lyrics sync — risincronizza i testi
Exports — effettua il rendering dei video finali
Tasks — attendi le operazioni del progetto con client.projects.wait

Creazione di lyric-video e rilevamento dei modelli

const capabilities = await client.capabilities.get();
const operation = await client.projects.create({
  kind: "lyric-video",
  source: { type: "path", path: "./song.wav" },
  lyricsSource: {
    type: "transcribe",
    syncModel: "elevenlabs-transcription",
    lyrics: "Optional reference lyrics",
  },
});
const { project } = await client.projects.wait(operation);
const versions = await client.projects.versions.list(project.id);

Le stesse scelte per kind e per l’elaborazione dei testi funzionano anche con projects.quote. Le stime per i lyric-video addebitano zero crediti di separazione. Stima e creazione convalidano gli stessi requisiti di modello, lingua, account e sorgente. Le stime non riservano crediti né capacità. Usa lyricsSource: null per saltare l’elaborazione dei testi. Il testo di riferimento nella trascrizione è un’indicazione e può differire dal risultato. I modelli che richiedono voci isolate non possono elaborare un lyric video senza separazione. Vedi Automate lyric videos per funzionalità, aggiornamenti del timing esatto e checkpoint del catalogo.

Overview

How To

Customization

Audio

Settings

Exporting

Account

Creazione di un progetto

Tipi di sorgente

Altri campi

Sorgenti dei testi

`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?)`

Cosa c’è dopo

Creazione di lyric-video e rilevamento dei modelli

​Creazione di un progetto

​Tipi di sorgente

​Altri campi

​Sorgenti dei testi

​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?)

​Cosa c’è dopo

​Creazione di lyric-video e rilevamento dei modelli

Creazione di un progetto

Tipi di sorgente

Altri campi

Sorgenti dei testi

`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?)`

Cosa c’è dopo

Creazione di lyric-video e rilevamento dei modelli