Difference between revisions of "iPi Automation Add-on"
From iPi Docs
| Line 24: | Line 24: | ||
Commands are strings based on [http://en.wikipedia.org/wiki/JSON JSON] syntax. The response is also [http://en.wikipedia.org/wiki/JSON JSON] string. | Commands are strings based on [http://en.wikipedia.org/wiki/JSON JSON] syntax. The response is also [http://en.wikipedia.org/wiki/JSON JSON] string. | ||
| + | |||
| + | ''SYNOPSIS'' | ||
| + | |||
| + | <syntaxhighlight lang=javascript> | ||
| + | // Request | ||
| + | { | ||
| + | "command":<command_name_string> | ||
| + | "arguments":<arguments_list_json_string> | ||
| + | } | ||
| + | |||
| + | // Response | ||
| + | { | ||
| + | "success":true|false | ||
| + | [,"result":<result_json_string>] | ||
| + | } | ||
| + | </syntaxhighlight> | ||
| + | |||
==== iPi Recorder Commands ==== | ==== iPi Recorder Commands ==== | ||
| Line 35: | Line 52: | ||
'''get-app-info''' command returns the name of application and its version. | '''get-app-info''' command returns the name of application and its version. | ||
| − | '' | + | ''SYNOPSIS'' |
| + | <syntaxhighlight lang=javascript> | ||
| + | // Request | ||
| + | { | ||
| + | "command":"get-app-info" | ||
| + | } | ||
| − | + | // Response | |
| + | { | ||
| + | "success":true|false | ||
| + | "result": | ||
| + | { | ||
| + | "appName":<application_name_string>, | ||
| + | "appVersion":<application_version_string> | ||
| + | } | ||
| + | } | ||
| + | </syntaxhighlight> | ||
| − | '' | + | ''SAMPLE'' |
| − | + | <syntaxhighlight lang=javascript> | |
| + | // Request | ||
| + | { | ||
| + | "command":"get-app-info" | ||
| + | } | ||
| − | '' | + | // Response |
| + | { | ||
| + | "success":true|false | ||
| + | "result": | ||
| + | { | ||
| + | "appName":"iPi Recorder 3", | ||
| + | "appVersion":"99.876.543.210" | ||
| + | } | ||
| + | } | ||
| + | </syntaxhighlight> | ||
| + | |||
| + | ===== Recording Commands ===== | ||
| + | |||
| + | ====== set-recorder-props ====== | ||
| + | |||
| + | ''DESCRIPTION'' | ||
| + | |||
| + | '''set-recorder-props''' command sets properties for setup, background and recroding stages. | ||
''SAMPLE'' | ''SAMPLE'' | ||
| − | <syntaxhighlight lang= | + | <syntaxhighlight lang=javascript> |
| + | // Request | ||
{ | { | ||
"command":"set-recorder-props", | "command":"set-recorder-props", | ||
| Line 55: | Line 108: | ||
"globalDeviceProps": | "globalDeviceProps": | ||
{ | { | ||
| − | "PlayStation Eye: Darkening for calibration": | + | "PlayStation Eye: Darkening for calibration":"None" |
}, | }, | ||
"hideBackgroundWhenRecording":true, | "hideBackgroundWhenRecording":true, | ||
| Line 62: | Line 115: | ||
} | } | ||
} | } | ||
| − | |||
| − | + | // Response | |
| − | Response: | + | { |
| − | + | "success":true | |
| − | + | } | |
| + | </syntaxhighlight> | ||
===== Player Commands ===== | ===== Player Commands ===== | ||
Revision as of 05:00, 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
DESCRIPTION
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> } }
SAMPLE
// Request { "command":"get-app-info" } // Response { "success":true|false "result": { "appName":"iPi Recorder 3", "appVersion":"99.876.543.210" } }
Recording Commands
set-recorder-props
DESCRIPTION
set-recorder-props command sets properties for setup, background and recroding stages.
SAMPLE
// Request { "command":"set-recorder-props", "arguments": { "colorCompression":"jpeg", "globalDeviceProps": { "PlayStation Eye: Darkening for calibration":"None" }, "hideBackgroundWhenRecording":true, "recordingStartDelay":0, "videoMode":null } } // Response { "success":true }