Navigation¶

• Main Page
• Random Page
• Create a new Page
• All Pages
• Categories
• Navigation Paths
  

• Administration
• File Management
  

• Create Account
  

Search the wiki

Key Logger Element

Key Logger Element saliently registers and logs all button presses and releases made within the parent event.

Table of Contents [Hide/Show] Summary Properties Description Practical Use     Deploying the Key Logger element     Saving the recorded key log into Data Report Notes

Description ¶

Use the Key Logger element, when you want to record all button events over a certain period in an experiment. The Key Logger elements carries logging saliently, so if you plan to handle button responses at run-time, you may prefer use either Button or HID input elements instead. The Key Logger element creates an internal text log, in which each record denotes a button event. The record is composed of 3 columns: time, button name and button state. Here is an example of the key log that recorded a press and subsequent release of the Space button.

Time (ms)	Button name	Button State (1-down,0-up)	Custom Columns
1034	Space	1	Event1
1472	Space	0	Event2

The column values are separated with a delimiter character that is defined by the Column Delimiter property. By default, a line break is added to the end of each record. The recorded log can be accessed by the Key Log property that returns a current log content as a single string.

Practical Use ¶

Deploying the Key Logger element ¶

1. Select the event in your experiment, in which you want to log all button presses and releases.
2. Add the Key Logger element to that event
3. Browse the button element properties in the property panel
4. Select the Input Device, for example, the system keyboard
5. Think of how you are going save the recorded key log (one example is given in the next section)
   

Saving the recorded key log into Data Report ¶

1. Add the Key Logger element to a event
2. Browse the button element properties in the property panel
3. Select the Input Device, for example, the system keyboard
4. Create a proxy variable linked to the Key Log property
5. Open the After Offset snippet of the parent event
6. Add the following code to the snippet:
   

Report=KeyLog; // send the recorded key log into the data report

Notes ¶

• The Key Logger works only with the primary input devices
• The Key Logger can read only one input device
• You can use multiple key logger elements in the same time, for example, for parallel logging of the keyboard and mouse buttons
• Content of the key log is automatically cleared on every onset of the parent event
• Key Logger element uses the DirectX button name convention, the same as in the Button element
  
  

	Name	Size
	Key-Logger-Element-Icon.png	3.75 KB
	KeyLoggerIcon.png	7.00 KB