رینڈر درخواست

curl-example.sh
curl -X POST https://render-api.chillin.online/render/v1 \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer YOUR_API_KEY" \
-d @request.json

نوٹ: ہماری رینڈرنگ درخواستیں غیر ہم وقتی (async) پروسیس کی جاتی ہیں۔ درخواست جمع کروانے کے بعد، آپ کو فوری طور پر ایک جواب موصول ہوگا جس میں ایک render_id شامل ہوگا، جسے رینڈرنگ کی حیثیت اور نتائج کی جانچ کے لیے استعمال کیا جا سکتا ہے۔

پراپقسمضروریمثالقدر کی حدتفصیل
compositeWidthnumbertrue1920720 - 3840ترکیب کی چوڑائی۔
compositeHeightnumbertrue1080720 - 3840ترکیب کی اونچائی۔
fpsnumbertrue3015 - 60ترکیب کی فریم کی شرح۔
projectDataobjecttrue--پروجیکٹ کا ڈیٹا۔ ایڈیٹر سے برآمد کیا جا سکتا ہے۔
cameraobjectfalse--3D مناظر کے لیے اختیاری کیمرہ کی تشکیل۔ پروجیکشن موڈ اور دیکھنے کے زاویے کو کنٹرول کرتا ہے۔

نوٹ: compositeWidth اور compositeHeight projectData میں بیان کردہ width اور height سے مختلف ہو سکتے ہیں۔ تاہم، compositeWidth اور compositeHeight کا تناسب projectData.width اور projectData.height کے تناسب کے ساتھ مستقل رہنا چاہیے۔

یہ ڈیزائن ایک ہی ویڈیو پروجیکٹ کو مختلف ریزولوشنز میں برآمد کرنے کی اجازت دیتا ہے جبکہ اصل تناسب برقرار رہتا ہے۔

کیمرہ کی تشکیل

اختیاری camera آبجیکٹ 3D عناصر کی پروجیکشن کو کنٹرول کرتا ہے:

  • mode (string) - پروجیکشن موڈ: "perspective" (ڈیفالٹ) یا "orthographic"۔ پرسپیکٹو گہرائی کی بنیاد پر چھوٹ فراہم کرتا ہے؛ آرتھوگرافک متوازی لائنوں کو برقرار رکھتا ہے۔
  • view (string) - ایک پری سیٹ کیمرہ ویو کا نام (جیسے، "front", "top", "right", "isometric"). جب مخصوص کیا جائے تو کیمرہ پری سیٹ زاویے کے مطابق رکھا جاتا ہے۔

اگر کوئی camera فراہم نہیں کی گئی تو ڈیفالٹ پرسپیکٹو فرنٹ ویو استعمال کیا جاتا ہے۔

request.json
{
"compositeWidth": 1920,
"compositeHeight": 1080,
"fps": 30,
"projectData": {
  "type": "",
  "width": 1920,
  "height": 1080,
  "fill": "#000000",
  "view": [
    {
      "id": "8ecf7475-2c6c-47f9-827b-a09c7913f4c0",
      "type": "Image",
      "start": 0,
      "duration": 5,
      "trackIndex": 0,
      "x": -570.0335392757963,
      "y": -170.90659033307685,
      "blendMode": "normal",
      "anchorX": 1302,
      "anchorY": 2312,
      "rotation": 0,
      "scaleX": 0.23356401384083045,
      "scaleY": 0.23356401384083045,
      "alpha": 1,
      "skewX": 0,
      "skewY": 0,
      "keyframes": [],
      "externalUrl": "https://images.pexels.com/photos/30465303/pexels-photo-30465303.jpeg",
      "ext": "jpeg"
    }
  ],
  "audio": [],
  "effect": [],
  "transition": [],
  "version": 0,
  "duration": 5
}
};

کامیاب رینڈر جواب

success_response.json
{
"code": 0,
"data": {
  "message": "Async render request submitted successfully",
  "render_id": 105586,
  "status": "processing"
},
"msg": "success"
}

غلطی رینڈر جواب

error_response.json
{
"code": 2004,
"data": {},
"msg": "invalid project data: invalid view array: view item 0: missing required field: id"
}

جواب کے کوڈز

