LSLStreamResolver class
The standard resolver for LSL streams.
- Implementers
- Available extensions
Constructors
- LSLStreamResolver.new({int maxStreams = 5})
-
Creates a new LSLStreamResolver object.
The
maxStreams
parameter determines the maximum number of streams to resolve, ideally, this would be the exact number of streams you expect to be available.
Properties
- created → bool
-
Whether the object has been created.
no setterinherited
- destroyed → bool
-
Whether the object has been destroyed.
no setterinherited
- hashCode → int
-
The hash code for this object.
no setterinherited
- maxStreams ↔ int
-
getter/setter pair
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
Methods
-
addAlloc(
Pointer< NativeType> arg) → void -
Adds a pointer to the list of allocated pointers.
inherited
-
addAllocList(
List< Pointer< args) → voidNativeType> > -
Adds a list of pointers to the list of allocated pointers.
inherited
-
create(
) → LSLStreamResolver - Creates the resolver and allocates the stream info buffer.
-
destroy(
) → void - Destroys the resolver and frees the stream info buffer. If the resolver is already destroyed, this method does nothing.
-
freeArgs(
) → void -
Frees all allocated pointers.
inherited
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
resolve(
{double waitTime = 5.0}) → Future< List< LSLStreamInfo> > -
Resolves streams available on the network.
The
waitTime
parameter determines how long to wait for streams to resolve. It is your responsibility to ensure that the returned streams are destroyed when no longer needed. -
resolveByPredicate(
{required String predicate, double waitTime = 5.0, int minStreamCount = 0}) → Future< List< LSLStreamInfo> > -
Available on LSLStreamResolver, provided by the LSLStreamResolverByPredicate extension
Resolves streams by a predicate function. Thepredicate
parameter is an XPath 1.0 predicate e.g.name='MyStream' and type='EEG'
orstarts-with(name, 'My')
. ThewaitTime
parameter determines how long to wait for streams to resolve, if the value is 0, the default of forever will be used, and will only return when theminStreamCount
is met. TheminStreamCount
parameter is the minimum number of streams to resolve, it must be greater than 0. -
resolveByProperty(
{required LSLStreamProperty property, required String value, double waitTime = 5.0, int minStreamCount = 0}) → Future< List< LSLStreamInfo> > -
Available on LSLStreamResolver, provided by the LSLStreamResolverByProp extension
Resolves streams by a specific property. Theproperty
parameter is the property to filter by, such as name, type, channel count, etc. Thevalue
parameter is the value to filter by. ThewaitTime
parameter determines how long to wait for streams to resolve, if the value is 0, the default of forever will be used, and will only return when theminStreamCount
is met. TheminStreamCount
parameter is the minimum number of streams to resolve, it must be greater than 0. Returns a list of LSLStreamInfo objects that match the filter. Throws an LSLException if the resolver is not created or if there is an error resolving streams. You may get less streams than theminStreamCount
if there are not enough streams available AND you have set awaitTime
> 0. -
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited