Revision as of 09:11, 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:

• Using iPi Recorder and iPi Mocap Studio as a part of third-party solution
• Automation of repeatable tasks
• Automation of custom workflow

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

   

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.

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.

EXAMPLE

// Request
{
    "command": "get-app-info"
}
 
// Response
{
    "success":true,
    "result":
    {
        "appName": "iPi Recorder 3",
        "appVersion": "99.876.543.210"
    }
}

open-studio

open-studio command opens iPi Mocap Studio and creates the project from specified .iPiVideo file.

EXAMPLE

// Request
{
    "command": "open-studio",
    "arguments": 
    {
        "filePath": "D:\iPiMocap\test_record.iPiVideo"
    }
}
 
// Response
{
    "success":true
}

exit

exit command closes iPi Recorder.

EXAMPLE

// Request
{
    "command": "exit"
}
 
// Response
{
    "success":true
}

Recording Commands

open-home-screen

open-home-screen opens HOME screen of iPi Recorder.

EXAMPLE

// Request
{
    "command": "open-home-screen"
}
 
// Response
{
    "success":true
}

set-recorder-props

set-recorder-props command sets properties for setup, background and recording stages.

Tip: If property is not specified in command arguments, current value in user interface will be used.

EXAMPLE

// 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