Informasi

API /osc/info mengembalikan informasi dasar tentang kamera dan fungsionalitas yang didukung.

Input

  • Perintah ini tidak mengambil masukan.

Output

Nama Tipe Keterangan
manufacturer String Produsen kamera.
model String Model kamera.
serialNumber String Nomor seri.
firmwareVersion String Versi firmware saat ini.
supportUrl String URL untuk laman web dukungan kamera.
gps Boolean True jika kamera dilengkapi GPS.
gyro Boolean True jika kamera dilengkapi Giroskop.
uptime Integer Jumlah detik sejak kamera dinyalakan.
api Larik String Daftar API yang didukung.
endpoints Objek Objek JSON yang berisi informasi tentang titik akhir kamera. Lihat tabel berikutnya.
apiLevel Larik Integer Secara default [1] jika bidang ini tidak ada. [1, 2] menyatakan API 1 dan 2 didukung sedangkan [2] menyatakan hanya API [2] yang didukung. Developer bertanggung jawab untuk mengambil informasi ini dan mengimplementasikannya secara berbeda berdasarkan nilai. Bidang ini telah ditambahkan dalam API level 2.
_vendorSpecific [tipe] (opsional) Informasi tambahan vendor-spesifik tentang kamera. Awali kunci vendor-spesifik dengan garis bawah ( _ ) untuk mencegah konflik namespace.

Objek endpoints

Objek JSON ini menyediakan informasi tentang porta yang digunakan kamera untuk titik akhir.

Nama Tipe Keterangan
httpPort Integer Porta untuk server HTTP. (Default 80)
httpUpdatesPort Integer Porta untuk menerima pembaruan melalui HTTP
httpsPort Integer (Opsional) Porta untuk server HTTPs. (Default 443)
httpsUpdatesPort Integer (Opsional) Porta untuk menerima pembaruan melalui HTTPs.

Kesalahan

  • Perintah ini tidak mengembalikan kesalahan.

Contoh

Permintaan
GET /osc/info HTTP/1.1
Host: [camera ip address]:[httpPort]
Accept: application/json
X-XSRF-Protected: 1
Respons (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]
}
Respons (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"
        ]
}