Commit d8a77457 authored by Jussi Lindgren's avatar Jussi Lindgren

Plugins: Updated LSL Export box documentation

parent 2bbe804c
......@@ -8,7 +8,7 @@ __________________________________________________________________
* |OVP_DocBegin_BoxAlgorithm_LSLExport_Description|
This box forwards the signals and stimulations it gets to two corresponding LabStreamingLayer (LSL) streams.
The user can configure the names of the LSL streams, and set an unique identifier for the two (shared).
The user can configure the names of the LSL streams. Each stream will get a randomized source ID (in 64bit hex).
* |OVP_DocEnd_BoxAlgorithm_LSLExport_Description|
__________________________________________________________________
......@@ -42,18 +42,14 @@ Name of the signal stream. Default is 'openvibeSignal'.
* |OVP_DocBegin_BoxAlgorithm_LSLExport_Setting2|
Name of the stimulation stream. Default is 'openvibeMarkers'.
* |OVP_DocEnd_BoxAlgorithm_LSLExport_Setting2|
*
* |OVP_DocBegin_BoxAlgorithm_LSLExport_Setting3|
The unique identifier for the two. Default is 654321.
* |OVP_DocEnd_BoxAlgorithm_LSLExport_Setting3|
*
__________________________________________________________________
Examples description
__________________________________________________________________
* |OVP_DocBegin_BoxAlgorithm_LSLExport_Examples|
Easiest way to test the box is to use one Acquisition Server LabStreamingLayer (LSL) driver to read from it. First, send data to the box. Then connect to it using AS. Start AS playback. In another Designer tab, use the Network Acquisition box to read from the Acquisition Server.
Easiest way to test the box is to use the Acquisition Server (AS) LabStreamingLayer (LSL) driver to read from the box. First, send signal to the box. Then connect to it using AS. Start AS playback. In another Designer tab, use the Network Acquisition box to read the data back from the Acquisition Server.
* |OVP_DocEnd_BoxAlgorithm_LSLExport_Examples|
__________________________________________________________________
......@@ -61,10 +57,10 @@ Miscellaneous description
__________________________________________________________________
* |OVP_DocBegin_BoxAlgorithm_LSLExport_Miscellaneous|
The box only creates each LSL stream during playback, after it has received its corresponding OpenViBE stream header information. Hence, if either signal or stimulus socket
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
of the box is not connected or does not receive a header, the box will not create the corresponding LSL stream.
Stream formats: The signal stream is continuous float32. The marker stream is noncontinuous, and each 64bit OpenViBE stimulation is truncated to an int32 marker.
Stream formats: The signal stream is continuous float32. The marker stream is noncontinuous int32, and each 64bit OpenViBE stimulation is truncated to an int32 marker.
This box should be compatible with the conventions used by OpenViBE Acquisition Server LabStreamingLayer (LSL) Driver, as well as its' LSL Output plugin.
* |OVP_DocEnd_BoxAlgorithm_LSLExport_Miscellaneous|
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment