LSL Export

Summary

Doc_BoxAlgorithm_LSLExport.png
  • Plugin name : LSL Export
  • Version : 0.1
  • Author : Jussi T. Lindgren
  • Company : Inria
  • Short description : Send input stream out via LabStreamingLayer (LSL)
  • Documentation template generation date : Apr 30 2021

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. Each stream will get a randomized source ID (in 64bit hex).

The stimulations and signals output by the box are timestamped with LSL clock by default. If you would like them to be timestamped with local OpenViBE time, you can add the following line to the configuration file "openvibe.conf":

LSL_UseOVTimestamps = True

Inputs

1. Input signal

The stimulation input stream.

  • Type identifier : Signal (0x5ba36127, 0x195feae1)

2. Input stimulations

  • Type identifier : Stimulations (0x6f752dd0, 0x082a321e)

Settings

1. Signal stream

Name of the signal stream. Default is 'openvibeSignal'.

  • Type identifier : String (0x79a9edeb, 0x245d83fc)
  • Default value : [ openvibeSignal ]

2. Marker stream

Name of the stimulation stream. Default is 'openvibeMarkers'.

  • Type identifier : String (0x79a9edeb, 0x245d83fc)
  • Default value : [ openvibeMarkers ]

Examples

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.

Miscellaneous

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 float. The marker stream is noncontinuous int, and each 64bit OpenViBE stimulation is truncated to an int marker.

This box should be compatible with the conventions used by OpenViBE Acquisition Server LabStreamingLayer (LSL) Driver, as well as its' LSL Output plugin.