מידע

ממשק ה-API של /osc/info מחזיר מידע בסיסי על המצלמה והפונקציונליות שהוא תומך בו.

קלט

  • פקודה זו לא מקבלת קלט.

פלט

שם סוג תיאור
manufacturer מחרוזת יצרן המצלמה.
model מחרוזת דגם המצלמה.
serialNumber מחרוזת מספר סידורי.
firmwareVersion מחרוזת גרסת הקושחה הנוכחית.
supportUrl מחרוזת כתובת ה-URL של דף האינטרנט לתמיכה של המצלמה.
gps בוליאני הערך הוא True אם למצלמה יש GPS.
gyro בוליאני הערך הוא True אם במצלמה יש ג'יירוסקופ.
uptime מספר שלם מספר השניות מאז הפעלת המצלמה.
api מערך מחרוזות רשימת ממשקי ה-API הנתמכים.
endpoints אובייקט אובייקט JSON שמכיל מידע על נקודות הקצה של המצלמה. פרטים נוספים מפורטים בטבלה הבאה.
apiLevel מערך מספר שלם כברירת מחדל, הערך יהיה [1] כשהשדה הזה חסר. [1, 2] מייצג תמיכה ב-API 1 וגם ב-2, בעוד ש-[2] מייצג רק תמיכה ב-API 2. המפתח אחראי לאחזר את המידע הזה ולהטמיע אותו באופן שונה בהתאם לערך. השדה הזה נוסף ברמת API 2. יש להשתמש גם בגרסה 2 אם יש תמיכה ב-API 2.1.
cameraId מחרוזת מזהה ייחודי שמייצג את המצלמה. השדה הזה נוסף ברמת API 2.1, והוא רלוונטי להעלאה ישירה.
_vendorSpecific type פרטים נוספים וספציפיים של הספק לגבי המצלמה. כדי למנוע התנגשויות בין מרחב שמות, יש להוסיף קו תחתון ( _) למפתחות ספציפיים לספק.

אובייקט אחד (endpoints)

אובייקט ה-JSON הזה מספק מידע על היציאות שבהן המצלמה משתמשת לנקודות הקצה.

הערה: נקודות הקצה מסוג HTTPS הן אופציונליות.

שם סוג תיאור
httpPort מספר שלם יציאה לשרת HTTP. (ברירת מחדל 80)
httpUpdatesPort מספר שלם יציאה לקבלת עדכונים באמצעות HTTP
httpsPort מספר שלם (אופציונלי) יציאה לשרת HTTP. (ברירת המחדל 443)
httpsUpdatesPort מספר שלם (אופציונלי) יציאה לקבלת עדכונים באמצעות HTTP.

שגיאה

  • פקודה זו לא מחזירה שגיאות.

דוגמה
שליחת בקשה 
GET /osc/info HTTP/1.1
Host: [camera ip address]:[httpPort]
Accept: application/json
X-XSRF-Protected: 1
תגובה (API 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]
}
תגובה (API 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"
        ]
}