AudioProbe class

A probe recording audio from the microphone. It starts recording on start and stops recording on stop, and post the recorded Media object to the measurements stream.

Note that this probe generates a lot of data and should be used with caution.

Also note that this probe records raw sound directly from the microphone and hence records everything - including human speech - in its proximity.

The audio probe generates an Media data measurement that holds the meta-data for each recording along with the actual recording in an audio file. How to upload or store this data to a data backend is up to the implementation of the DataManager, which is used in the Study.

Inheritance

• Object
• AbstractExecutor<Measure>
• Probe
• MeasurementProbe
• AudioProbe

Constructors

AudioProbe()

Properties

configuration → Measure?

The configuration of this executor as set when initialized.

no setter, inherited

deployment → SmartphoneDeployment?

The deployment that this executor is part of executing.

no setter, inherited

deviceManager ↔ DeviceManager<DeviceConfiguration<DeviceRegistration>>

A stream controller to add Measurements to. The device that this probes uses to collect data.

getter/setter pair, inherited

enabled ↔ bool

Is this probe enabled, i.e. available for collection of data using the start method.

getter/setter pair, inherited

filename → String

Returns the filename of the sound file. The file is named by the unique id (uuid) of the Media

no setter

filePath → Future<String>

Returns the full file path to the sound file.

no setter

hashCode → int

The hash code for this object.

no setter, inherited

isRecording → bool

no setter

isStarting → bool

Is this executor in the process of being started?

no setter, inherited

measure → Measure?

The Measure that configures this probe.

no setter, inherited

measurements → Stream<Measurement>

The stream of Measurement collected by this executor.

no setter, inherited

path → Future<String>

Returns the local path on the device where sound files can be stored. Creates the directory, if not existing.

no setter

recorder ↔ FlutterSoundRecorder

getter/setter pair

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

samplingConfiguration → SamplingConfiguration?

The sampling configuration for this probe.

no setter, inherited

state → ExecutorState

The runtime state of this executor.

no setter, inherited

stateEvents → Stream<ExecutorState>

The runtime state changes of this executor.

no setter, inherited

studyDeploymentPath → String

no setter

type → String?

The data type this probe is collecting.

no setter, inherited

Methods

addError(Object error, [StackTrace? stacktrace]) → void

Add an error to the measurements stream.

inherited

addMeasurement(Measurement measurement) → void

Add a data point to the measurements stream.

inherited

dispose() → void

Dispose of this executor.

inherited

error() → void

inherited

getMeasurement() → Future<Measurement?>

Subclasses should implement this method to collect a Measurement.

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

onStart() → Future<bool>

Callback when this executor is started. Returns true if successfully started, false otherwise.

override

onStop() → Future<bool>

Callback when this executor is stopped. Returns true if successfully stopped, false otherwise.

override

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

Constants

AUDIO_FILES_PATH → const String

The name of the folder used for storing audio files.