ベンダー固有

OSC API 仕様の API レベル 1 では画像タイプに重点が置かれており、動画のサポートは API レベル 2 で追加されています。カメラメーカーは、必要に応じてカスタム コマンドを定義するか、標準コマンドのパラメータ セットを拡張することをおすすめします。これらは、ベンダー コマンドとベンダー パラメータと呼ばれます。

ベンダー固有のコマンドとパラメータの名前は英数字で、先頭にアンダースコア(_)を付ける必要があります。

ベンダー固有の機能は、次の 4 か所で使用できます。

  • /osc/info API の出力
  • /osc/state API の出力
  • OSC API 仕様(/osc/commands/execute のコマンド)
  • OSC API 仕様、コマンド パラメータたとえば、setOptions コマンドと getOptions コマンドのパラメータなどです。

リクエスト(API 1)
POST /osc/commands/execute HTTP/1.1
Host: [camera ip address]:[httpPort]
Content-Type: application/json;charset=utf-8
Accept: application/json
Content-Length: {CONTENT_LENGTH}
X-XSRF-Protected: 1

{
    "name": "camera.setOptions",
    "parameters": {
        "sessionId": "12ABC3",
        "iso": 200,
        "exposureCompensation": -2,
        "captureMode": "_video"
    }
}
レスポンス
HTTP/1.1 200 OK
Content-Type: application/json;charset=utf-8
Content-Length: {CONTENT_LENGTH}
X-Content-Type-Options: nosniff

{
    "name": "camera.setOptions",
    "state": "done"
}
リクエスト
POST /osc/commands/execute HTTP/1.1
Host: [camera ip address]:[httpPort]
Content-Type: application/json;charset=utf-8
Accept: application/json
Content-Length: {CONTENT_LENGTH}
X-XSRF-Protected: 1

{
    "name": "camera._startRecording",
    "parameters": {
        "sessionId": "12ABC3",
        ...
    }
}
レスポンス
HTTP/1.1 200 OK
Content-Type: application/json;charset=utf-8
Content-Length: {CONTENT_LENGTH}
X-Content-Type-Options: nosniff

{
    "name": "camera._startRecording",
    "state": "done"
}