تعرض واجهة برمجة التطبيقات /osc/info
معلومات أساسية حول الكاميرا والوظائف
التي يدعمها.
الإدخال
- لا يتطلب هذا الأمر إدخالاً.
الناتج
الاسم | النوع | الوصف |
---|---|---|
manufacturer |
سلسلة | الشركة المصنّعة للكاميرا. |
model |
سلسلة | طراز الكاميرا |
serialNumber |
سلسلة | الرقم التسلسلي. |
firmwareVersion |
سلسلة | الإصدار الحالي للبرامج الثابتة |
supportUrl |
سلسلة | عنوان URL لصفحة ويب دعم الكاميرا. |
gps |
منطقي | صحيح إذا كانت الكاميرا بها نظام تحديد المواقع العالمي (GPS). |
gyro |
منطقي | صحيح إذا كانت الكاميرا بها جيروسكوب. |
uptime |
عدد صحيح | عدد الثواني منذ تشغيل الكاميرا. |
api |
مصفوفة السلاسل | قائمة بواجهات برمجة التطبيقات المتوافقة |
endpoints |
الكائن | كائن JSON يحتوي على معلومات حول نقاط نهاية الكاميرا اطّلِع على الجدول التالي. |
apiLevel |
مصفوفة عدد صحيح | وتكون القيمة [1] تلقائيًا عندما يكون هذا الحقل غير متوفّر. يشير الرقم [1، 2] إلى توفّر كل من واجهة برمجة التطبيقات 1 وواجهة برمجة التطبيقات 2، بينما يمثّل الرقم [2] واجهة برمجة التطبيقات 2 فقط المتاحة. وتقع على عاتق المطوّر مسؤولية استرداد هذه المعلومات وتنفيذها بشكلٍ مختلف استنادًا إلى القيمة. تمت إضافة هذا الحقل في المستوى 2 من واجهة برمجة التطبيقات. يُرجى أيضًا استخدام الرقم 2 إذا كنت تتيح الإصدار 2.1 من واجهة برمجة التطبيقات. |
cameraId |
سلسلة | معرّف فريد يمثّل الكاميرا تمت إضافة هذا الحقل في المستوى 2.1 من واجهة برمجة التطبيقات، وهو ذو صلة بخيار التحميل المباشر. |
_vendorSpecific |
النوع | معلومات إضافية محدّدة للمورّد حول الكاميرا يُرجى إضافة شرطة سفلية ( _) كبادئة للمفاتيح الخاصة بالمورّد، وذلك لتجنُّب تعارض مساحة الاسم. |
عنصر واحد (endpoints
)
يوفّر كائن JSON هذا معلومات عن المنافذ التي تستخدمها الكاميرا لنقاط النهاية.
ملاحظة: نقاط نهاية HTTPS اختيارية.
الاسم | النوع | الوصف |
---|---|---|
httpPort |
عدد صحيح | منفذ لخادم HTTP. (القيمة التلقائية 80) |
httpUpdatesPort |
عدد صحيح | منفذ لتلقّي التحديثات عبر HTTP |
httpsPort |
عدد صحيح | (اختياري) منفذ لخادم HTTPs. (العدد التلقائي 443) |
httpsUpdatesPort |
عدد صحيح | (اختياري) منفذ لتلقّي التحديثات عبر بروتوكولات HTTP. |
خطأ
- لا يؤدي هذا الأمر إلى عرض أي أخطاء.
مثال |
|
---|---|
طلب | GET /osc/info HTTP/1.1 Host: [camera ip address]:[httpPort] Accept: application/json X-XSRF-Protected: 1 |
الردّ (واجهة برمجة التطبيقات 2) | HTTP/1.1 200 OK Content-Type: application/json;charset=utf-8 Content-Length: {CONTENT_LENGTH} X-Content-Type-Options: nosniff { "manufacturer": "AAA", "model": "BBB", "serialNumber": "CCC", "firmwareVersion": "DDD", "supportUrl": "EEE", "endpoints": { "httpPort": 80, "httpUpdatesPort": 10080, ... }, "gps": true, "gyro": false, "uptime": 600, "api": [ "/osc/info", "/osc/state", "/osc/checkForUpdates", "/osc/commands/execute", "/osc/commands/status" ], "apiLevel": [1, 2] } |
الرد (واجهة برمجة التطبيقات 1) | HTTP/1.1 200 OK Content-Type: application/json;charset=utf-8 Content-Length: {CONTENT_LENGTH} X-Content-Type-Options: nosniff { "manufacturer": "AAA", "model": "BBB", "serialNumber": "CCC", "firmwareVersion": "DDD", "supportUrl": "EEE", "endpoints": { "httpPort": 80, "httpUpdatesPort": 10080, ... }, "gps": true, "gyro": false, "uptime": 600, "api": [ "/osc/info", "/osc/state", "/osc/checkForUpdates", "/osc/commands/execute", "/osc/commands/status" ] } |