Difference between revisions of "iPi Automation Add-on"
From iPi Docs
| Line 94: | Line 94: | ||
<table class="wikitable" border="1"> | <table class="wikitable" border="1"> | ||
| − | < | + | <tr><th>Parameter Name</th><th>Type</th><th>Required</th><th>Allowed Values</th><th>Description</th></tr> |
<tr><td colspan="5" style="background-color: white;">'''Arguments'''</td></tr> | <tr><td colspan="5" style="background-color: white;">'''Arguments'''</td></tr> | ||
| − | <tr><td> | + | <tr><td><tt>colorCompression</tt></td><td>string</td><td>optional</td><td> |
"None" | "None" | ||
| Line 105: | Line 105: | ||
Setting RGB video compression mode | Setting RGB video compression mode | ||
</td></tr> | </td></tr> | ||
| − | <tr><td> | + | <tr><td><tt>jpegQuality</tt></td><td>number</td><td>optional</td><td>integer from 0 to 100</td><td> |
JPEG quality for JPEG compression | JPEG quality for JPEG compression | ||
</td></tr> | </td></tr> | ||
| − | <tr><td> | + | <tr><td><tt>depthCompression</tt></td><td>string</td><td>optional</td><td>"None"<br>"Background subtraction"<br></td><td> |
| − | "None" | + | |
| − | + | ||
| − | "Background subtraction" | + | |
| − | </td><td> | + | |
Setting depth compression mode | Setting depth compression mode | ||
</td></tr> | </td></tr> | ||
| − | <tr><td> | + | <tr><td><tt>globalDeviceProps</tt></td><td>JSON object</td><td>optional</td><td> |
| − | < | + | <td> |
Device-specific list of properties visible in “SHARED SETTINGS” section of “SETUP” stage | Device-specific list of properties visible in “SHARED SETTINGS” section of “SETUP” stage | ||
</td></tr> | </td></tr> | ||
| − | <tr><td> | + | <tr><td style="padding-left: 40px;"><tt>PlayStation Eye: Darkening for Calibration''</tt></td><td>string</td><td>optional |
| − | < | + | </td><td>"None"<br>"Darkening"<br>"Extra Darkening"<br></td><td> |
| − | "None" | + | |
| − | + | ||
| − | "Darkening" | + | |
| − | + | ||
| − | "Extra Darkening" | + | |
| − | < | + | |
Darkening mode for Sony PS3 Eye cameras | Darkening mode for Sony PS3 Eye cameras | ||
</td></tr> | </td></tr> | ||
| Line 132: | Line 122: | ||
<tr><td colspan="5">''Empty result''</td></tr> | <tr><td colspan="5">''Empty result''</td></tr> | ||
</table> | </table> | ||
| + | |||
| + | |||
''EXAMPLES'' | ''EXAMPLES'' | ||
Revision as of 14:12, 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.
| Parameter Name | Type | Required | Allowed Values | Description |
|---|---|---|---|---|
| Arguments | ||||
| colorCompression | string | optional |
"None" "Background subtraction" "JPEG" |
Setting RGB video compression mode |
| jpegQuality | number | optional | integer from 0 to 100 |
JPEG quality for JPEG compression |
| depthCompression | string | optional | "None" "Background subtraction" |
Setting depth compression mode |
| globalDeviceProps | JSON object | optional |
Device-specific list of properties visible in “SHARED SETTINGS” section of “SETUP” stage | |
| PlayStation Eye: Darkening for Calibration | string | optional | "None" "Darkening" "Extra Darkening" |
Darkening mode for Sony PS3 Eye cameras |
| Result | ||||
| Empty result | ||||
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 }