Difference between revisions of "iPi Automation Add-on"

From iPi Docs
Jump to: navigation, search
m
Line 1: Line 1:
=== Overview ===
+
= Overview =
  
 
'''iPi Integration Add-on''' allows to control [[iPi Recorder]] and [[iPi Mocap Studio]] from external application by sending [http://en.wikipedia.org/wiki/JSON JSON] commands via Windows dll. It can be used for:
 
'''iPi Integration Add-on''' allows to control [[iPi Recorder]] and [[iPi Mocap Studio]] from external application by sending [http://en.wikipedia.org/wiki/JSON JSON] commands via Windows dll. It can be used for:
Line 8: Line 8:
 
{{Note| '''iPi Integration Add-on''' requires separate license key, which you need to activate in [[iPi Mocap Studio]]. 30-days free trial provided.}}
 
{{Note| '''iPi Integration Add-on''' requires separate license key, which you need to activate in [[iPi Mocap Studio]]. 30-days free trial provided.}}
  
=== License and Trial ===
+
= 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 [http://ipisoft.com/software/integration-add-on/ here], or activate 30-days free trial.  
 
'''iPi Integration Add-on''' requires separate license key, which you need to activate in [[iPi Mocap Studio]]. You can order your license [http://ipisoft.com/software/integration-add-on/ here], or activate 30-days free trial.  
Line 19: Line 19:
 
{{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 ===
+
= Using iPi Integration Add-on =
  
=== Command Syntax Reference ===
+
== Command Syntax ==
  
 
Commands are strings based on [http://en.wikipedia.org/wiki/JSON JSON] syntax. Commands are submitted via [http://en.wikipedia.org/wiki/JSON JSON] requests that include command name and may optionally include command arguments.  
 
Commands are strings based on [http://en.wikipedia.org/wiki/JSON JSON] syntax. Commands are submitted via [http://en.wikipedia.org/wiki/JSON JSON] requests that include command name and may optionally include command arguments.  
Line 45: Line 45:
 
     }
 
     }
 
}
 
}
 
  
 
// Simple response in case of success
 
// Simple response in case of success
Line 69: Line 68:
 
</syntaxhighlight>
 
</syntaxhighlight>
  
 +
== iPi Recorder Commands ==
  
==== iPi Recorder Commands ====
+
=== General Commands ===
  
===== General Commands =====
+
==== get-app-info ====
 
+
====== get-app-info ======
+
  
 
''get-app-info'' command returns the name of application and its version.
 
''get-app-info'' command returns the name of application and its version.
Line 115: Line 113:
 
</syntaxhighlight>
 
</syntaxhighlight>
  
===== Recording Commands =====
+
=== Recording Commands ===
  
====== set-recorder-props ======
+
==== set-recorder-props ====
  
 
''set-recorder-props'' command sets properties for setup, background and recroding stages.
 
''set-recorder-props'' command sets properties for setup, background and recroding stages.
Line 155: Line 153:
 
<tr><td colspan="5">''Empty result''</td></tr>
 
<tr><td colspan="5">''Empty result''</td></tr>
 
</table>
 
</table>
 
  
 
''EXAMPLES''
 
''EXAMPLES''
Line 182: Line 179:
 
</syntaxhighlight>
 
</syntaxhighlight>
  
===== Player Commands =====
+
=== Player Commands ===

Revision as of 04:42, 2 December 2015

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:

Note.png
Note: iPi Integration Add-on requires separate license key, which you need to activate in iPi Mocap Studio. 30-days free trial provided.

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

  1. Switch to Integration tab.
  2. Press Activate button
  3. Press Start 30-days Free Trial Period or Enter Integration License Key and follow further on-screen instructions
    iPi-Integration-2-1.png
Note.png
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

Commands are strings based on JSON syntax. Commands are submitted via JSON requests that include command name and may optionally include command arguments.

The response is also JSON string. The response include success flag. In case of error the response include error message. In case of success the response may optionally include result that is JSON object.

The response can be synchroneous for commads that are performed fast, or asynchroneous if command takes time to perform.

SYNOPSIS

// Request for command without arguments
{
    "command": "<command_name_string>"
}
 
// Request for command with arguments
{
    "command": "<command_name_string>",
    "arguments": 
    {
        <arguments_list_json_string>
    }
}
 
// Simple response in case of success
{
    "success": true
}
 
// Response including command result field in case of success
{
    "success": true,
    "result":
    {
      <result_json_string>
    } 
}
 
// Response in case of error
{
    "success": false,
    "error": "<error_message_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 NameTypeRequiredAllowed ValuesDescription
Arguments
videoModestringoptional

Available modes depend on camera model.

Setting RGB video mode. You can see available modes in "Video Mode" combobox at "SETUP" stage, or get it in the result of get-recorder-props command.

colorCompressionstringoptional

"None"

"Background subtraction"

"JPEG"

Setting RGB video compression mode

jpegQualitynumberoptionalinteger from 0 to 100

JPEG quality for JPEG compression

depthCompressionstringoptional"None"
"Background subtraction"

Setting depth compression mode

globalDevicePropsJSON objectoptional

Device-specific list of properties visible in “SHARED SETTINGS” section of “SETUP” stage

PlayStation Eye: Darkening for Calibrationstringoptional "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
}

Player Commands