You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

Doc_BoxAlgorithm_KeypressEmulator.dox-part 2.8KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758
  1. /**
  2. * \page BoxAlgorithm_KeypressEmulator Keypress Emulator
  3. __________________________________________________________________
  4. Detailed description
  5. __________________________________________________________________
  6. * |OVP_DocBegin_BoxAlgorithm_KeypressEmulator_Description|
  7. Emulates a keyboard keypress when receiving a specific stimulation. In principle this box could be used to drive some 3rd party application that allows keyboard control but not any other communication from OpenViBE. Currently this box is implemented only on Windows.
  8. * |OVP_DocEnd_BoxAlgorithm_KeypressEmulator_Description|
  9. __________________________________________________________________
  10. Inputs description
  11. __________________________________________________________________
  12. * |OVP_DocBegin_BoxAlgorithm_KeypressEmulator_Inputs|
  13. * |OVP_DocEnd_BoxAlgorithm_KeypressEmulator_Inputs|
  14. * |OVP_DocBegin_BoxAlgorithm_KeypressEmulator_Input1|
  15. Stimulation stream to listen to.
  16. * |OVP_DocEnd_BoxAlgorithm_KeypressEmulator_Input1|
  17. __________________________________________________________________
  18. Settings description
  19. __________________________________________________________________
  20. * |OVP_DocBegin_BoxAlgorithm_KeypressEmulator_Settings|
  21. * |OVP_DocEnd_BoxAlgorithm_KeypressEmulator_Settings|
  22. * |OVP_DocBegin_BoxAlgorithm_KeypressEmulator_Setting1|
  23. The stimulation that will trigger the keypress.
  24. * |OVP_DocEnd_BoxAlgorithm_KeypressEmulator_Setting1|
  25. * |OVP_DocBegin_BoxAlgorithm_KeypressEmulator_Setting2|
  26. The key to press.
  27. * |OVP_DocEnd_BoxAlgorithm_KeypressEmulator_Setting2|
  28. * |OVP_DocBegin_BoxAlgorithm_KeypressEmulator_Setting3|
  29. The key modifier (alt, ctrl, ...)
  30. * |OVP_DocEnd_BoxAlgorithm_KeypressEmulator_Setting3|
  31. __________________________________________________________________
  32. Examples description
  33. __________________________________________________________________
  34. * |OVP_DocBegin_BoxAlgorithm_KeypressEmulator_Examples|
  35. An easy way to test the box is to make it receive stimulations from a Clock Stimulator box, and make a text editor active on the desktop after clicking Play. The characters corresponding to the key should appear in the editor.
  36. * |OVP_DocEnd_BoxAlgorithm_KeypressEmulator_Examples|
  37. __________________________________________________________________
  38. Miscellaneous description
  39. __________________________________________________________________
  40. * |OVP_DocBegin_BoxAlgorithm_KeypressEmulator_Miscellaneous|
  41. The Keypress Emulator should be enhanced to be able to map an arbitrary number of different stimulations. This development would be relatively straightforward (e.g. look at VRPN boxes for example). Meanwhile if you need several keys pressed, you can use several Keypress Emulator boxes, each configured for a different stimulation+key.
  42. * |OVP_DocEnd_BoxAlgorithm_KeypressEmulator_Miscellaneous|
  43. */