v2.0.0
Loading...
Searching...
No Matches
LSLLIB Namespace Reference

Lab Streaming Layer (LSL) integration for real-time data exchange. More...

Classes

class  stream_info
 Value-type descriptor of a single LSL stream: semantic metadata plus transport endpoint, API-compatible with liblsl's stream_info. More...
class  StreamInletPrivate
class  stream_inlet
 Client-side LSL endpoint: connects to a resolved outlet over TCP and exposes pulled samples as float chunks. More...
class  StreamOutletPrivate
class  stream_outlet
 Server-side LSL endpoint: binds a TCP data server, advertises the stream on the LSL discovery multicast group, and fans samples out to every connected inlet. More...

Enumerations

enum class  ChannelFormat : int {
  Undefined = 0 , Float32 = 1 , Double64 = 2 , String = 3 ,
  Int32 = 4 , Int16 = 5 , Int8 = 6 , Int64 = 7
}

Functions

const char * buildDateTime ()
const char * buildHash ()
const char * buildHashLong ()
std::vector< stream_inforesolve_streams (double timeout=1.0)
 Resolve all streams currently available on the network.
std::vector< stream_inforesolve_stream (const std::string &prop, const std::string &value, double timeout=1.0)
 Resolve streams by a specific property value.

Detailed Description

Lab Streaming Layer (LSL) integration for real-time data exchange.

Enumeration Type Documentation

◆ ChannelFormat

enum class LSLLIB::ChannelFormat : int
strong

Data format of a channel (mirroring the values used in the original LSL protocol).

Enumerator
Undefined 

Undefined format.

Float32 

32-bit IEEE 754 floating point.

Double64 

64-bit IEEE 754 floating point.

String 

Variable-length string.

Int32 

32-bit signed integer.

Int16 

16-bit signed integer.

Int8 

8-bit signed integer.

Int64 

64-bit signed integer.

Definition at line 59 of file lsl_stream_info.h.

Function Documentation

◆ buildDateTime()

const char * LSLLIB::buildDateTime ( )

Returns build date and time.

Definition at line 32 of file lsl_global.cpp.

◆ buildHash()

const char * LSLLIB::buildHash ( )

Returns abbreviated build git hash.

Definition at line 36 of file lsl_global.cpp.

◆ buildHashLong()

const char * LSLLIB::buildHashLong ( )

Returns full build git hash.

Definition at line 40 of file lsl_global.cpp.

◆ resolve_stream()

std::vector< LSLLIB::stream_info > LSLLIB::resolve_stream ( const std::string & prop,
const std::string & value,
double timeout = 1.0 )

Resolve streams by a specific property value.

Listens on the UDP multicast discovery channel and returns only streams whose specified property matches the given value.

Parameters
[in]propThe stream property to match (e.g. "name", "type", "source_id").
[in]valueThe value that the property must have.
[in]timeoutDuration (in seconds) to listen for stream announcements. Default: 1.0.
Returns
A vector of matching stream_info objects.

Definition at line 149 of file lsl_stream_discovery.cpp.

◆ resolve_streams()

std::vector< LSLLIB::stream_info > LSLLIB::resolve_streams ( double timeout = 1.0)

Resolve all streams currently available on the network.

Listens on the UDP multicast discovery channel for stream announcements from outlets. This call blocks for the specified timeout duration while collecting results.

Parameters
[in]timeoutDuration (in seconds) to listen for stream announcements. Default: 1.0.
Returns
A vector of stream_info objects for all discovered streams.

Definition at line 68 of file lsl_stream_discovery.cpp.