NoiseProbe class

A probe collecting noise sampling from the microphone.

See PeriodicSamplingConfiguration on how to configure this probe, including setting the frequency and duration of the sampling rate.

Does not record sound. Instead reports the audio level with a specified frequency, in a given sampling window as a Noise data object.

Inheritance
  • Object
  • AbstractExecutor<Measure>
  • Probe
  • StreamProbe
  • PeriodicStreamProbe
  • BufferingPeriodicStreamProbe
  • NoiseProbe

Constructors

NoiseProbe()

Properties

bufferingStream → Stream<NoiseReading>
The stream of events to be buffered. Must be specified by sub-classes.
no setteroverride
configuration → Measure?
The configuration of this executor as set when initialized.
no setterinherited
deployment → SmartphoneDeployment?
The deployment that this executor is part of executing.
no setterinherited
deviceManager ↔ DeviceManager<DeviceConfiguration<DeviceRegistration>>
The device that this probes uses to collect data.
getter/setter pairinherited
enabled ↔ bool
Is this probe enabled, i.e. available for collection of data using the start method.
getter/setter pairinherited
hashCode → int
The hash code for this object.
no setterinherited
isStarting → bool
Is this executor in the process of being started?
no setterinherited
measure → Measure?
The Measure that configures this probe.
no setterinherited
measurements → Stream<Measurement>
The stream of Measurement collected by this executor.
no setterinherited
permissions → List<Permission>
The list of permissions needed for this probe.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
samplingConfiguration → PeriodicSamplingConfiguration?
The sampling configuration for this probe.
no setterinherited
state → ExecutorState
The runtime state of this executor.
no setterinherited
stateEvents → Stream<ExecutorState>
The runtime state changes of this executor.
no setterinherited
stream → Stream<Measurement>
The stream of Measurement objects for this StreamProbe. Must be implemented by sub-classes.
no setterinherited
type → String?
The data type this probe is collecting.
no setterinherited

Methods

addError(Object error, [StackTrace? stacktrace]) → void
Add error to the measurements stream.
inherited
addMeasurement(Measurement measurement) → void
Add measurement to the measurements stream.
inherited
arePermissionsGranted() → Future<bool>
Does this probe has the permissions needed to run?
inherited
dispose() → void
Dispose of this executor.
inherited
error() → void
inherited
getMeasurement() → Future<Measurement?>
Subclasses should implement / override this method to collect the Measurement. This method will be called every time data has been buffered for a duration and should return the final measurement for the buffered data.
override
initialize(Measure configuration, [SmartphoneDeployment? deployment]) → void
Configure and initialize the executor before starting it.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
onDispose() → Future<void>
Callback when this executor is disposed.
inherited
onInitialize() → bool
Callback when this executor is initialized. Returns true if successfully initialized, false otherwise.
inherited
onRestart() → Future<bool>
Callback when this executor is to be restarted. Returns true if the executor is ready to restart (default), false otherwise.
inherited
onSamplingData(dynamic event) → void
Handler for handling onData events from the buffering stream.
override
onSamplingEnd() → void
Handler called when sampling period ends.
override
onSamplingStart() → void
Handler called when sampling period starts.
override
onStart() → Future<bool>
Callback when this executor is started. Returns true if successfully started, false otherwise.
inherited
onStop() → Future<bool>
Callback when this executor is stopped. Returns true if successfully stopped, false otherwise.
inherited
requestPermissions() → Future<bool>
Request the permissions needed for this probe to run. Return true if all permissions are granted. Only used on Android - iOS automatically request permissions when a resource (like the microphone) is accessed.
inherited
restart() → void
Restart the executor.
inherited
start() → void
Start the executor.
inherited
stop() → void
Stop the executor. Stopped until start or restart is called.
inherited
toString() → String
A string representation of this object.
inherited

Operators

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