Skip to content

XKeys

Jump to bottom
Jerzy Jaśkiewicz edited this page Oct 16, 2022 · 3 revisions

Description

This plugin adds support for following XKeys controllers:

The plugin configuration allows to assign user interface functions to specific keys.

User interface

The plugin is installed at client side. Most key commands are sent directly to application (regardless if it's have keyboard focus or not), but it's also possible to emulate Windows keys.

Plugin files

  • Plugins\TAS.Client.XKeys.dll - the plugin
  • Plugins\PIEHid64Net.dll - vendor provided communications library
  • Configuration\XKeys.xml - configuration file

Configuration

See the configuration file. Set EngineName to actual engine name as set in "Rundown Engines" in TVPlay.config and UnitId as set in XKeys configuration program. Commands can be executed on Press or Release. Possible targets are:

  • Engine - can execute commands on the engine, with method names according to ICommand names defined in IUiEngine.cs
  • Preview - method names are defined in IUiPreview.cs
  • SelectedEvent - there are two toggle commands: IsHold and IsEnabled that toggles the properties and saves the selected event immediatelly.
  • Keyboard - executes KeyGesture specified in Method property

Each command can be restricted to work only when another key is pressed (a modifier key, like Alt or Control on normal keyboard). It's purpose of Required property.

It's also possible to set keys backlight color according to engine state. See Backlights key of configuration file.

Home

Plugins

Clone this wiki locally