iPi Recorder User's Guide

From iPi Docs
Revision as of 11:24, 26 April 2016 by Vmaslov (Talk | contribs)

Jump to: navigation, search
Note.png
Note: This article is under construction and will be published in a few days. Meanwhile refer to v2 documentation: http://wiki.ipisoft.com/IPi_Recorder_User%27s_Guide

General UI Layout

UI Layout

iPi Recorder's user interface consists of several views which are used to perform different activities. The most important views include:

  • Home. Starting screen which provides access to all functions of the program.
  • Setup. Adjust device settings before recording.
  • Background. Evaluate background before recording.
  • Record. Set recording options and start recording.
  • Recording. Displays recording statistics.
  • Play. Playback of iPiVideo files.
  • Edit. Editing of iPiVideo files and export to AVI format.

You can switch between views by executing specific commands, like opening recent video from the Home view, or using the tabs at the top (2) when there are several related views like Setup, Background and Record. Most of the views allow you to return to the starting screen by pressing the Home button (1) at the top-left.


Below tabs there is a ribbon, or a big toolbar (3) that contains commands and settings relevant to the current view. The ribbon can be collapsed to make more room for view contents.


Many views contain a grid of screens, each displaying data from an individual device. For instance, video frames from a camera or 3D orientation of motion controller. When you hover over a device screen with a mouse, some controls and information specific to this device are displayed in an overlay (4). For example, a button to display this device screen in a full screen mode.

Home View

Home View

You start on the Home view each time you run iPi Recorder.

Most part of the view is occupied by a list of devices available for recording. This includes color cameras, depth sensors, motion controllers and microphones (audio sources). Each device has status string below its model name, and normally it is Ready. If there is a problem with specific device, its status contains error description and has red background.

DEVICES group in the ribbon contains commands related to this list:

  • Refresh allows the program to discover newly connected devices without restarting.
  • Add Controller makes a connection between motion controllers and PC.
  • Camera Types shows whether specific camera types are supported on this system, and what should be done to add this support.

To begin with recording, select devices to use by clicking on items in the list. Selected items are highlighted with the orange background.

When selected all needed devices, press Record Video button. It doesn't start recording immediately, but brings you to views serving the recording workflow.

Note.png
Note: Be aware that not all devices can be used together. For example, color cameras and depth sensors can't be combined, and you can select only one microphone at a time.
Tip.png
Tip: The program remembers your last selection. Thus, if you have not disconnected devices since the last run, the selection will most probably restore automatically.


On the right there is a list of recently recorded or played videos. Just click on an item to open this video for playback and/or editing. You can also press the Browse button to select a file to open with the file dialog.

Recording Workflow

Editing and Export

Additional Resources

Recording with motion controllers

Distributed Recording