Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.youka.io/llms.txt

Use this file to discover all available pages before exploring further.

المشروع هو مورد العمل قيد التنفيذ لمسار كاريوكي واحد. وهو يملك الوسائط المصدرية، والكلمات المتزامنة، والمسارات المنفصلة (stems)، وإعدادات التصيير، وعمليات التصدير التي يتم إنشاؤها منه.

​
project create

أنشئ مشروعًا جديدًا من ملف محلي أو URL. 
youka project create <source> [options]
​
source
string
required
مسار ملف محلي (./song.mp3) أو عنوان URL عبر HTTP/HTTPS (https://example.com/song.mp4).

​
Options

OptionDescription
--title <title>عنوان المشروع
--mode <mode>none أو transcribe أو align
--lyrics <text>نص الكلمات
--lang <code>رمز اللغة
--sync-model <model>نموذج مزامنة الكلمات
--split-model <model>نموذج فصل المسارات (stems)
--max-video-quality <quality>أقصى جودة فيديو لمصادر URL: 720p أو 1080p أو 4k أو best
--preset <presetId>تطبيق إعداد مسبق أثناء إنشاء المشروع
--exportإنشاء تصدير بعد أن يصبح المشروع جاهزًا
--downloadإنشاء تصدير، والانتظار حتى يكتمل، ثم تنزيله
--output <path>مسار الإخراج لـ --download

​
Examples

youka project create ./song.mp3 \
  --title "My Song" \
  --mode transcribe \
  --lang en \
  --wait \
  --json
القواعد:
  • إذا مرّرت كلمات الأغنية وحذفت --mode، فسيكون الإعداد الافتراضي في CLI هو align
  • align يتطلب كلمات
  • transcribe و none لا يقبلان كلمات
  • --download يتضمن ضمنًا --export
  • --max-video-quality ينطبق فقط على مصادر URL عبر HTTP/HTTPS. القيمة الافتراضية هي 1080p، ويستخدم أفضل جودة متاحة حتى هذا الحد، ويعود إلى أفضل تنسيق متاح عندما لا تتيح المنصة بثًا محدودًا بسقف جودة.

​
project list

اعرض جميع المشاريع للحساب الموثَّق. 
youka project list
youka project list --json

​
project quote

احصل على تقدير الاعتمادات المطلوبة لإنشاء مشروع دون إنشاء المشروع. 
youka project quote <source> [options]
يقبل source نفس صيغ مسار الملف المحلي أو URL عبر HTTP/HTTPS كما في project create. بدون --duration، يقوم CLI برفع المصدر لكي يتمكن الخادم من قياس الوسائط بدقة، لكنه لا ينشئ مشروعًا.

​
Options

OptionDescription
--title <title>عنوان المشروع
--mode <mode>none أو transcribe أو align
--lyrics <text>نص الكلمات لـ align
--lang <code>رمز اللغة
--sync-model <model>نموذج مزامنة الكلمات
--split-model <model>نموذج فصل المسارات (stems)
--max-video-quality <quality>أقصى جودة فيديو لمصادر URL: 720p أو 1080p أو 4k أو best
--duration <seconds>التقدير انطلاقًا من مدة معروفة دون رفع المصدر
Examples: 
youka project quote ./song.mp3 --mode transcribe --json
youka project quote https://example.com/song.mp4 --max-video-quality 4k --mode transcribe --json
youka project quote ./song.mp3 --duration 210 --mode none --json

​
project show

احصل على حالة المشروع الحالية، بما في ذلك state وpendingOperation المعياريَّين، وstems، والإعدادات، وعمليات التصدير. 
youka project show <projectId>
​
projectId
string
required
معرّف المشروع الذي يعيده project create.

​
project wait

استطلع حالة مشروع إلى أن يصل إلى حالة نهائية. 
youka project wait <projectId> --json

​
project delete

احذف مشروعًا وجميع stems والكلمات وعمليات التصدير المرتبطة به. 
youka project delete <projectId> --idempotency-key delete-<projectId>
الحذف نهائي. مرّر --idempotency-key لجعل إعادة المحاولات آمنة.

​
project sync

أعد تشغيل تفريغ الكلمات أو محاذاتها على مشروع موجود. 
youka project sync <projectId> [options]
OptionDescription
--mode <mode>transcribe أو align
--text <text>نص الكلمات
--lang <code>رمز اللغة
--sync-model <model>نموذج مزامنة الكلمات
Example: 
youka project sync $PROJECT_ID \
  --mode align \
  --text "$(cat lyrics.txt)" \
  --wait \
  --json

​
project separate

أعد تشغيل فصل المسارات (stems) على مشروع موجود. 
youka project separate <projectId> [--split-model <model>]
Example: 
youka project separate $PROJECT_ID --split-model audioshakeai --wait --json

​
project settings

اقرأ إعدادات المشروع النشطة أو حدّثها. 
youka project settings <projectId>
youka project settings <projectId> --preset <presetId> --body ./settings.json
إذا لم يوجد لا --preset ولا --body، يعيد الأمر الإعدادات الحالية. وإذا كان أحدهما موجودًا، فإنه ينفّذ تحديثًا. Examples: 
youka project settings $PROJECT_ID --json

​
project stem list

اعرض قائمة stems لمشروع. 
youka project stem list <projectId>
youka project stem list <projectId> --json

​
project stem download

نزّل ملف stem واحدًا أو أكثر إلى القرص. يتم تنزيل stems بصيغتها الأصلية المخزّنة؛ لا يقوم CLI بتحويل ترميزها. 
youka project stem download <projectId> <stemId> --output ./stems
youka project stem download <projectId> --type instrumental --output ./stems
youka project stem download <projectId> --type original --type backing-vocals --type vocals --output ./stems
youka project stem download <projectId> --all --output ./stems
القيم المدعومة لـ --type هي original وinstrumental وvocals و backing_vocals. كما يقبل CLI أيضًا backing-vocals وbackingVocals و backingvocals كأسماء بديلة.

​
ما التالي

  • Exports - تصيير الكاريوكي النهائي
  • Presets - إدارة إعدادات التصيير القابلة لإعادة الاستخدام
  • Render settings reference - حقول الإعدادات والإعدادات المسبقة المشتركة