Difference between revisions of "iPi Automation Add-on"
From iPi Docs
m |
m |
||
| Line 30: | Line 30: | ||
// Request | // Request | ||
{ | { | ||
| − | "command":<command_name_string> | + | "command":<command_name_string>, |
| − | "arguments":<arguments_list_json_string> | + | ["arguments":<arguments_list_json_string>] |
} | } | ||
// Response | // Response | ||
{ | { | ||
| − | "success":true|false | + | "success":true|false, |
| − | [ | + | ["result":<result_json_string>] |
} | } | ||
</syntaxhighlight> | </syntaxhighlight> | ||
| Line 59: | Line 59: | ||
// Response | // Response | ||
{ | { | ||
| − | "success":true|false | + | "success":true|false, |
"result": | "result": | ||
{ | { | ||
| Line 68: | Line 68: | ||
</syntaxhighlight> | </syntaxhighlight> | ||
| − | '' | + | ''EXAMPLES'' |
<syntaxhighlight lang=javascript> | <syntaxhighlight lang=javascript> | ||
| Line 78: | Line 78: | ||
// Response | // Response | ||
{ | { | ||
| − | "success":true | + | "success":true, |
"result": | "result": | ||
{ | { | ||
| Line 93: | Line 93: | ||
''set-recorder-props'' command sets properties for setup, background and recroding stages. | ''set-recorder-props'' command sets properties for setup, background and recroding stages. | ||
| − | '' | + | ''EXAMPLES'' |
<syntaxhighlight lang=javascript> | <syntaxhighlight lang=javascript> | ||
| Line 108: | Line 108: | ||
"hideBackgroundWhenRecording":true, | "hideBackgroundWhenRecording":true, | ||
"recordingStartDelay":0, | "recordingStartDelay":0, | ||
| − | "videoMode": | + | "videoMode":"640x480 color @ 50Hz" |
} | } | ||
} | } | ||
Revision as of 05:23, 1 December 2015
Contents
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:
- Using iPi Recorder and iPi Mocap Studio as a part of third-party solution
- Automation of repeatable tasks
- Automation of custom workflow
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
- Switch to Integration tab.
- Press Activate button
- Press Start 30-days Free Trial Period or Enter Integration License Key and follow further on-screen instructions
Using iPi Integration Add-on
Command Syntax Reference
Commands are strings based on JSON syntax. The response is also JSON string.
SYNOPSIS
// Request { "command":<command_name_string>, ["arguments":<arguments_list_json_string>] } // Response { "success":true|false, ["result":<result_json_string>] }
iPi Recorder Commands
General Commands
get-app-info
get-app-info command returns the name of application and its version.
SYNOPSIS
// Request { "command":"get-app-info" } // Response { "success":true|false, "result": { "appName":<application_name_string>, "appVersion":<application_version_string> } }
EXAMPLES
// Request { "command":"get-app-info" } // Response { "success":true, "result": { "appName":"iPi Recorder 3", "appVersion":"99.876.543.210" } }
Recording Commands
set-recorder-props
set-recorder-props command sets properties for setup, background and recroding stages.
EXAMPLES
// Request { "command":"set-recorder-props", "arguments": { "colorCompression":"jpeg", "globalDeviceProps": { "PlayStation Eye: Darkening for calibration":"None" }, "hideBackgroundWhenRecording":true, "recordingStartDelay":0, "videoMode":"640x480 color @ 50Hz" } } // Response { "success":true }