LSLTransportOptions enum

This enum has flags that are used for inlets and outlets

Inheritance
Available extensions

Values

legacy → const LSLTransportOptions

Keep legacy behavior: max_buffered / max_buflen is in seconds; use asynch transfer.

const LSLTransportOptions(lsl_transport_options_t.transp_default)
bufsizeInSamples → const LSLTransportOptions

The supplied max_buf value is in samples.

const LSLTransportOptions(lsl_transport_options_t.transp_bufsize_samples)
bufsizeInThousandths → const LSLTransportOptions

The supplied max_buf should be scaled by 0.001.

const LSLTransportOptions(lsl_transport_options_t.transp_bufsize_thousandths)
syncBlocking → const LSLTransportOptions

Use synchronous (blocking) socket writes for zero-copy data transfer. When enabled, push_sample/push_chunk write the caller's buffer directly to every connected consumer and block until the data has been handed to the OS for all of them. Reduces CPU usage for high-bandwidth streams at the cost of increased call latency. Notes:

  • Not compatible with string-format streams (variable-size samples).
  • Single-producer: push from only one thread at a time (the sync path is unsynchronized).
  • The pushthrough flag is ignored; every push sends immediately (no internal buffering).
const LSLTransportOptions(lsl_transport_options_t.transp_sync_blocking)

Properties

hashCode → int
The hash code for this object.
no setterinherited
index → int
A numeric identifier for the enumerated value.
no setterinherited
name → String

Available on Enum, provided by the EnumName extension

The name of the enum value.
no setter
nativeType → lsl_transport_options_t
no setter
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
value → int
no setter

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited

Static Methods

fromNative(lsl_transport_options_t native) → LSLTransportOptions
Converts a native lsl_transport_options_t value to the corresponding LSLTransportOptions enum value.
fromValue(int value) → LSLTransportOptions
Converts an integer value to the corresponding LSLTransportOptions enum value.

Constants

values → const List<LSLTransportOptions>
A constant List of the values in this enum, in order of their declaration.