Enumerations / Flags

Postprocessing options:

enum lsl_processing_options_t

Post-processing options for stream inlets.

Values:

enumerator proc_none

No automatic post-processing; return the ground-truth time stamps for manual post-processing.

This is the default behavior of the inlet.

enumerator proc_clocksync

Perform automatic clock synchronization; equivalent to manually adding the time_correction() value to the received time stamps.

enumerator proc_dejitter

Remove jitter from time stamps.

This will apply a smoothing algorithm to the received time stamps; the smoothing needs to see a minimum number of samples (30-120 seconds worst-case) until the remaining jitter is consistently below 1ms.

enumerator proc_monotonize

Force the time-stamps to be monotonically ascending.

Only makes sense if timestamps are dejittered.

enumerator proc_threadsafe

Post-processing is thread-safe (same inlet can be read from by multiple threads); uses somewhat more CPU.

enumerator proc_ALL

The combination of all possible post-processing options.

enumerator _proc_maxval

Channel formats:

enum lsl_channel_format_t

Data format of a channel (each transmitted sample holds an array of channels), 4 bytes wide.

Values:

enumerator cft_float32

For up to 24-bit precision measurements in the appropriate physical unit (e.g., microvolts).

Integers from -16777216 to 16777216 are represented accurately.

enumerator cft_double64

For universal numeric data as long as permitted by network & disk budget.

The largest representable integer is 53-bit.

enumerator cft_string

For variable-length ASCII strings or data blobs, such as video frames, complex event descriptions, etc.

enumerator cft_int32

For high-rate digitized formats that require 32-bit precision.

Depends critically on meta-data to represent meaningful units. Useful for application event codes or other coded data.

enumerator cft_int16

For very high rate signals (40Khz+) or consumer-grade audio.

For professional audio float is recommended.

enumerator cft_int8

For binary signals or other coded data. Not recommended for encoding string data.

enumerator cft_int64

64 bit integers.

Support for this type is not yet exposed in all languages. Also, some builds of liblsl will not be able to send or receive data of this type.

enumerator cft_undefined

Can not be transmitted.

enumerator _cft_maxval

Error codes:

enum lsl_error_code_t

Possible error codes.

Values:

enumerator lsl_no_error

No error occurred.

enumerator lsl_timeout_error

The operation failed due to a timeout.

enumerator lsl_lost_error

The stream has been lost.

enumerator lsl_argument_error

An argument was incorrectly specified (e.g., wrong format or wrong length).

enumerator lsl_internal_error

Some other internal error has happened.

enumerator _lsl_error_code_maxval