Difference between revisions of "iPi Automation Add-on"
From iPi Docs
m |
|||
Line 47: | Line 47: | ||
''SAMPLE'' | ''SAMPLE'' | ||
− | <syntaxhighlight lang= | + | <syntaxhighlight lang=JavaScript> |
{ | { | ||
"command":"set-recorder-props", | "command":"set-recorder-props", |
Revision as of 03:26, 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.
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: