Namespace LSL4Unity

Classes

liblsl.ContinuousResolver

A convenience class that resolves streams continuously in the background throughout its lifetime and which can be queried at any time for the set of streams that are currently visible on the network.

liblsl.InternalException

Exception class that indicates that an internal error has occurred inside liblsl.

liblsl.LostException

Exception class that indicates that a stream inlet's source has been irrecoverably lost.

liblsl.StreamInfo

The stream_info object stores the declaration of a data stream.

Represents the following information:

stream data format (#channels, channel format)
core information (stream name, content type, sampling rate)
optional meta-data about the stream content (channel labels, measurement units, etc.)

Whenever a program wants to provide a new stream on the lab network, it will typically first create a stream_info to describe its properties and then construct a stream_outlet with it to create the stream on the network. Recipients who discover the outlet can query the stream_info; it is also written to disk when recording the stream (playing a similar role as a file header).

liblsl.StreamInlet

A stream inlet.

Inlets are used to receive streaming data (and meta-data) from the lab network.

liblsl.StreamOutlet

A stream outlet.

Outlets are used to make streaming data (and the meta-data) available on the lab network.

LSLMarkerStream

LSLOutlet

LSLStreamInfoWrapper

LSLTimeSync

This singleton should provide an dedicated timestamp for each update call or fixed update LSL sample! So that each sample provided by an Unity3D app has the same timestamp Important! Make sure that the script is called before the default execution order!

LSLTransformOutlet

An reusable example of an outlet which provides the orientation and world position of an entity of an Unity Scene to LSL.

LSLUtils

Resolver

Encapsulates the lookup logic for LSL streams with an event based appraoch your custom stream inlet implementations could be subscribed to the On.

ScriptOrder

This attribute is used to define specific script execution orders when necessary! Example: LSLTimeSync -> should be called at the beginning of each frame before other scripts use it's properties. Original from Unity forum: https://forum.unity3d.com/threads/script-execution-order-manipulation.130805/

StreamEvent

Structs

liblsl.XMLElement

A lightweight XML element tree; models the Desc() field of liblsl.StreamInfo.

Has a name and can have multiple named children or have text content as value; attributes are omitted. Insider note: The interface is modeled after a subset of pugixml's node type and is compatible with it.