DataStreamInlet class

One producer's samples on a DataStream, as an inlet.

Treats time stamps as an LSL inlet does: with LslInletOptions.clockSync on this computer's LSL clock (samples whose clock offset is not known yet are left out), without it as the origin stamped them, with timeCorrectionEx and chain beside them.

Implemented types

Constructors

DataStreamInlet(DataStream<DataStreamConfig, IMessage<IMessageType>> source, {required String from, String node = 'here', String via = 'peer', String type = '', LslInletOptions options = const LslInletOptions()})

Properties

channels → List<LSLChannel>
Channel descriptions from the stream's metadata (labels default to ch1, ch2...).
final
from → String
The node whose samples these are (its uId).
final
fullXml → String
The stream's full info (info XML with desc), or empty if the sender did not give it.
no setteroverride
hashCode → int
The hash code for this object.
no setterinherited
node → String
What this computer, and the transport, are called in the chain.
final
options → LslInletOptions
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
source → DataStream<DataStreamConfig, IMessage<IMessageType>>
final
stream → LslStreamDescription
final
via → String
What this computer, and the transport, are called in the chain.
final

Methods

chain() → Future<ClockChain>
The hops the sender reported, then the one from it to here.
override
close() → Future<void>
Stop receiving. The DataStream stays open.
override
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
pull(int maxSamples) → Future<LslChunk>
Everything buffered, up to maxSamples. Does not wait.
override
timeCorrection() → Future<double>
The current clock offset: add it to the sender's time stamps to get this computer's LSL clock.
override
timeCorrectionEx() → Future<LSLTimeCorrection>
Zero with clock sync, else the whole way's offset at the latest sample.
override
toString() → String
A string representation of this object.
inherited

Operators

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