AudioEngineAvailability class
Whether the WebRTC audio engine is allowed to run, per direction.
This is the highest-priority gate over anything that may start the engine (enabling the microphone, starting playback of remote audio). Requests made while a direction is unavailable are not lost: the engine starts as soon as availability allows.
Used to coordinate with platform call systems that own audio activation
timing, such as CallKit on iOS: keep the engine unavailable until
provider(didActivate:) and make it available inside the
activate/deactivate window. See AudioManager.setEngineAvailability.
Experimental: this API may change in a future release.
- Annotations
Constructors
- AudioEngineAvailability({required bool isInputAvailable, required bool isOutputAvailable})
-
const
Properties
- hashCode → int
-
The hash code for this object.
no setteroverride
- isInputAvailable → bool
-
Whether the engine may run its input (microphone / recording) side.
final
- isOutputAvailable → bool
-
Whether the engine may run its output (playout / remote audio) side.
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.
override
Operators
-
operator ==(
Object other) → bool -
The equality operator.
override
Constants
- defaultAvailability → const AudioEngineAvailability
- Both input and output are available (the default).
- none → const AudioEngineAvailability
- Neither input nor output is available. The engine will not run.