یہاں غیر ہم وقتی رینڈرنگ API کی طرف سے واپس کیے گئے کوڈز ہیں:

  • 0: کامیابی – غیر ہم وقتی رینڈر درخواست کامیابی سے جمع کرائی گئی۔
  • 2001: پیرامیٹر کی غلطی – درخواست میں غلط یا غائب پیرامیٹرز ہیں۔
  • 2002: صارف رجسٹرڈ نہیں ہے – فراہم کردہ صارف ID موجود نہیں ہے۔
  • 2003: صارف API کا رکن نہیں ہے اور رینڈرنگ خدمات استعمال نہیں کر سکتا۔
  • 2004: غلط پروجیکٹ ڈیٹا – projectData فیلڈ درست JSON آبجیکٹ نہیں ہے۔
  • 2005: رینڈر بیلنس کافی نہیں – رینڈرنگ کے لیے آگے بڑھنے کے لیے بیلنس ناکافی ہے۔
  • 2006: پروجیکٹ ڈیٹا کو مارشل کرنے میں ناکامی – پروجیکٹ ڈیٹا کو JSON میں تبدیل نہیں کیا جا سکا۔
  • 2007: JSON ڈیٹا اپ لوڈ کرنے میں ناکامی – پروجیکٹ ڈیٹا اپ لوڈ کرتے وقت غلطی پیش آئی۔
  • 2008: رینڈر ڈیٹا کو مارشل کرنے میں ناکامی – رینڈر درخواست کا پیلوڈ سیریلائز نہیں کیا جا سکا۔
  • 2009: رینڈر درخواست بھیجنے میں ناکامی – درخواست بھیجتے وقت غلطی پیش آئی۔
  • 2010: دورانیہ فیلڈ غائب ہے – duration فیلڈ درکار ہے لیکن غائب ہے۔
  • 2011: غلط دورانیہ فیلڈ – duration فیلڈ موجود ہے لیکن صحیح شکل میں نہیں ہے۔
  • 2012: رینڈر سروس ناکام – رینڈرنگ سروس میں داخلی غلطی پیش آئی۔

اگر آپ کو کوئی غلطی کا کوڈ ملتا ہے جو فہرست میں نہیں ہے تو براہ کرم [email protected] پر سپورٹ سے رابطہ کریں۔

رینڈر نتیجہ حاصل کریں

غیر ہم وقتی رینڈر درخواست جمع کروانے کے بعد، آپ render_id کا استعمال کرکے رینڈرنگ کی حیثیت اور نتیجہ جانچ سکتے ہیں۔

get-result-example.sh
curl -X POST https://render-api.chillin.online/render/result \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer YOUR_API_KEY" \
-d '{"render_id": 100000}'

درخواست کے پیرامیٹرز

پراپقسمضروریمثالقدر کی حدتفصیل
render_idnumbertrue100000-ابتدائی رینڈر درخواست سے واپس کردہ رینڈر ID۔

کامیاب رینڈر جواب

result_response.json
{
"code": 0,
"data": {
  "render": {
    "create_at": "2025-06-27T12:37:21.684337Z",
    "json_url": "https://cloud.chillin.online/project_xxx.json?verify=xxx",
    "render_id": 105549,
    "state": "success",
    "video_url": "https://cloud.chillin.online/video_xxx.mp4?verify=xxx"
  }
},
"msg": "success"
}

رینڈر ریاستیں

جواب میں state فیلڈ میں درج ذیل قیمتیں ہو سکتی ہیں:

  • pending: رینڈر درخواست قطار میں ہے اور پروسیس ہونے کا انتظار کر رہی ہے
  • rendering: رینڈر اس وقت پروسیس ہو رہا ہے
  • success: رینڈر کامیابی سے مکمل ہو گیا اور ویڈیو تیار ہے
  • failed: رینڈر کسی غلطی کی وجہ سے ناکام ہو گیا

رینڈر فائلیں حذف کریں

اس اینڈپوائنٹ کا استعمال مکمل شدہ کام کے لیے رینڈر کردہ ویڈیو فائل اور پروجیکٹ JSON کو مستقل طور پر ہٹانے کے لیے کریں۔

delete-render-files.sh
curl -X POST https://render-api.chillin.online/render/delete-files \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer YOUR_API_KEY" \
-d '{"render_id": 100000}'

درخواست کے پیرامیٹرز

پراپقسمضروریمثالقدر کی حدتفصیل
render_idnumbertrue100000-وہ رینڈر ID جسے آپ صاف کرنا چاہتے ہیں۔ صرف کامیاب حالت میں رینڈر کو حذف کیا جا سکتا ہے۔

نمونہ جواب

delete_response.json
{
"code": 0,
"data": {
  "message": "Render files deleted"
},
"msg": "success"
}
  • حذف کرنے کی کارروائی ناقابل واپسی ہے اور ویڈیو اور JSON اثاثوں دونوں کو ہٹا دیتی ہے۔
  • ایسی رینڈر کی درخواستیں جو ابھی بھی زیر التوا، رینڈرنگ، یا ناکام ہیں، مسترد کر دی جائیں گی۔