Runtime Configuration¶

Tracking Control Settings¶

The tracking settings control the tracking data available to an application.

• tracking_hand_enabled : boolean

  Enables or disables hand tracking. Note that any hands in view will continue to be tracked until they are removed, but no new hands will be tracked.

  Since this setting is controlled by the user, you should ask for permission before changing its value.

  boolean isHandTrackingEnabled = controller.config().getBool("tracking_hand_enabled");
  if (!isHandTrackingEnabled) {
      // Show dialog to request permission to turn on hand tracking
      if(permissionGranted){
          controller.config().setBool("tracking_hand_enabled", true);
          controller.config().save();
      }
  }
  

• tracking_tool_enabled : boolean

  Enables or disables tool tracking.

  Since this setting is controlled by the user, you should ask for permission before changing its value.

  boolean isToolTrackingEnabled = controller.config().getBool("tracking_tool_enabled");
  if (!isToolTrackingEnabled) {
      // Show dialog to request permission to turn on tool tracking
      if(permissionGranted){
          controller.config().setBool("tracking_tool_enabled", true);
          controller.config().save();
      }
  }
  

• images_mode : integer

  Enables or disables tool tracking. Set to a value of 0 to disable images; set to a value of 2 to enable images.

  Since this setting is controlled by the user, you should ask for permission before changing its value.

  Note that applications must still invoke the image policy API at runtime to receive images. Simply enabling images on the service is not sufficient.

  boolean areImagesEnabled = controller.config().getInt32("tracking_images_mode") == 2;
  if (!areImagesEnabled) {
      // Show dialog to request permission to turn on images
      if(permissionGranted){
          controller.config().setInt32("tracking_images_mode", 2);
          controller.config().save();
      }
  }
  

• image_processing_auto_flip : boolean

  When enabled, the Leap Motion device can be used with either the long side of the device with the green LED facing toward or away from the user. The service detects the orientation and flips the images from the device before analyzing them. When disabled, the images are never flipped and tracking recognizes hands much better when the green LED side of the device is facing the user (or downward in a HMD mount).

  Since this setting is controlled by the user, you should ask for permission before changing its value.

  // read
  boolean autoFlip = controller.config().getBool("tracking_processing_auto_flip");
  
  // write
  controller.config().setBool("tracking_processing_auto_flip", false);
  controller.config().save();
  

Service Control Settings¶

The service control settings change how the Leap Motion service (Windows) or daemon (OS X and Linux) operate.

• robust_mode_enabled : boolean

  Robust mode improves tracking when excessive ambient IR light is present. However, it also lowers the framerate significantly. If the resulting framerate is too low, turning on robust mode might cause worse tracking performance than not enabling it in the first place.

  Robust mode can be enabled in the control panel and by setting the robust_mode_enabled configuration parameter. When enabled, the system enters robust mode when excessive ambient IR light is detected.

  Set this parameter to true to enable; false to disable.

  // read
  boolean robustMode = controller.config().getBool("robust_mode_enabled");
  
  // write
  controller.config().setBool("robust_mode_enabled", false);
  controller.config().save();
  

  Since this setting is controlled by the user, you should ask for permission before changing its value.

• avoid_poor_performance : boolean

  Since this setting is controlled by the user, you should ask for permission before changing its value.

  // read
  boolean avoidPoorPerformance = controller.config().getBool("avoid_poor_performance");
  
  // write
  controller.config().setBool("avoid_poor_performance", false);
  controller.config().save();
  

• background_app_mode arg : integer

  Determines whether applications can receive tracking data when not the focused, foreground application.

  Since this setting is controlled by the user, you should ask for permission before changing its value.

  boolean backgroundModeAllowed = controller.config().getInt32("background_app_mode") == 2;
  if (!backgroundModeAllowed) {
      // Show dialog to request permission to allow background mode apps
      if(permissionGranted){
          controller.config().setInt32("background_app_mode", 2);
          controller.config().save();
      }
  }
  

• cpu_affinity_mask arg : integer

  Processor affinity controls which CPU cores that a process will run on in a multi-core system. You can control the processor affinity of the Leap Motion service using the cpu_affinity_mask configuration parameter. This parameter takes an integer value that is converted into a bitmask that specifies which CPU cores the threads of the service will run on (i.e. 3, which is 0011 in binary, would specify that the threads will run on cores 1 and 2). A value of 0 means that the default OS-defined behavior is unchanged.

  The mask is passed to the Windows SetProcessorAffinityMask() API. This configuration parameter is not supported on other operating systems.

  Changes to this value only take affect when the service is restarted. Generally, it makes sense to set this value in the config.json file or on the command line to LeapSvc:

  {
    "configuration": {
      "cpu_affinity_mask": 1,
      "process_niceness": 6
    }
  }
  

• process_niceness arg : integer

  Thread priority controls the priority of threads spawned by the Leap Motion service. Thread priority is controlled by the process_niceness configuration parameter. Specifying 0 means that the OS default priority is assigined; a value of 1-9 assigns a specific priority (1 = lowest, 9 = highest).

  Changes to this value only take affect when the service is restarted. Generally, it makes sense to set this value in the config.json file or on the command line to LeapSvc. This setting is used on Windows only.

• no_cp_startup : boolean

  Detemines whether the Leap Motion Control panel application launches when the computer boots up. Set to true to suppress automatically launching the control panel; false (the default) to allow.

  // read
  boolean controlPanelOnStartup = controller.config().getBool("no_cp_startup");
  
  // write
  controller.config().setBool("no_cp_startup", false);
  controller.config().save();
  

• auto_check_updates : boolean

  Determines whether the Leap Motion service will automatically check for software updates.

  Since this setting is controlled by the user, you should ask for permission before changing its value.

  // read
  boolean autoUpdateCheck = controller.config().getBool("auto_check_updates");
  
  // write
  controller.config().setBool("auto_check_updates", false);
  controller.config().save();
  

• auto_install_updates : boolean

  Determines whether the Leap Motion service will automatically install software updates. the auto_check_updates setting must be true for the srvice to discover updates in the first place.

  // read
  boolean autoInstallUpdates = controller.config().getBool("auto_install_updates");
  
  // write
  controller.config().setBool("auto_install_updates", false);
  controller.config().save();
  

• show_tray_messages : boolean

  Allow notification area messages to be displayed by the service/daemon icon. Set true (the default) to allow; false to supress messages.

  This setting should only be used on computers you control.

  // read
  boolean showNotifications = controller.config().getBool("show_tray_messages");
  
  // write
  controller.config().setBool("show_tray_messages", false);
  controller.config().save();
  

• metrics_enabled : boolean

  Allows metric collection.

  This setting should only be used on computers you control.

  // read
  boolean enableMetrics = controller.config().getBool("metrics_enabled");
  
  // write
  controller.config().setBool("metrics_enabled", false);
  controller.config().save();
  

{
  "configuration": {
    "websockets_enabled": true,
    "websockets_allow_remote": false,
    "ws_port": 51000,
    "wss_port": 51001
  }
}

Feature Control Settings¶

Two sets of configuration settings control how individual tracking features operate.

Setting Configuration Options¶

Configuration prameters can be set on the command line when invoking the Leap Motion service/daemon executable, (LeapSvc on Windows and leapd on OS X and Linux), in a configuration file, and in application code using the Leap Motion API.

* Windows::

* Windows::

{
  "configuration": {
    "cpu_affinity_mask": 3,
    "images_mode": 2,
    "power_saving_adapter": false,
    "power_saving_battery": false,
    "process_niceness": 5,
    "robust_mode_enabled": false,
    "tracking_hand_enabled": true
  }
}