MIXEDREALITY API

• GET cameras
• POST captureobservation
• GET captureprogress
• POST deleteallobservations
• POST deleteobservations
• POST enableobservations
• GET mrsets
• POST selectcamera
• POST selectspatialcalibration
• GET spatialcalibrations

GET cameras

Summary

Returns camera properties of cameras on the current stage

URL

GET    /api/session/mixedreality/cameras

Response

{
  "status": {
    "code": 0,
    "message": "",
    "details": [
      {
        "type_url": "",
        "value": ""
      }
    ]
  },
  "result": [
    {
      "uid": "",
      "name": "",
      "spatialCalibration": {
        "uid": "",
        "name": ""
      }
    }
  ]
}

POST captureobservation

Summary

Capture an observation on the given camera

URL

POST    /api/session/mixedreality/captureobservation

Request

{
  "camera": {
    "uid": "",
    "name": ""
  },
  "spatialCalibration": {
    "uid": "",
    "name": ""
  }
}

Response

{
  "status": {
    "code": 0,
    "message": "",
    "details": [
      {
        "type_url": "",
        "value": ""
      }
    ]
  }
}

GET captureprogress

Summary

Gets the current capture progress, only one capture can run at once

URL

GET    /api/session/mixedreality/captureprogress

Response

{
  "status": {
    "code": 0,
    "message": "",
    "details": [
      {
        "type_url": "",
        "value": ""
      }
    ]
  },
  "result": false
}

POST deleteallobservations

Summary

Delete all observations for a given spatial calibration

URL

POST    /api/session/mixedreality/deleteallobservations

Request

{
  "spatialCalibration": {
    "uid": "",
    "name": ""
  }
}

Response

{
  "status": {
    "code": 0,
    "message": "",
    "details": [
      {
        "type_url": "",
        "value": ""
      }
    ]
  }
}

POST deleteobservations

Summary

Pass a list of observation identifiers to delete

URL

POST    /api/session/mixedreality/deleteobservations

Request

{
  "observations": [
    ""
  ]
}

Response

{
  "status": {
    "code": 0,
    "message": "",
    "details": [
      {
        "type_url": "",
        "value": ""
      }
    ]
  }
}

POST enableobservations

Summary

Pass a list of observation identifiers to enable/disable

URL

POST    /api/session/mixedreality/enableobservations

Request

{
  "observations": [
    {
      "uid": "",
      "enable": false
    }
  ]
}

Response

{
  "status": {
    "code": 0,
    "message": "",
    "details": [
      {
        "type_url": "",
        "value": ""
      }
    ]
  }
}

GET mrsets

Summary

Returns mixed reality sets on the current stage

URL

GET    /api/session/mixedreality/mrsets

Response

{
  "status": {
    "code": 0,
    "message": "",
    "details": [
      {
        "type_url": "",
        "value": ""
      }
    ]
  },
  "result": [
    {
      "uid": "",
      "name": "",
      "currentCamera": {
        "uid": "",
        "name": ""
      },
      "isCameraOverride": false
    }
  ]
}

POST selectcamera

Summary

Sets the current camera of an MR Set

URL

POST    /api/session/mixedreality/selectcamera

Request

{
  "mrSet": {
    "uid": "",
    "name": ""
  },
  "cameraOverride": {
    "uid": "",
    "name": ""
  }
}

Response

{
  "status": {
    "code": 0,
    "message": "",
    "details": [
      {
        "type_url": "",
        "value": ""
      }
    ]
  }
}

POST selectspatialcalibration

Summary

Sets the spatial calibration currently in use by a camera

URL

POST    /api/session/mixedreality/selectspatialcalibration

Request

{
  "camera": {
    "uid": "",
    "name": ""
  },
  "spatialCalibration": {
    "uid": "",
    "name": ""
  }
}

Response

{
  "status": {
    "code": 0,
    "message": "",
    "details": [
      {
        "type_url": "",
        "value": ""
      }
    ]
  }
}

GET spatialcalibrations

Summary

Returns a list of all spatial calibrations

URL

GET    /api/session/mixedreality/spatialcalibrations

Response

{
  "status": {
    "code": 0,
    "message": "",
    "details": [
      {
        "type_url": "",
        "value": ""
      }
    ]
  },
  "result": [
    {
      "uid": "",
      "name": "",
      "mrsets": [
        {
          "uid": "",
          "name": ""
        }
      ],
      "observations": [
        {
          "uid": "",
          "name": "",
          "trackedPose": {
            "position": {
              "x": 0,
              "y": 0,
              "z": 0
            },
            "rotation": {
              "x": 0,
              "y": 0,
              "z": 0
            }
          },
          "solvedPose": {
            "position": {
              "x": 0,
              "y": 0,
              "z": 0
            },
            "rotation": {
              "x": 0,
              "y": 0,
              "z": 0
            }
          },
          "isEnabled": false,
          "zoom": 0,
          "focus": 0,
          "type": "",
          "rmsError": 0
        }
      ]
    }
  ]
}