المشاريع

المشاريع هي المورد الأعلى مستوى في Youka. يملك كل مشروع ملفه المصدر، والكلمات، وعمليات التصدير، وإعدادات المشروع. تحتوي مشاريع الكاراوكي أيضًا على مسارات مفصولة (stems).

إنشاء مشروع

في معظم الحالات، استخدم client.projects.create() — فهو يتولى الرفع نيابةً عنك.

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

أنواع المصدر

path
bytes
url

يقرأ ملفًا من القرص.

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.

حقول أخرى

string

عنوان المشروع. الافتراضي هو اسم ملف المصدر.

karaoke | lyric-video

سير العمل. الافتراضي هو karaoke. يستخدم lyric-video الصوت الأصلي دون فصل المسارات.

SplitModel

نموذج فصل المسارات للكاريوكي. الافتراضي هو mdx23c. مرفوض مع lyric-video. راجع مرجع نموذج الفصل reference.

string

تطبيق إعداد مسبق قابل لإعادة الاستخدام عند الإنشاء.

LyricsSource

تهيئة مزامنة كلمات الأغاني. انظر أدناه.

مصادر كلمات الأغاني

// 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() أيضًا مصدر 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",
});

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

قدّر الاعتمادات المطلوبة لإنشاء مشروع دون إنشائه.

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,
});

FetchBody

required

أي جسم متوافق مع 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?)`

حدّث بيانات تعريف المشروع.

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 لتكون إعادة المحاولة آمنة.

ما التالي

Stems — أعد تشغيل فصل المسارات
Lyrics sync — أعد مزامنة كلمات الأغاني
Exports — اعرض الفيديوهات النهائية
Tasks — انتظر عمليات المشروع باستخدام client.projects.wait

إنشاء فيديو كلمات واكتشاف النماذج

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);

تعمل نفس خيارات kind ومعالجة الكلمات مع projects.quote. تسعيرات فيديو الكلمات تحتسب صفرًا من اعتمادات الفصل. يتحقق كل من التسعير والإنشاء من نفس متطلبات النموذج واللغة والحساب والمصدر. لا تحجز التسعيرات اعتمادات أو سعة. استخدم lyricsSource: null لتخطي معالجة كلمات الأغاني. النص المرجعي في التفريغ هو توجيه وقد يختلف عن النتيجة. النماذج التي تحتاج إلى صوت غنائي معزول لا يمكنها معالجة فيديو كلمات بدون فصل. راجع Automate lyric videos لمعرفة الإمكانات وتحديثات التوقيت الدقيقة ونقاط التحقق في الكتالوج.

Overview

How To

Customization

Audio

Settings

Exporting

Account

إنشاء مشروع

أنواع المصدر

حقول أخرى

مصادر كلمات الأغاني

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

ما التالي

إنشاء فيديو كلمات واكتشاف النماذج

​إنشاء مشروع

​أنواع المصدر

​حقول أخرى

​مصادر كلمات الأغاني

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

​ما التالي

​إنشاء فيديو كلمات واكتشاف النماذج

إنشاء مشروع

أنواع المصدر

حقول أخرى

مصادر كلمات الأغاني

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

ما التالي

إنشاء فيديو كلمات واكتشاف النماذج