AudioProcessingComponentState class

Diagnostic state of one audio processing component (echo cancellation, noise suppression, auto gain control or high-pass filter), observed at three stages of one pipeline: requested (caller intent) -> resolved (the engine's per-path decision) -> active (live truth), with effective as the merged verdict.

Experimental: this API may change in a future release.

Annotations

Constructors

AudioProcessingComponentState({AudioProcessingComponentRequest? requested, required bool isSoftwareResolved, required bool isSoftwareActive, required bool isPlatformAvailable, required bool isPlatformResolved, required bool isPlatformActive, required AudioProcessingImplementation effective})
const
AudioProcessingComponentState.fromMap(Map map)
factory

Properties

effective → AudioProcessingImplementation
The verdict: which implementation is in effect right now.
final
hashCode → int
The hash code for this object.
no setterinherited
isPlatformActive → bool
Whether the device reports the platform implementation actually running.
final
isPlatformAvailable → bool
Whether this device/OS offers a built-in implementation at all.
final
isPlatformResolved → bool
Whether the engine asked the OS to run the platform implementation. The OS owns the outcome: it can decline, defer, or couple components.
final
isSoftwareActive → bool
Whether APM's live configuration currently has this component enabled.
final
isSoftwareResolved → bool
Whether the resolver decided the WebRTC software (APM) implementation should run, after weighing the requested mode against platform availability, coupling, and policy.
final
requested → AudioProcessingComponentRequest?
What the caller most recently requested for this component. Null when no audio processing options have ever been applied — "nobody asked".
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

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