LSLDescription class

Provides access to a stream's metadata description element.

This class wraps LibLSL's description XML structure, providing a Dart-friendly interface for accessing and modifying stream metadata. The description contains the root XML element that can hold manufacturer info, channel details, acquisition settings, and other custom metadata.

Key Properties:

  • value: The root XML node of the description

Usage Pattern:

final streamInfo = await LSL.createStreamInfo(...);
final description = streamInfo.description;
final rootElement = description.value;

// Add metadata
rootElement.addChildValue('manufacturer', 'SCCN');
final channels = rootElement.addChildElement('channels');

Memory Management: The description shares the lifetime of its parent LSLStreamInfoWithMetadata. Destroying the stream info will invalidate this description.

Constructors

LSLDescription.new(lsl_streaminfo _fullInfo)

Properties

hashCode int
The hash code for this object.
no setterinherited
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
value LSLXmlNode
latefinal

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