Difference between revisions of "iPi Automation Add-on"
From iPi Docs
(Created page with "=== Overview === '''iPi Integration Add-on''' allows to control iPi Recorder and iPi Mocap Studio from external application by sending [http://en.wikipedia.org/wiki/J...") |
|||
Line 18: | Line 18: | ||
{{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.}} | {{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 [http://en.wikipedia.org/wiki/JSON JSON] syntax. The response is also [http://en.wikipedia.org/wiki/JSON 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'' | ||
+ | |||
+ | ''SAMPLE'' | ||
+ | |||
+ | |||
+ | Response: | ||
+ | |||
+ | ===== Recording Commands ===== | ||
+ | |||
+ | ===== Player Commands ===== |
Revision as of 02:19, 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
SAMPLE
Response: