Documentation: Preferences


#1

NI mate preferences can be accessed by pressing the “Preferences” link at the bottom left of the UI.

Crash logging

The crash logging page gives access to the Delicode Crash Reporter which allows sending crash reports to our support team. If you experience a crash and are unable to send the report after the crash reporter automatically opens, you can go to preferences and review your old crashes.

General

  • Sync frames: When outputting data over OSC, with this mode enabled NI mate will send out a special OSC message every frame. This can be used to coordinate receiving data in an external program. Our official plugins use this feature to minimize the amount of redundant data being processed.

  • Use GPU transfer: If enabled, NI mate will use the graphics card to transfer live feeds from the sensor device into the NI mate main process. Using the GPU texture transfer offers a significant boost to performance. This feature requires that your graphics card has the required NV_DX_interop extension available. If you experience a crash, the first step you should do is unplug your sensor, start NI mate, uncheck this option and restart NI mate.

  • Send anonymous usage statistics: If enabled, NI mate will send anonymous information about how NI mate is used to our development team. This helps us develop NI mate and focus on the areas that are most used.

  • Allow sensor tilt: If enabled, the XBox 360 Kinect sensors are allowed to use the tilt feature. This option is disabled by default as the tilt feature can potentially cause permanent damage to your sensor. The problem is that the sensor’s tilt motor attempts to apply the given tilt angle without considering its current facing. This can result in the sensor attempting to force its tilt motor into an impossible angle, potentially breaking the motor.

  • Project folder: This folder is used by NI mate for storing project settings, recordings and crash reports.

Language

This page can be used for changing the language NI mate is currently using.

Live feeds

NI mate hosts two live feed servers. On Windows, Spout is used. On OS X, Syphon is used. These feeds display the currently selected live feed for your sensor. For optimal performance you should have the GPU texture transfer enabled when using the live feeds.

If you experience performance issues with NI mate, try disabling the live feeds as they can be quite resource intensive.

MIDI output

In order to use MIDI output in NI mate you will have to specify some kind of MIDI outputs.

  • Rescan: Scan the computer for new MIDI ports.

  • Name: This name will be displayed in the various MIDI output selection boxes in NI mate.

  • Port: This is the MIDI port where data will be sent to. Most of the times this is some MIDI device plugged into your computer or a virtual MIDI port for some music software.

  • Channel: The channel in the selected port where the MIDI messages are transmitted to.

  • Limit: If checked, NI mate will limit the quantity of MIDI messages being outputted. In some cases the amount of messages might be larger than the receiving capacity of the chosen MIDI port.

OpenNI 2 settings

  • Default to USB 3 mode: If you’re using a OpenNI 2 sensor (Asus Xtion, PrimeSense Carmine) with the USB 3 firmware patch applied, then this option can be checked to always start the sensors with the assumption that they’re connected to a USB 3 port.

OSC input

NI mate can be controlled by sending OSC messages into it. This requires the OSC input to be enabled and set to the correct port. The following messages are currently understood by NI mate:

  • quit or q: Closes NI mate

  • load or l followed by a string in the same parameter: Loads a project with the given filename.

  • import or i followed by a string in the same parameter: Loads a project outside the NI mate project folder.

  • enable followed by the component name: Enables some component for all sensors. The component names are:

    • skeleton
    • controller
    • face_analysis
    • triggers
    • face_shapes
  • disable followed by the component name. Disables some component for all sensors.

  • ping: Prints a single test message in the log window.

Startup

  • Hide to tray: When NI mate starts, if this option is checked NI mate control interface won’t be shown. NI mate can then be accessed by using the tray icon menu.

  • Show splash screen: If toggled, displays the splash screen during startup.

  • Kiosk mode: Sets NI mate into the kiosk mode with settings customized to work well in installations or presentations. The effects are as follows:

    • No pop-ups are displayed
    • On startup, NI mate always tries to restore previous projects
    • Closing the window hides NI mate to tray instead of closing the software.
    • Attempting to close NI mate with unsaved changes results in NI mate not closing.
    • Windows hotkey “Alt + Ctrl + N” brings the NI mate control interface to front
    • NI mate does not check for updates

System information

This window displays information about your system that may be useful to us when handling problem reports. Please include this information when reporting a problem.


Documentation: Table of contents