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
 Describes a particular stream on the network. More...
class  StreamInletPrivate
class  stream_inlet
 A stream inlet to receive data from a stream_outlet on the network. More...
class  StreamOutletPrivate
class  stream_outlet
 A stream outlet to publish data on the network. More...

Enumerations

enum  channel_format_t {
  cf_undefined = 0 , cf_float32 = 1 , cf_double64 = 2 , cf_string = 3 ,
  cf_int32 = 4 , cf_int16 = 5 , cf_int8 = 6 , cf_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

◆ channel_format_t

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

Enumerator
cf_undefined 

Undefined format.

cf_float32 

32-bit IEEE 754 floating point.

cf_double64 

64-bit IEEE 754 floating point.

cf_string 

Variable-length string.

cf_int32 

32-bit signed integer.

cf_int16 

16-bit signed integer.

cf_int8 

8-bit signed integer.

cf_int64 

64-bit signed integer.

Definition at line 60 of file stream_info.h.

Function Documentation

◆ buildDateTime()

const char * LSLLIB::buildDateTime ( )

Returns build date and time.

Definition at line 45 of file lsl_global.cpp.

◆ buildHash()

const char * LSLLIB::buildHash ( )

Returns abbreviated build git hash.

Definition at line 49 of file lsl_global.cpp.

◆ buildHashLong()

const char * LSLLIB::buildHashLong ( )

Returns full build git hash.

Definition at line 53 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 151 of file 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 70 of file stream_discovery.cpp.