ה-API /osc/state מחזיר state מאפיינים של המצלמה. ההבדל
בין ה-API הזה לבין ה-API של info הוא שהשדה state מכיל ערכים שניתנים לשינוי
שמייצג את סטטוס המצלמה (batteryLevel, למשל), ואילו info
מכיל מאפיינים סטטיים בלבד של המצלמה (לדוגמה, manufacturer או
מאפיינים שלא משתנים לעיתים קרובות, כמו firmwareVersion).
קלט
פקודה זו לא מקבלת קלט.
פלט
שם
סוג
תיאור
fingerprint
מחרוזת
טביעת אצבע (מזהה ייחודי) של מצב המצלמה הנוכחי.
state
אובייקט
אובייקט JSON שמכיל את הסטטוס של מצבי המצלמה השונים. פרטים נוספים מפורטים בטבלה הבאה.
אובייקט אחד (state)
אובייקט ה-JSON הזה מספק את הסטטוס של מצבי המצלמה השונים. היצרנים יכולים
מספקים מצבים חדשים בהתאמה אישית, שהקידומת שלהם צריכה להיות קו תחתון ( _ )
כדי למנוע התנגשויות בין מרחבי שמות.
שם
סוג
תיאור
sessionId
מחרוזת
מזהה הסשן הנוכחי. השדה הזה הוצא משימוש ברמת API 2.
batteryLevel
מספר
מבוטאת כערך נקודה צפה (floating-point) של הסוללה שנותרה, למשל. 0.5
storageChanged
בוליאני
הערך הוא True אם מוסיפים או מסירים סוג חדש של אחסון (למשל כרטיס SD או כונן USB).
השדה הזה הוצא משימוש ברמת API 2.
storageUri
מחרוזת
מזהה ייחודי שעוזר להבדיל בין נפחי אחסון שונים. היא משמשת כדי לדעת אם נפח האחסון השתנה או לא.
השדה הזה נוסף ברמת API 2.
_vendorSpecific
[סוג](אופציונלי)
מצב נוסף הספציפי לספק לגבי המצלמה. כדי למנוע התנגשויות בין מרחב שמות, יש להוסיף קו תחתון ( _ ) בתחילתו.
שגיאה
פקודה זו לא מחזירה שגיאות.
דוגמה
שליחת בקשה
POST /osc/state HTTP/1.1 Host:[camera ip address]:[httpPort] Accept: application/json X-XSRF-Protected:1
תגובה
HTTP/1.1200 OK Content-Type: application/json;charset=utf-8 Content-Length:{CONTENT_LENGTH} X-Content-Type-Options: nosniff
[null,null,["עדכון אחרון: 2024-08-21 (שעון UTC)."],[[["The `/osc/state` API provides mutable camera status values like battery level, unlike the `/osc/info` API which returns static camera attributes."],["Camera state is represented by a `fingerprint` that uniquely identifies it and changes whenever a tracked state is modified."],["The `state` object contains various camera status details, including `batteryLevel`, storage information, and vendor-specific data."],["Manufacturers can introduce custom states within the `state` object using an underscore (_) prefix to avoid conflicts."]]],["The `/osc/state` API retrieves mutable camera status attributes. It outputs a `fingerprint`, a unique identifier for the current camera state, and a `state` object. The `state` object includes `batteryLevel`, `storageUri` and optional vendor-specific states prefixed with an underscore. It also contained `sessionId` and `storageChanged` which have been deprecated. The API uses POST and the response has a `200 OK` HTTP status with a content-type of `application/json`. The fingerprint changes with any tracked state change.\n"]]