Difference between revisions of "iPi Automation Add-on"

From iPi Docs
Jump to: navigation, search
m
Line 23: Line 23:
 
=== Command Syntax Reference ===
 
=== 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.
+
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.
 +
 
 +
The response is also [http://en.wikipedia.org/wiki/JSON 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 [http://en.wikipedia.org/wiki/JSON JSON] object.
 +
 
 +
The response can be synchroneous for commads that are performed fast, or asynchroneous if command takes time to perform.
  
 
''SYNOPSIS''
 
''SYNOPSIS''
  
 
<syntaxhighlight lang=javascript>
 
<syntaxhighlight lang=javascript>
// Request
+
// Request without arguments
 
{
 
{
     "command":<command_name_string>,
+
     "command": "<command_name_string>"
    ["arguments":<arguments_list_json_string>]
+
 
}
 
}
  
// Response
+
// Request with arguments
 
{
 
{
     "success":true|false,
+
     "command": "<command_name_string>",
     ["result":<result_json_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>
 +
    }
 +
}
 +
 +
// Simple response in case of error
 +
{
 +
    "success": false,
 +
    "error": "<error_message_string>"
 +
}
 +
 
</syntaxhighlight>
 
</syntaxhighlight>
  

Revision as of 03:25, 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 Reference

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 without arguments
{
    "command": "<command_name_string>"
}
 
// Request 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>
    } 
}
 
// Simple 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
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