LSL Streamer Element

Modified on 2023/05/17 10:26 by Administrator Categorized as Elements, Signal Processing
<div style="margin-right: 10px; margin-left: 16px; margin-bottom:10px; float: right; width: 500px; overflow: hidden; height: auto; padding: 0px; background: #fafafa; background: -webkit-gradient(linear, left top, left bottom, from(#fbfbfb), to(#fafafa));background: -moz-linear-gradient(top, #fbfbfb, #fafafa);border: 1px dashed #ddd;box-shadow: 0 0 0 3px #fff, 0 0 0 5px #ddd, 0 0 0 10px #fff, 0 0 2px 10px #eee;">
== Summary ==
{s:Element Info Panel
| title=LSL Streamer
| category=Visual Stimuli
| icon=[image|Element Icon|{UP(LSL-Streamer-Element)}LSL-Streamer-Element-Icon.png]
| author= OkazoLab
| addin= LSL
| scope= Experiment
| usage= background
| ownsnippets= None
}
== Properties ==
{|
|-
! Name
! Description                              
! Constraints
! Type
! On<br/>runtime<br/>change
|-
| colspan="5" bgcolor="#AADDDDD" | Control 
|-
| Is Enabled        
| If set to false the element is completely omitted when the experiment is run        
| {s:atDesign}        
| Boolean        
|  
|-
| Title        
| Title of the element        
| {s:atDesign}        
| String        
|  
|-
| colspan="5" bgcolor="#AADDDDD" | LSL Settings 
|-
| Stream Name        
| Defines a name of LSL stream forwarding the selected signals        
| {s:atDesign}        
| String        
|  
|-
| Stream Type        
| Defines as type of the LSL stream        
| {s:atDesign}        
| String        
|  
|-
| Data Format        
| Defines as type of the LSL stream        
| {s:atDesign}        
| String        
|  
|-
| Create Stream Now        
| Pre-creates a LSL stream with the current settings before an experiment is started        
| {s:atRuntimeAction}        
| Boolean        
|  
|-
| colspan="5" bgcolor="#AADDDDD" | Settings 
|-
| Input Channels        
| Defines input channels for processing        
| {s:atNormal}        
| IList        
|  
|-
| Buffer Size        
| Defines the size (in samples) of the element's processing buffer        
| {s:atDesign}        
| 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        
| {s:atDesign}        
| Double        
|  
|-
| Resampling Method        
| Defines the interpolation method for resampling the input signals of different sampling rates        
| {s:atDesign}        
| Int32        
|  
|-
| Chunk Size        
| Defines a size of the processing blocks (chunks) in samples. The value must not be greater than the buffer size.        
| {s:atDesign}        
| Int32        
|  
|-
| colspan="5" bgcolor="#AADDDDD" | 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)        
| {s:atNormal}        
| Boolean        
|  
|-
| colspan="5" bgcolor="#AADDDDD" | 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        
| {s:atDesign}        
| Boolean        
|  
|-
| colspan="5" bgcolor="#AADDDDD" | 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.        
| {s:atDesign}        
| List`1        
|  
|-            
|} 
== ==
</div>
<!--*****************************************************************************************************************************************************************************-->
<!--*****************************************************************************************************************************************************************************-->
<!--*****************************************************************************************************************************************************************************-->
<!--*****************************************************************************************************************************************************************************-->
<!--*****************************************************************************************************************************************************************************-->
<!--*****************************************************************************************************************************************************************************-->
<!--*****************************************************************************************************************************************************************************-->
<!--*****************************************************************************************************************************************************************************-->
<!--*****************************************************************************************************************************************************************************-->
<!--*****************************************************************************************************************************************************************************-->
<!--*****************************************************************************************************************************************************************************-->
<!--*****************************************************************************************************************************************************************************-->
<!--*****************************************************************************************************************************************************************************-->
<!--*****************************************************************************************************************************************************************************-->
This LSL Streamer element forwards selected EventIDE signals into an outgoing LSL stream.
{TOC}
== 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 [^https://labstreaminglayer.org/#/|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 ===
# Create the LSL streamer element and select it in the Global element panel 
# Define '''Stream Name''', '''Stream Type''' and '''Data Format''' properties of the element
# Select signal that have to be forwarded via '''Input Channels''' property 
# Define '''Output Sampling Rate''', which can be either the same or different to the sampling rates of the input channels
# Run an experiment and __then__ connect an external app to the generated LSL stream

== Notes ==
* You can use multiple LSL Streamer elements in the same experiment, given that they have different stream names.
* The input channels may have different sampling rates, however, they will be automatically resampled to the value of  '''Output Sampling Rate'' 
* Sample timestamps in the generated LSL stream represent the experiment time
Meta Keywords: element, LSL
Meta Description:
Change Comment:
EventIDE Wiki

Navigation¶

LSL Streamer Element
