المشاريع هي المورد الأعلى مستوى في Youka. يمتلك كل مشروع ملفه المصدر، والمسارات المفصولة (stems)، وكلمات الأغاني المتزامنة، وعمليات التصدير، وإعدادات المشروع.
إنشاء مشروع
في معظم الحالات، استخدم client.projects.create() — فهو يتولى رفع الملفات نيابةً عنك.
const operation = await client.projects.create({
source: { type: "path", path: "./song.mp3" },
lyricsSource: { type: "transcribe" },
});
// => ProjectOperation
أنواع المصدر
يقرأ ملفًا من القرص.source: {
type: "path",
path: "./song.mp3",
contentType: "audio/mpeg", // optional, inferred if omitted
}
Blob أو File أو ArrayBuffer أو Uint8Array في الذاكرة.source: {
type: "bytes",
data: fileBuffer,
filename: "song.mp3",
contentType: "audio/mpeg", // optional
}
عنوان URL بعيد عبر HTTP أو HTTPS.تعتمد الصفحات المستضافة المدعومة على yt-dlp. راجع قائمة عناوين URL المدعومة.source: {
type: "url",
url: "https://example.com/song.mp4",
maxVideoQuality: "1080p", // optional: "720p", "1080p", "4k", or "best"
}
maxVideoQuality في الحد الأقصى لجودة الفيديو التي يتم تنزيلها لمصادر
URL. القيمة الافتراضية هي 1080p. يستخدم الـ SDK أفضل جودة متاحة حتى
ذلك الحد، ويعود إلى أفضل تنسيق متاح إذا لم توفر المنصة بثًا
محدودًا. استخدم best بدون حد.على Node.js و Bun، يضمن الـ SDK تلقائيًا توفر ملفات الاعتماد الثنائية المطلوبة لمصادر URL
(ffmpeg, ffprobe, yt-dlp) عند أول استخدام. المعادل في
CLI هو youka deps ensure --for url.
حقول أخرى
عنوان المشروع. القيمة الافتراضية هي اسم ملف المصدر.
تطبيق إعداد مسبق قابل لإعادة الاستخدام وقت الإنشاء.
إعداد مزامنة الكلمات. انظر أدناه.
مصادر الكلمات
// 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() أيضًا مصدرًا منخفض المستوى من نوع inputFile عندما يكون لديك بالفعل inputFileId لملف تم رفعه مسبقًا.
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(...) نفس أشكال source التي يقبلها
client.projects.create(...)، بما في ذلك maxVideoQuality لمصادر URL. إذا كنت
تعرف مدة الوسائط مسبقًا ولا تريد رفع الملف فقط لغرض التسعير، مرّر
الشكل منخفض المستوى الخاص بـ REST:
const quote = await client.projects.quote({
durationSeconds: 210,
lyricsSource: null,
splitModel: "mdx23c",
});
client.uploads.create(body, options?)
خصّص خانة رفع واحصل على عنوان 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?)
نفّذ PUT لبايتات الملف إلى عنوان URL الموقّع.
await client.uploads.upload(upload.uploadUrl, fileBuffer, {
contentType: "audio/mpeg",
signal: abortController.signal,
});
أي جسم متوافق مع fetch: Blob, File, ArrayBuffer, Uint8Array,
ReadableStream, أو string.
YoukaRequestError بالرمز UPLOAD_FAILED إذا أعادت عملية الرفع حالة ليست 2xx.
client.projects.get(projectId, options?)
اجلب حالة المشروع كاملة، بما في ذلك المسارات (stems) والكلمات وعمليات التصدير.
const project = await client.projects.get("prj_abc123");
console.log(project.title, project.stems, project.lyrics);
client.projects.update(projectId, body, options?)
طبّق Patch على بيانات تعريف المشروع.
const project = await client.projects.update("prj_abc123", {
title: "Updated title",
artists: ["Artist name"],
});
title أو artists.
client.projects.list(options?)
اعرض كل مشروع مملوك للحساب الذي تمّت مصادقته.
const projects = await client.projects.list();
projects.forEach((p) => console.log(p.id, p.title));
getProject).
client.projects.delete(projectId, options?)
احذف مشروعًا وكل ما يرتبط به من مسارات (stems) وكلمات وعمليات تصدير.
await client.projects.delete("prj_abc123", {
idempotencyKey: "delete-prj_abc123",
});
الحذف نهائي. اربطه بمفتاح idempotency لكي تكون إعادة المحاولة آمنة.
ما التالي
