Page History: LSL Video element

Compare Page Revisions

« Older Revision - Back to Page History - Newer Revision »

Page Revision: 2023/05/22 05:41

Summary ¶

	LSL Video
Info
Category:	Visual Stimuli	AddIn:	LSL
Creator:	OkazoLab	Scope:	Parent event
Owns Snippets:	None	Usage:	Stimulus screen

Properties ¶

Name	Description	Constraints	Type
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
Visual Appearance
Pivot Point	Defines alignment of the pivot point (or, element's position) relative to element's rendering area. The pivot point sets the center of element's rotation and scale directions.	Normal..	stAlig..
Position	Defines a position of the rendering viewport on the screen	Normal..	clPoint
Size	Defines a size of the element's rendering viewport on the screen	Normal..	clSize
Alpha Masking	Defines, whether the visual content is used to create an opacity mask on the event surface. If masking is on, the content's pixel luminance (or, its inverse) defines transparency within element's viewport. The alpha masking allows, for example, create transparent holes on the event surface.	Design Time..	Int32
AntiAliasing	if true, the rendered content will be antialiased for smoother visual appeariance. If false, rendering will be authentic to its source, e.g. a bitmap.	Normal..	Boolean
Z Order	Indicates Z Order of the element on the given event	Status..	Int32
Visible	Defines whether the element is visible	Normal..	Boolean
Rotation	Rotation angle in degrees	Normal..	Double
LSL Settings
Stream Type	Defines the LSL stream that delivers signal data	Design Time..	String
LSL Stream	Defines which LSL stream will be connected at runtime. You must have the LSL stream running, when you change this property for the first time. Note that the channel configuration of the element is updated each time as you change this property	Design Time..	String
Chink Size	Defines the chuck size (in ms) in signal acquisition	Normal..	clTime
Effects
Transparent Color	The color of the original pixels of rendered content that will be set as transparent	Normal..	stColor
Transparent Tolerance	Tolerance ratio for choosing colors that become transparent. Zero means that effect is not applied, 1 denotes that all colors will become trasparent	Normal..	Int32
Color Mask	Produces a multiplicative combination of the original pixels and the selected mask color (except the alpha channel). The effect emulates a look through a colored glass. White or transparent mask color dont change the original pixels	Normal..	stColor
Opacity	Opacity of the rendered content	Normal..	Int32
Contrast	Contrast of the rendered content	Normal..	Int32
Brightness	Brightness the rendered content	Normal..	Int32
Saturation	Saturation of the rendered content	Normal..	Double
Pixelation	Pixelation of the rendered content	Normal..	Int32
Blurring	The radius used in the gaussian blur of rendered content, as a pixel-based factor. The default is 0 which means no blurring.	Normal..	Int32
Scrambling	Defines a proportion of the scrambled voxels	Normal..	Double
Scrambling Grid Size	Defines dimensions of the scrambling grid. The dimensions has to be less than the element size have the zero reminders to that	Normal..	clSize
Positional Jitter
Reset Jitter Now	Runtime command that resets the positional jitter.	Runtime Command..	Boolean
Current Jitter	Returns the current jitter	Status..	clPoint
Jitter Range	Defines a possible range for the random jitter. The range is centered to the position of the element.	Normal..	clSize
Test Jitter	Click to test the current jitter	Design Time..	Boolean

¶

This element renders a video clip made of sequential video frames, which are streamed by an external app/hardware by the LSL protocol

Table of Contents [Hide/Show]

Summary
Properties

Description
Practical Use
Configuring the element
Notes

Description ¶

Apart from bio-signals, the LSL protocol allows streaming other data, such as text and video. The LSL video element can read a LSL stream that sends sequential video frames in real-time. The frames must be stored in the uncompressed RGB24 formats (3 bytes per pixel). The LSL stream must have a channel number equal to the total number of pixels in a single video frame. Each channel thus streams a color of the same single pixel represented by three Int8 (byte) values.

Practical Use ¶

Configuring the element ¶

Add a new LSL Video element to a stimulus event and go to its properties
Make sure that a LSL video stream is running and visible in a network. You may need to start an application that generates the video stream
Define Stream Type property, if it is known. If it is not, make the property blank
Expand an editor for the LSL stream property. If the target stream is detected, it will be available for selection. If not, check the stream and re-select the element in the EventIDE GUI
Set the size and position of the frame rendering area on the event surface

Notes ¶

The LSL video stream must be active before an onset of the parent event
The element starts rendering received video frames automatically at the onset of the parent event
Rendering is faster, if the size of the rendering area matches the original resolution of video frames
The element supports only RGB24 raw frames

EventIDE Wiki

Navigation¶