LSL Streamer Element

Modified on 2023/05/17 10:26 by Administrator — Categorized as: Elements, Signal Processing

Summary

Element Icon LSL Streamer
Info
Category: Visual Stimuli AddIn: LSL
Creator: OkazoLab Scope: Experiment
Owns Snippets: None Usage: background

Properties

NameDescription                              ConstraintsTypeOn
runtime
change
Control 
Is Enabled        If set to false the element is completely omitted when the experiment is run        
Design Time..
        		Boolean         
Title        Title of the element        
Design Time..
        		String         
LSL Settings 
Stream Name        Defines a name of LSL stream forwarding the selected signals        
Design Time..
        		String         
Stream Type        Defines as type of the LSL stream        
Design Time..
        		String         
Data Format        Defines as type of the LSL stream        
Design Time..
        		String         
Create Stream Now        Pre-creates a LSL stream with the current settings before an experiment is started        
Runtime Command..
        		Boolean         
Settings 
Input Channels        Defines input channels for processing        
Normal..
        		IList         
Buffer Size        Defines the size (in samples) of the element's processing buffer        
Design Time..
        		Int32         
Output Sampling Rate        Defines the sampling rate of processing performed by this element, in Hz. If the input channels have different sampling rates, the input signal will be re-sampled to the chosen rate        
Design Time..
        		Double         
Resampling Method        Defines the interpolation method for resampling the input signals of different sampling rates        
Design Time..
        		Int32         
Chunk Size        Defines a size of the processing blocks (chunks) in samples. The value must not be greater than the buffer size.        
Design Time..
        		Int32         
Runtime Status 
Is Running        Defines whether the element is processing data. You can use this property to pause the signal processing at any time (e.g. for a sake of performance)        
Normal..
        		Boolean         
Signal Generator 
Signal Generator        Defines whether signal samples are produces by an oscillatory generator rather than the actual hardware. You can use the signal generator for test runs without hardware        
Design Time..
        		Boolean         
Channel Configuration 
Selected Channels        Defines what signal channels are selected for acquisition within EventIDE. Selected channels are registered in the EventIDE signal pool at runtime and become available for the signal analysis elements.        
Design Time..
        		List`1         
 

This LSL Streamer element forwards selected EventIDE signals into an outgoing LSL stream.

Description

EventIDE can read and process data signals from a broad range of research hardware. In addition to that, custom signals can be generated within EventIDE to carry user data. Use the LSL streamer element to forward such signals to external applications that run in a network or on the same computer. The element uses the LSL protocol and fully compatible with its specifications.    

Practical Use

The LSL streamer element is the global element meaning that it works for the entire duration of an experiment. The element works at the background and configuring is for automatic work is very straightforward.

Creating and configuring the element

  1. Create the LSL streamer element and select it in the Global element panel
  2. Define Stream Name, Stream Type and Data Format properties of the element
  3. Select signal that have to be forwarded via Input Channels property
  4. Define Output Sampling Rate, which can be either the same or different to the sampling rates of the input channels
  5. Run an experiment and then connect an external app to the generated LSL stream

Notes