Rokoko Studio - Command API

Rokoko Studio offers an API that allows you to operate a running application through a range of commands.

At the moment, the following commands are available - for any of them to work, you need to have a scene open:

You can find example code and additional information in our open-source Github repository:

In order to send commands to and receive messages from Studio, the following values will need to be defined:

IP address (of the computer running Rokoko Studio that you want to interface with)
Port (the port value defined in Rokoko Studio settings; defaults to 14053. This needs to be changed if this port is blocked or used by another application)
API key (the API key defined in Rokoko Studio settings; defaults to 1234)

The command is then sent as a http request in the following format:

for example

Used to start and stop a recording

Command: recording/start or recording/stop
Parameters:
- filename: The name of the clip you want to record (optional)
- time: Timecode in SMPTE format "hh:mm:ss:ff". When it comes to start recording, the timecode will define a recorded clip start time. when it comes to stop recording and timecode provided is not with zeros, the timecode will be used to calculate clip duration and trim the data if required (optional)
- frame_rate: Defined framerate for the clip you want to record (optional)
- back_to_live: Set to true if you want to stay in "live view" after ending a recording (optional)

Calibrates all paired live input devices in the scene or for the specified actor

Command: calibrate
Parameters:
- device_id: The name/id of the input device, e.g. a Smartsuit Pro, that you want to calibrate (optional)
  - If no value is given, all live devices in the scene will be calibrated
- countdown_delay: The countdown in seconds before the actual calibration happens (optional)
- skip_suit: If set to true, a paired Smartsuit Pro to the targeted actor will be skipped during calibration (optional)
- skip_gloves: If set to true, paired Smartgloves to the targeted actor will be skipped during calibration (optional)
- use_custom_pose: If set to true, a custom calibration pose can be used, as defined below (optional)
- pose: (optional)
  - straight-arms-down
  - straight-arms-forward
  - tpose

Resets the actor pose and local position

Command: resetactor
Parameters:
- device_id: The name/id of the input device, e.g. a Smartsuit Pro, that is attached to the actor you want to reset

Returns information about the current open scene

Command: info
Parameters:
- devices_info: Set to true if you want information about live input devices in the scene
- clips_info: Set to true if you want information about the recorded clips in the scene

Attaches an external tracker, e.g. a HTC Vive Tracker, to an actor, which can then determine its global position.

Command: tracker
Parameters:
- device_id: The name/id of the input device, e.g. a Smartsuit Pro, that is attached to the actor you want to attach the tracker to
- bone_attached: The bone that the tracker should be attached to. Defaults to "Hips"
- position: Position of the tracker being attached
  - {'X': <value>, 'Y': <value>, 'Z': <value>}
- rotation: Rotation of the tracker being attached (optional)
  - {'X': <value>, 'Y': <value>, 'Z': <value>, 'W': <value>}
- timeout: Time in seconds until the attached tracker releases the attached object (optional)
- is_query_only: Use the command to only query a specified bone position and orientation rather than attaching the actual tracker and take control of the bone (optional)