Difference between revisions of "iPi Automation Add-on"

From iPi Docs
Jump to: navigation, search
m
Line 49: Line 49:
 
<syntaxhighlight lang=JavaScript>
 
<syntaxhighlight lang=JavaScript>
 
{
 
{
"command":"set-recorder-props",
+
    "command":"set-recorder-props",
"arguments":{
+
    "arguments":
"colorCompression":"jpeg",
+
    {
"globalDeviceProps":{
+
        "colorCompression":"jpeg",
"PlayStation Eye: Darkening for calibration":null
+
"globalDeviceProps":
},
+
        {
"hideBackgroundWhenRecording":true,
+
    "PlayStation Eye: Darkening for calibration":null
"recordingStartDelay":0,
+
        },
"videoMode":null
+
    "hideBackgroundWhenRecording":true,
}
+
    "recordingStartDelay":0,
 +
    "videoMode":null
 +
    }
 
}
 
}
 
</syntaxhighlight>
 
</syntaxhighlight>

Revision as of 04:29, 1 December 2015

Overview

iPi Integration Add-on allows to control iPi Recorder and iPi Mocap Studio from external application by sending JSON commands via Windows dll. It can be used for:

Note.png
Note: iPi Integration Add-on requires separate license key, which you need to activate in iPi Mocap Studio. 30-days free trial provided.

License and Trial

iPi Integration Add-on requires separate license key, which you need to activate in iPi Mocap Studio. You can order your license here, or activate 30-days free trial. Follow the steps below to start working with iPi Integration Add-on

  1. Switch to Integration tab.
  2. Press Activate button
  3. Press Start 30-days Free Trial Period or Enter Integration License Key and follow further on-screen instructions
    iPi-Integration-2-1.png
Note.png
Note: To use iPi Integration Add-on with iPi Recorder, you have to install iPi Mocap Studio on the same computer and activate iPi Integration Add-on following the instructions above.

Using iPi Integration Add-on

Command Syntax Reference

Commands are strings based on JSON syntax. The response is also JSON string.

iPi Recorder Commands

General Commands
get-app-info

DESCRIPTION

get-app-info command returns the name of application and its version.

PARAMETERS

No parameters

RESPONSE

appName: application name in string format

appVersion: application version in string format

SAMPLE

{
    "command":"set-recorder-props",
    "arguments":
    {
        "colorCompression":"jpeg",
	"globalDeviceProps":
        {
	    "PlayStation Eye: Darkening for calibration":null
        },
    "hideBackgroundWhenRecording":true,
    "recordingStartDelay":0,
    "videoMode":null
    }
}


Response:

Recording Commands
Player Commands