CoordinationStreamConfig class

Configuration for a coordination stream used for network coordination tasks.

Inheritance

Constructors

CoordinationStreamConfig({required String name, double sampleRate = 50.0})
Transport-specific configuration for the coordination stream. Transport-specific configuration for the coordination stream. Creates a coordination stream configuration. Coordination streams default to 1 channel and string data type. The sample rate can be specified. Optionally, transport-specific configuration can be provided.

Properties

channels → int
Number of channels in the stream.
finalinherited
dataType → StreamDataType
Data type of the stream. This is a StreamDataType enum value.
finalinherited
description → String?
Returns a description of the identity.
no setteroverride
hashCode → int
The hash code for this object.
no setteroverride
id → String
Returns a unique identifier for the identity.
no setteroverride
name → String
Human-readable name for the stream.
finalinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
sampleRate → double
Sample rate of the stream.
finalinherited

Methods

copyWith({String? id, String? name, int? channelCount, double? sampleRate, StreamDataType? dataType}) → NetworkStreamConfig
Creates a copy of this configuration with the given fields replaced.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toMap() → Map<String, dynamic>
Converts the object to a map representation for serialization.
override
toString() → String
A string representation of this object.
override
validate({bool throwOnError = false}) → bool
Validates the configuration.
inherited

Operators

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