View source for iPi Automation Add-on

= 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:
* 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 [http://ipisoft.com/software/integration-add-on/ 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
#:[[Image:iPi-Integration-2-1.png|600px|]]

{{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 [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.

Long actions (recording, background evaluation, etc.) initiated by commands generate asynchroneous ''events'' on action completion. Event is described by [http://en.wikipedia.org/wiki/JSON JSON] string that include event name and may include optional arguments, depending on type of event.

''SYNOPSIS''

<syntaxhighlight lang=javascript>
// 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>"
}

// Event without arguments
{
    "event": "<event_name_string>"
}

// Event including arguments
{
    "event": "<event_name_string>",
    "arguments": 
    {
        <arguments_list_json_string>
    }
}

</syntaxhighlight>

== iPi Recorder Commands ==

=== General Commands ===

==== get-app-info ====

''get-app-info'' command returns the name of application and its version.

<table class="wikitable" style="font-size: smaller; min-width: 50%">
<tr><th>Parameter Name</th><th>Type</th><th>Mandatory /<br>Optional</th><th>Allowed Values</th><th>Description</th></tr>
<tr><td colspan="5" style="background-color: white;">'''Arguments'''</td></tr>
<tr><td colspan="5">''No arguments''</td></tr>
<tr><td colspan="5" style="background-color: white;">'''Result'''</td></tr>
<tr><td><tt>appName</tt></td><td>string</td><td align=center>mandatory</td><td><tt>iPi Recorder 3</tt></td>
<td>Application name. 
</td></tr>
<tr><td><tt>appVersion</tt></td><td>string</td><td align=center>mandatory</td><td>Version number in the format <tt>XX.XXX.XXX.XXX</tt></td>
<td>Application version number. 
</td></tr>

</table>
''EXAMPLE''

<syntaxhighlight lang=javascript>
// Request
{
    "command": "get-app-info"
}

// Response
{
    "success":true,
    "result":
    {
        "appName": "iPi Recorder 3",
        "appVersion": "99.876.543.210"
    }
}
</syntaxhighlight>

==== open-studio ====

''open-studio'' command opens [[iPi Mocap Studio]] and creates the project from specified [[.iPiVideo File Extension|'''.iPiVideo''']] file.

<table class="wikitable" style="font-size: smaller; min-width: 50%">
<tr><th>Parameter Name</th><th>Type</th><th>Mandatory /<br>Optional</th><th>Allowed Values</th><th>Description</th></tr>
<tr><td colspan="5" style="background-color: white;">'''Arguments'''</td></tr>
<tr><td><tt>filePath</tt></td><td>string</td><td align=center>mandatory</td><td>Valid file path</td>
<td>Full path of [[.iPiVideo File Extension|'''.iPiVideo''']] file.
</td></tr>
<tr><td colspan="5" style="background-color: white;">'''Result'''</td></tr>
<tr><td colspan="5">''Empty result''</td></tr>
</table>
''EXAMPLE''

<syntaxhighlight lang=javascript>
// Request
{
    "command": "open-studio",
    "arguments": 
    {
        "filePath": "D:\iPiMocap\test_record.iPiVideo"
    }
}

// Response
{
    "success": true
}
</syntaxhighlight>

==== exit ====

''exit'' command closes [[iPi Recorder]].

<table class="wikitable" style="font-size: smaller; min-width: 50%">
<tr><th>Parameter Name</th><th>Type</th><th>Mandatory /<br>Optional</th><th>Allowed Values</th><th>Description</th></tr>
<tr><td colspan="5" style="background-color: white;">'''Arguments'''</td></tr>
<tr><td colspan="5">''No arguments''</td></tr>
<tr><td colspan="5" style="background-color: white;">'''Result'''</td></tr>
<tr><td colspan="5">''Empty result''</td></tr>
</table>
''EXAMPLE''

<syntaxhighlight lang=javascript>
// Request
{
    "command": "exit"
}

// Response
{
    "success": true
}
</syntaxhighlight>

=== Recording Commands ===

==== open-home-screen ====

''open-home-screen'' opens HOME screen of [[iPi Recorder]].

<table class="wikitable" style="font-size: smaller; min-width: 50%">
<tr><th>Parameter Name</th><th>Type</th><th>Mandatory /<br>Optional</th><th>Allowed Values</th><th>Description</th></tr>
<tr><td colspan="5" style="background-color: white;">'''Arguments'''</td></tr>
<tr><td colspan="5">''No arguments''</td></tr>
<tr><td colspan="5" style="background-color: white;">'''Result'''</td></tr>
<tr><td colspan="5">''Empty result''</td></tr>
</table>
''EXAMPLE''

<syntaxhighlight lang=javascript>
// Request
{
    "command": "open-home-screen"
}

// Response
{
    "success": true
}
</syntaxhighlight>

==== refresh-device-list ====

''refresh-device-list'' returns the list of available devices.

<table class="wikitable" style="font-size: smaller; min-width: 50%">
<tr><th>Parameter Name</th><th>Type</th><th>Mandatory /<br>Optional</th><th>Allowed Values</th><th>Description</th></tr>
<tr><td colspan="5" style="background-color: white;">'''Arguments'''</td></tr>
<tr><td colspan="5">''No arguments''</td></tr>
<tr><td colspan="5" style="background-color: white;">'''Result'''</td></tr>
<tr><td colspan="5">Array of JSON objects, each representing recording device. Fields of array items:</td></tr>
<tr><td><tt>kind</tt></td><td>string</td><td align=center>mandatory</td><td><tt>camera</tt><br><tt>depth-sensor</tt><br><tt>microfon</tt></td>
<td>Device type.</td></tr>
<tr><td><tt>model</tt></td><td>string</td><td align=center>mandatory</td><td>Supported device model</td>
<td>Device model.</td></tr>
<tr><td><tt>id</tt></td><td>string</td><td align=center>mandatory</td><td>Unique string, format depends on device model</td>
<td>Unique string that is used to identify recording devices in ''open-recorder'' command.</td></tr>
<tr><td><tt>selected</tt></td><td>boolean</td><td align=center>mandatory</td><td><tt>true<br>false</tt></td>
<td>Device selected status.</td></tr>
<tr><td><tt>failed</tt></td><td>boolean</td><td align=center>mandatory</td><td><tt>true<br>false</tt></td>
<td>Device filed status.</td></tr>
<tr><td><tt>error</tt></td><td>string</td><td align=center>optional</td><td>Error message string</td>
<td>Error message if device is in failed status.</td></tr>
</table>
''EXAMPLE''

<syntaxhighlight lang=javascript>
// Request
{
    "command": "refresh-device-list"
}

// Response
{
    "success":true,
    "result":
    [
        {
            "kind": "camera",
            "model": "PlayStation Eye",
            "id": "\\\\?\\usb#vid_1415&pid_2000&mi_00#7&2ed872d7&0&0000#{4cff9941-d72f-4951-9291-03d8fc97fe30}",
            "selected": false,
            "failed": false
        },
        {
            "kind": "depth-sensor",
            "model": "Kinect 2 for Windows",
            "id": "Default Kinect 2",
            "selected": true,
            "failed": true,
            "error": "Is not available"
        },    
        {
            "kind": "microphone",
            "model": "USB Camera-B4.04.27.1",
            "id": "Microphone (USB Camera-B4.04.27 [VID=-1; PID=-1; Driver=256; Channels=2; Supports=WAVE_FORMAT_11M08, ...]",
            "selected": false,
            "failed": false
        }
    ]
}
</syntaxhighlight>

==== open-recorder ====

''open-recorder'' selects devices for recording and switches to SETUP stage.

<table class="wikitable" style="font-size: smaller; min-width: 50%">
<tr><th>Parameter Name</th><th>Type</th><th>Mandatory /<br>Optional</th><th>Allowed Values</th><th>Description</th></tr>
<tr><td colspan="5" style="background-color: white;">'''Arguments'''</td></tr>
<tr><td><tt>selectedDevices</tt></td><td>string array</td><td align=center>mandatory</td><td>List of device id strings</td>
<td>Selecting devices for recording. Device ids are returned by '''refresh-device-list''' command.</td></tr>
<tr><td colspan="5" style="background-color: white;">'''Result'''</td></tr>
<tr><td colspan="5">''Empty result''</td></tr>
</table>
''EXAMPLE''

<syntaxhighlight lang=javascript>
// Request
{
    "command": "open-recorder"
    "arguments":
    {
        "selectedDevices":
        [
            "\\\\?\\usb#vid_1415&pid_2000&mi_00#7&2ed872d7&0&0000#{4cff9941-d72f-4951-9291-03d8fc97fe30}",
            "\\\\?\\usb#vid_1415&pid_2000&mi_00#7&1c1ec232&0&0000#{4cff9941-d72f-4951-9291-03d8fc97fe30}"
        ]
    }    

}

// Response
{
    "success":true
}
</syntaxhighlight>

==== evaluate-background ====

''evaluate-background'' runs background evaluation.

{{Tip|If parameter is not specified in command arguments, current value in user interface will be used.}}

<table class="wikitable" style="font-size: smaller; min-width: 50%">
<tr><th>Parameter Name</th><th>Type</th><th>Mandatory /<br>Optional</th><th>Allowed Values</th><th>Description</th></tr>
<tr><td colspan="5" style="background-color: white;">'''Arguments'''</td></tr>
<tr><td><tt>duration</tt></td><td>number</td><td align=center>optional</td><td>Integer number of seconds from 2 to 10<td>
Setting duration of background evaluation.
</td></tr>
<tr><td><tt>startDelay</tt></td><td>number</td><td align=center>optional</td><td>Integer number of seconds from 0 to 30<td>
Setting start delay for background evaluation.
</td></tr>
<tr><td colspan="5" style="background-color: white;">'''Result'''</td></tr>
<tr><td colspan="5">''Empty result''</td></tr>
<tr><td colspan="5" style="background-color: white;">'''Events'''</td></tr>
<tr><td colspan="5">'''background-evaluation-stopped''' event is generated when background evaluation is competed or cancelled</td></tr>
<tr><td><tt>success</tt></td><td>boolean</td><td align=center>mandatory</td><td><tt>true<br>false</tt></td>
<td>Success flag. Set to <tt>true</tt> if background evaluation was completed successfully.</td></tr>
<tr><td><tt>cancelled</tt></td><td>boolean</td><td align=center>mandatory</td><td><tt>true<br>false</tt></td>
<td>Cancellation flag. Set to <tt>true</tt> if background evaluation was cancelled by user or due to error.</td></tr>
</table>
''EXAMPLE''

<syntaxhighlight lang=javascript>
// Request
{
    "command": "evaluate-backgorund",
    "arguments": 
    {
        "duration": 3,
        "startDelay": 1
    }
}

// Response
{
    "success": true
}

// Event 
{
    "event": "background-evaluation-stopped",
    "arguments":
    {
        "success": true,
        "cancelled": false
    }
}
</syntaxhighlight>

==== start-recording ====

''start-recording'' starts recording.

{{Tip|If parameter is not specified in command arguments, current value in user interface will be used.}}

<table class="wikitable" style="font-size: smaller; min-width: 50%">
<tr><th>Parameter Name</th><th>Type</th><th>Mandatory /<br>Optional</th><th>Allowed Values</th><th>Description</th></tr>
<tr><td colspan="5" style="background-color: white;">'''Arguments'''</td></tr>
<tr><td><tt>filePath</tt></td><td>string</td><td align=center>optional</td><td>Valid file path<td>
Full path to destination file for recording.
</td></tr>
<tr><td><tt>startDelay</tt></td><td>number</td><td align=center>optional</td><td>Integer number of seconds from 0 to 60<td>
Setting start delay for recording.
</td></tr>
<tr><td colspan="5" style="background-color: white;">'''Result'''</td></tr>
<tr><td colspan="5">''Empty result''</td></tr>
<tr><td colspan="5" style="background-color: white;">'''Events'''</td></tr>
<tr><td colspan="5">'''recording-stopped''' event is generated when recording is stopped</td></tr>
<tr><td><tt>success</tt></td><td>boolean</td><td align=center>mandatory</td><td><tt>true<br>false</tt></td>
<td>Success flag. Set to <tt>true</tt> if background evaluation was completed successfully.</td></tr>
<tr><td><tt>cancelled</tt></td><td>boolean</td><td align=center>mandatory</td><td><tt>true<br>false</tt></td>
<td>Cancellation flag. Set to <tt>true</tt> if background evaluation was cancelled by user or due to error.</td></tr>
<tr><td><tt>filePath</tt></td><td>string</td><td align=center>mandatory</td><td>Valid file path<td>
Full path to destination file.
</td></tr>
<tr><td><tt>fileSize</tt></td><td>number</td><td align=center>mandatory</td><td>Non-negative integer</td>
<td>Size of the recorded file in bytes.</td></tr>
<tr><td><tt>duration</tt></td><td>string</td><td align=center>mandatory</td><td>Timespan value in format<br><tt>hh:mm:ss.sssssss</tt><td>
Duration of the recording. 
</td></tr>
<tr><td><tt>frameCount</tt></td><td>number</td><td align=center>mandatory</td><td>Non-negative integer</td>
<td>Number of the recorded frames.</td></tr>
</table>
''EXAMPLE''

<syntaxhighlight lang=javascript>
// Request
{
    "command": "start-recording",
    "arguments": 
    {
        "filePath": "D:\iPiMocap\test_record.iPiVideo",
        "startDelay": 1
    }
}

// Response
{
    "success": true
}

// Event 
{
    "event": "recording-stopped",
    "arguments":
    {
        "success": true,
        "cancelled": false,
        "filePath": "D:\iPiMocap\test_record.iPiVideo",
        "fileSize": 39975560,
        "duration": "00:00:04.0155425",
        "frameCount": 197
    }
}
</syntaxhighlight>

==== stop-recording ====

''stop-recorder'' command stops recording.

<table class="wikitable" style="font-size: smaller; min-width: 50%">
<tr><th>Parameter Name</th><th>Type</th><th>Mandatory /<br>Optional</th><th>Allowed Values</th><th>Description</th></tr>
<tr><td colspan="5" style="background-color: white;">'''Arguments'''</td></tr>
<tr><td colspan="5">''No arguments''</td></tr>
<tr><td colspan="5" style="background-color: white;">'''Result'''</td></tr>
<tr><td colspan="5">''Empty result''</td></tr>
<tr><td colspan="5" style="background-color: white;">'''Events'''</td></tr>
<tr><td colspan="5">'''recording-stopped''' event is generated when recording is stopped</td></tr>
<tr><td><tt>success</tt></td><td>boolean</td><td align=center>mandatory</td><td><tt>true<br>false</tt></td>
<td>Success flag. Set to <tt>true</tt> if background evaluation was completed successfully.</td></tr>
<tr><td><tt>cancelled</tt></td><td>boolean</td><td align=center>mandatory</td><td><tt>true<br>false</tt></td>
<td>Cancellation flag. Set to <tt>true</tt> if background evaluation was cancelled by user or due to error.</td></tr>
<tr><td><tt>filePath</tt></td><td>string</td><td align=center>mandatory</td><td>Valid file path<td>
Full path to destination file.
</td></tr>
<tr><td><tt>fileSize</tt></td><td>number</td><td align=center>mandatory</td><td>Non-negative integer</td>
<td>Size of the recorded file in bytes.</td></tr>
<tr><td><tt>duration</tt></td><td>string</td><td align=center>mandatory</td><td>Timespan value in format<br><tt>hh:mm:ss.sssssss</tt><td>
Duration of the recording. 
</td></tr>
<tr><td><tt>frameCount</tt></td><td>number</td><td align=center>mandatory</td><td>Non-negative integer</td>
<td>Number of the recorded frames.</td></tr>
</table>
''EXAMPLE''

<syntaxhighlight lang=javascript>
// Request
{
    "command": "stop-recording"
}

// Response
{
    "success": true
}

// Event 
{
    "event": "recording-stopped",
    "arguments":
    {
        "success": true,
        "cancelled": false,
        "filePath": "D:\iPiMocap\test_record.iPiVideo",
        "fileSize": 39975560,
        "duration": "00:00:04.0155425",
        "frameCount": 197
    }
}
</syntaxhighlight>

==== get-devices-state ====

''get-devices-state'' returns the state and statistics for all selected devices.

{{Tip|This command is used to check camera status and statistics. You can call it before and after the recording.}}

<table class="wikitable" style="font-size: smaller; min-width: 50%">
<tr><th>Parameter Name</th><th>Type</th><th>Mandatory /<br>Optional</th><th>Allowed Values</th><th>Description</th></tr>
<tr><td colspan="5" style="background-color: white;">'''Arguments'''</td></tr>
<tr><td colspan="5">''No arguments''</td></tr>
<tr><td colspan="5" style="background-color: white;">'''Result'''</td></tr>
<tr><td colspan="5">Array of JSON objects, each representing selected device. Fields of array items:</td></tr>
<tr><td><tt>kind</tt></td><td>string</td><td align=center>mandatory</td><td><tt>camera</tt><br><tt>depth-sensor</tt><br><tt>microfon</tt></td>
<td>Device type.</td></tr>
<tr><td><tt>model</tt></td><td>string</td><td align=center>mandatory</td><td>Supported device model</td>
<td>Device model.</td></tr>
<tr><td><tt>id</tt></td><td>string</td><td align=center>mandatory</td><td>Unique string, format depends on device model</td>
<td>Unique string that is used to identify recording devices in ''open-recorder'' command.</td></tr>
<tr><td><tt>selected</tt></td><td>boolean</td><td align=center>mandatory</td><td><tt>true<br>false</tt></td>
<td>Device selected status.</td></tr>
<tr><td><tt>failed</tt></td><td>boolean</td><td align=center>mandatory</td><td><tt>true<br>false</tt></td>
<td>Device failed status.</td></tr>
<tr><td><tt>error</tt></td><td>string</td><td align=center>optional</td><td>Error message string</td>
<td>Error message if device is in failed status.</td></tr>
<tr><td><tt>statistics</tt></td><td>JSON object</td><td><center>optional</center></td><td>
<td>
Camera statistics.
</td></tr>
<tr><td style="padding-left: 40px;"><tt>frameRate</tt></td><td>number</td><td align=center>mandatory 
</td><td>Double</td><td>Average frame rate.</td></tr>
<tr><td style="padding-left: 40px;"><tt>frameDropsPerSecond</tt></td><td>number</td><td align=center>mandatory
</td><td>Double</td><td>Average frame drops per second.</td></tr>
<tr><td style="padding-left: 40px;"><tt>badFramesPerSecond</tt></td><td>number</td><td align=center>mandatory
</td><td>Double</td><td>Average bad frames per second.</td></tr>
<tr><td style="padding-left: 40px;"><tt>totalFrameDrops</tt></td><td>number</td><td align=center>mandatory
</td><td>Double</td><td>Total frame drops.</td></tr>
<tr><td style="padding-left: 40px;"><tt>totalBadFrames</tt></td><td>number</td><td align=center>mandatory
</td><td>Double</td><td>Total bad frames.</td></tr>
</table>
''EXAMPLE''

<syntaxhighlight lang=javascript>
// Request
{
    "command": "refresh-device-list"
}

// Response
{
    "success":true,
    "result":
    [
        {
            "kind": "camera",
            "model": "PlayStation Eye",
            "id": "\\\\?\\usb#vid_1415&pid_2000&mi_00#7&2ed872d7&0&0000#{4cff9941-d72f-4951-9291-03d8fc97fe30}",
            "selected": false,
            "failed": false,
            "statistics":
            {
                "frameRate":50.0,
                "frameDropsPerSecond":0.0,
                "badFramesPerSecond":0.0,
                "totalFrameDrops":0,
                "totalBadFrames":0
            }        
        },
        {
            "kind": "microphone",
            "model": "USB Camera-B4.04.27.1",
            "id": "Microphone (USB Camera-B4.04.27 [VID=-1; PID=-1; Driver=256; Channels=2; Supports=WAVE_FORMAT_11M08, ...]",
            "selected": false,
            "failed": false,
            "statistics":
            {
                "frameRate":50.0,
                "frameDropsPerSecond":0.0,
                "badFramesPerSecond":0.0,
                "totalFrameDrops":0,
                "totalBadFrames":0
            }        
        }
    ]
}
</syntaxhighlight>

==== get-recorder-props ====

''get-recorder-props'' command gets current properties for setup, background and recording stages specified in user interface.

<table class="wikitable" style="font-size: smaller;">
<tr><th>Parameter Name</th><th>Type</th><th>Mandatory /<br>Optional</th><th>Allowed Values</th><th>Description</th></tr>
<tr><td colspan="5" style="background-color: white;">'''Arguments'''</td></tr>
<tr><td colspan="5">''No arguments''</td></tr>
<tr><td colspan="5" style="background-color: white;">'''Result'''</td></tr>
<tr><td colspan="5">'''Properties for SETUP Stage:'''</td></tr>
<tr><td><tt>videoMode</tt></td><td>string</td><td align=center>mandatory</td><td>
Available modes depend on camera model. 
</td><td>
Selected RGB video mode.
</td></tr>
<tr><td><tt>videoModeList</tt></td><td>string array</td><td align=center>mandatory</td><td>
List of available modes depend on camera model. 
</td><td>
Possible <tt>videoMode</tt> values.
</td></tr>

<tr><td><tt>audioMode</tt></td><td>string</td><td align=center>optional</td><td>
Available modes depend on microphone model. 
</td><td>
Selected audio mode. This field is included into the response, if microphone selected.
</td></tr>
<tr><td><tt>audeoModeList</tt></td><td>string array</td><td align=center>optional</td><td>
List of available modes depend on camera model. 
</td><td>
Possible <tt>audioMode</tt> values. This field is included into the response, if microphone selected.
</td></tr>

<tr><td><tt>globalDeviceProps</tt></td><td>JSON object</td><td><center>optional</center></td><td>
<td>
Device-specific list of properties visible in “SHARED SETTINGS” section of SETUP stage.
</td></tr>
<tr><td style="padding-left: 40px;"><tt>PlayStation&nbsp;Eye:&nbsp;Darkening&nbsp;for&nbsp;Calibration</tt></td><td>string</td><td align=center>optional 
</td><td><tt>"None"</tt><br><tt>"Darkening"</tt><br><tt>"Extra Darkening"</tt></td><td>
Selected darkening mode for Sony PS3 Eye cameras. This field is included into the response, if Sony PS3 Eye camera is selected.
</td></tr>
<tr><td style="padding-left: 40px;"><tt>PlayStation&nbsp;Eye:&nbsp;Darkening&nbsp;for&nbsp;Calibration/List</tt></td><td>string array</td><td align=center>optional 
</td><td>List of available modes</td><td>
Available darkening modes for Sony PS3 Eye cameras. This field is included into the response, if Sony PS3 Eye camera is selected.
</td></tr>
<tr><td><tt>screensInRow</tt></td><td>number</td><td align=center>mandatory</td><td>Integer from 1 to number of cameras<td>
Selected number of screens in a row for multiple camera video view.
</td></tr>
<tr><td><tt>screenLayout</tt></td><td>string</td><td align=center>mandatory</td>
<td>
For RGB cameras:<br>
<tt>"Color"</tt><br><br>
For depth sensors:<br>
<tt>"Depth"</tt><br>
<tt>"Picture in picture"</tt><br>
<tt>"Side by side"</tt><br>
</td><td>
Selected screen layout. 
</td></tr>
<tr><td><tt>screenLayoutList</tt></td><td>string array</td><td align=center>mandatory</td>
<td>Available screenLayout modes.</td><td>Available screen layout modes. Depend on type of selected cameras.
</td></tr>
<tr><td colspan="5">'''Properties for BACKGROUND Stage:'''</td></tr>
<tr><td><tt>backgroundEvaluationDuration</tt></td><td>number</td><td align=center>mandatory</td><td>Integer number of seconds from 2 to 10<td>
Selected duration of background evaluation.
</td></tr>
<tr><td><tt>backgroundEvaluationStartDelay</tt></td><td>number</td><td align=center>mandatory</td><td>Integer number of seconds from 0 to 30<td>
Selected start delay for background evaluation.
</td></tr>
<tr><td><tt>showEvaluatedBackground</tt></td><td>boolean</td><td align=center>mandatory</td><td><tt>true<br>false</tt><td>
Selected show background mode.
</td></tr>
<tr><td colspan="5">'''Properties for RECORD Stage:'''</td></tr>
<tr><td><tt>recordingStartDelay</tt></td><td>number</td><td align=center>mandatory</td><td>Integer number of seconds from 0 to 60<td>
Selected start delay for recording.
</td></tr>
<tr><td><tt>hideBackgroundWhenRecording</tt></td><td>boolean</td><td align=center>mandatory</td><td><tt>true<br>false</tt><td>
Selected hide background mode.
</td></tr>
<tr><td><tt>destinationFilePath</tt></td><td>string</td><td align=center>mandatory</td><td>
Valid file path
</td><td>
Selected full path to destination file for recording.
</td></tr>
<tr><td><tt>colorCompression</tt></td><td>string</td><td align=center>mandatory</td><td>
<tt>"None"</tt><br>
<tt>"Background subtraction"</tt><br>
<tt>"JPEG"</tt>
</td><td>
Selected RGB video compression mode.
</td></tr>
<tr><td><tt>jpegQuality</tt></td><td>number</td><td align=center>mandatory</td><td>integer from 0 to 100</td><td>
Selected JPEG quality for JPEG compression.
</td></tr>
<tr><td><tt>depthCompression</tt></td><td>string</td><td align=center>mandatory</td><td><tt>"None"</tt><br><tt>"Background subtraction"</tt></td><td>
Selected depth compression mode.
</td></tr>
<tr><td colspan="5" style="background-color: white;">'''Result'''</td></tr>
<tr><td colspan="5">''Empty result''</td></tr>
</table>

''EXAMPLE''

<syntaxhighlight lang=javascript>
// Request
{
    "command": "get-recorder-props"
}

// Response
{
    "success": true,
    "result":
    {
        "videoMode": "640x480 color @ 50Hz",
        "videoModeList":
        [
            "640x480 color @ 60Hz",
            "640x480 color @ 50Hz",
            "640x480 color @ 40Hz",
            "640x480 color @ 30Hz",
            "640x480 color @ 25Hz",
            "320x240 color @ 60Hz",
            "320x240 color @ 50Hz",
            "320x240 color @ 37Hz",
            "320x240 color @ 30Hz"
        ],
        "screensInRow": 1,
        "screenLayout": "Color",
        "screenLayoutList":
        [
            "Color"
        ],
        "globalDeviceProps":
        {
            "PlayStation Eye: Darkening for Calibration": "None",
            "PlayStation Eye: Darkening for Calibration/List":
            [
                "None",
                "Darkening",
                "Extra Darkening"
            ]
        },
        "backgroundEvaluationStartDelay": 5,
        "backgroundEvaluationDuration": 2,
        "showEvaluatedBackground": false,
        "recordingStartDelay": 1,
        "hideBackgroundWhenRecording": true,
        "destinationFilePath": "D:\iPiMocap\<time stamp>.iPiVideo",
        "colorCompression":"Jpeg",
        "jpegQuality":100,
        "depthCompression":"BackgroundSubtraction"
    }

}
</syntaxhighlight>

==== 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. }}
<table class="wikitable" style="font-size: smaller;">
<tr><th>Parameter Name</th><th>Type</th><th>Mandatory /<br>Optional</th><th>Allowed Values</th><th>Description</th></tr>
<tr><td colspan="5" style="background-color: white;">'''Arguments'''</td></tr>
<tr><td colspan="5">'''Properties for SETUP Stage:'''</td></tr>
<tr><td><tt>videoMode</tt></td><td>string</td><td align=center>optional</td><td>
Available modes depend on camera model. 
</td><td>
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.
</td></tr>
<tr><td><tt>audioMode</tt></td><td>string</td><td align=center>optional</td><td>
Available modes depend on microphone model. 
</td><td>
Setting audio mode. You can see available modes in "Audio Mode" combobox at SETUP stage, or get it in the result of '''get-recorder-props''' command.
</td></tr>
<tr><td><tt>globalDeviceProps</tt></td><td>JSON object</td><td><center>optional</center></td><td>
<td>
Device-specific list of properties visible in “SHARED SETTINGS” section of SETUP stage.
</td></tr>
<tr><td style="padding-left: 40px;"><tt>PlayStation&nbsp;Eye:&nbsp;Darkening&nbsp;for&nbsp;Calibration''</tt></td><td>string</td><td align=center>optional 
</td><td><tt>"None"</tt><br><tt>"Darkening"</tt><br><tt>"Extra Darkening"</tt></td><td>
Darkening mode for Sony PS3 Eye cameras
</td></tr>
<tr><td><tt>screensInRow</tt></td><td>number</td><td align=center>optional</td><td>Integer from 1 to number of cameras<td>
Setting number of screens in a row for multiple camera video view.
</td></tr>
<tr><td><tt>screenLayout</tt></td><td>string</td><td align=center>optional</td>
<td>
For RGB cameras:<br>
<tt>"Color"</tt><br><br>
For depth sensors:<br>
<tt>"Depth"</tt><br>
<tt>"Picture in picture"</tt><br>
<tt>"Side by side"</tt><br>
</td><td>
Setting screen layout. 
</td></tr>
<tr><td colspan="5">'''Properties for BACKGROUND Stage:'''</td></tr>
<tr><td><tt>backgroundEvaluationDuration</tt></td><td>number</td><td align=center>optional</td><td>Integer number of seconds from 2 to 10<td>
Setting duration of background evaluation.
</td></tr>
<tr><td><tt>backgroundEvaluationStartDelay</tt></td><td>number</td><td align=center>optional</td><td>Integer number of seconds from 0 to 30<td>
Setting start delay for background evaluation.
</td></tr>
<tr><td><tt>showEvaluatedBackground</tt></td><td>boolean</td><td align=center>optional</td><td><tt>true<br>false</tt><td>
Show background mode on / off.
</td></tr>
<tr><td colspan="5">'''Properties for RECORD Stage:'''</td></tr>
<tr><td><tt>recordingStartDelay</tt></td><td>number</td><td align=center>optional</td><td>Integer number of seconds from 0 to 60<td>
Setting start delay for recording.
</td></tr>
<tr><td><tt>hideBackgroundWhenRecording</tt></td><td>boolean</td><td align=center>optional</td><td><tt>true<br>false</tt><td>
Show hide background mode on / off.
</td></tr>
<tr><td><tt>destinationFilePath</tt></td><td>string</td><td align=center>optional</td><td>
Valid file path
</td><td>
Full path to destination file for recording.
</td></tr>
<tr><td><tt>colorCompression</tt></td><td>string</td><td align=center>optional</td><td>
<tt>"None"</tt><br>
<tt>"Background subtraction"</tt><br>
<tt>"JPEG"</tt>
</td><td>
Setting RGB video compression mode.
</td></tr>
<tr><td><tt>jpegQuality</tt></td><td>number</td><td align=center>optional</td><td>integer from 0 to 100</td><td>
JPEG quality for JPEG compression.
</td></tr>
<tr><td><tt>depthCompression</tt></td><td>string</td><td align=center>optional</td><td><tt>"None"</tt><br><tt>"Background subtraction"</tt></td><td>
Setting depth compression mode.
</td></tr>
<tr><td colspan="5" style="background-color: white;">'''Result'''</td></tr>
<tr><td colspan="5">''Empty result''</td></tr>
</table>

''EXAMPLE''

<syntaxhighlight lang=javascript>
// 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
}
</syntaxhighlight>

=== Player Commands ===