Class LSLObject

C# API for the lab streaming layer.

The lab streaming layer provides a set of functions to make instrument data accessible in real time within a lab network. From there, streams can be picked up by recording programs, viewing programs or custom experiment applications that access data streams in real time.

The API covers two areas:

  • The "push API" allows to create stream outlets and to push data (regular or irregular measurement time series, event data, coded audio/video frames, etc.) into them.
  • The "pull API" allows to create stream inlets and read time-synched experiment data from them (for recording, viewing or experiment control).
Implements
Namespace: LSL
Assembly: MOSAIC.dll
Syntax
public abstract class LSLObject : SafeHandle, IDisposable

Constructors

LSLObject(nint)

Declaration
public LSLObject(nint obj)
Parameters
Type Name Description
nint obj

Properties

IsInvalid

When overridden in a derived class, gets a value indicating whether the handle value is invalid.

Declaration
public override bool IsInvalid { get; }
Property Value
Type Description
bool

true if the handle value is invalid; otherwise, false.

Overrides
SafeHandle.IsInvalid

obj

Declaration
public nint obj { get; }
Property Value
Type Description
nint

Methods

DestroyLSLObject(nint)

To be implemented in inheriting classes: the liblsl function to destroy the internal object

Declaration
protected abstract void DestroyLSLObject(nint obj)
Parameters
Type Name Description
nint obj

ReleaseHandle()

When overridden in a derived class, executes the code required to free the handle.

Declaration
protected override bool ReleaseHandle()
Returns
Type Description
bool

true if the handle is released successfully; otherwise, in the event of a catastrophic failure, false. In this case, it generates a releaseHandleFailed Managed Debugging Assistant.

Overrides
SafeHandle.ReleaseHandle()

Implements

IDisposable

Search documentation

Start typing to search the documentation.