Weberni69795
/
BCIgui
Watch 1
Star 0
Fork 0
Code Issues 0 Pull Requests 0 Releases 0 Wiki Activity
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.
7 Commits
3 Branches
Tree: 249fa25357
Branches Tags
${ item.name }
Create branch ${ searchTerm }
from '249fa25357'
${ noResults }
BCIgui/Masterarbeit/openvibe/extras-master/plugins/processing/games/doc/Doc_BoxAlgorithm_HelloWorld...

Doc_BoxAlgorithm_HelloWorldGames.dox-part 3.0KB
Raw Blame History

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364 
  1. /**

  2.  * \page BoxAlgorithm_HelloWorldGames Hello World Games

  3. __________________________________________________________________

  4. 

  5. Detailed description

  6. __________________________________________________________________

  7. 

  8.  * |OVP_DocBegin_BoxAlgorithm_HelloWorldGames_Description|

  9. This box forwards the signals and stimulations it gets to two corresponding LabStreamingLayer (LSL) streams. 

  10. 

  11. This stream can be read by the Unity Games Hello World here : https://gitlab.inria.fr/openvibe/unity-games/hello-world

  12. 

  13. Remarks : It is currently impossible to send and receive information by LSL in the same scenario. 

  14. Indeed, the LSL library waits to receive its flow (or gives up) before moving on. In addition, OpenViBE is not multi-process. 

  15. It blocks until it has received its flow (or gives up).

  16. It is therefore advisable to launch the transmitter before the receiver.

  17. Or plan for a shorter but repeated stream search after launch in the event of a startup failure.

  18. 

  19.  * |OVP_DocEnd_BoxAlgorithm_HelloWorldGames_Description|

  20. __________________________________________________________________

  21. 

  22. Inputs description

  23. __________________________________________________________________

  24. 

  25.  * |OVP_DocBegin_BoxAlgorithm_HelloWorldGames_Inputs|

  26.  * |OVP_DocEnd_BoxAlgorithm_HelloWorldGames_Inputs|

  27.  *

  28.  * |OVP_DocBegin_BoxAlgorithm_HelloWorldGames_Input1|

  29. The signal input stream.

  30.  * |OVP_DocEnd_BoxAlgorithm_HelloWorldGames_Input1|

  31.  

  32.  * |OVP_DocBegin_BoxAlgorithm_HelloWorldGames_Input2|

  33. The stimulation input stream.

  34.  * |OVP_DocEnd_BoxAlgorithm_HelloWorldGames_Input2|

  35.  

  36. __________________________________________________________________

  37. 

  38. Settings description

  39. __________________________________________________________________

  40. 

  41.  * |OVP_DocBegin_BoxAlgorithm_HelloWorldGames_Settings|

  42.  * |OVP_DocEnd_BoxAlgorithm_HelloWorldGames_Settings|

  43.  *

  44. __________________________________________________________________

  45. 

  46. Examples description

  47. __________________________________________________________________

  48. 

  49.  * |OVP_DocBegin_BoxAlgorithm_HelloWorldGames_Examples|

  50. Easiest way to test the box is to use a time signal box with a simple DSP sin(x) and a Clock Stimulation with stimulation `OVTK_StimulationId_Label_00`. Run the Scenario, next run the Game.

  51.  * |OVP_DocEnd_BoxAlgorithm_HelloWorldGames_Examples|

  52. __________________________________________________________________

  53. 

  54. Miscellaneous description

  55. __________________________________________________________________

  56. 

  57.  * |OVP_DocBegin_BoxAlgorithm_HelloWorldGames_Miscellaneous|

  58. The box creates each LSL stream at the beginning of the playback, after it has received its corresponding OpenViBE stream header information. Hence, if either signal or stimulus socket 

  59. of the box is not connected or does not receive a header, the box will not create the corresponding LSL stream.

  60. 

  61. Stream formats: The signal stream is continuous float. The stimulation stream is noncontinuous int, and each 64bit OpenViBE stimulation is truncated to an int marker.

  62. 

  63.  * |OVP_DocEnd_BoxAlgorithm_HelloWorldGames_Miscellaneous|

  64.  */