RecordPlatform class abstract
The interface that implementations of Record must implement.
Platform implementations should extend this class rather than implement it as record does not consider newly added methods to be breaking changes. Extending this class ensures that the subclass will get the default implementation, while platform implementations that merely implement the interface will be broken by newly added RecordPlatform functions.
Constructors
- RecordPlatform()
- Constructs a RecordPlatform.
Properties
- hashCode → int
-
The hash code for this object.
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
Methods
-
dispose(
) → Future< void> - Dispose the recorder
-
getAmplitude(
) → Future< Amplitude> - Gets current average & max amplitudes (dBFS) Always returns zeros on unsupported platforms
-
hasPermission(
) → Future< bool> - Checks and requests for audio record permission.
-
isEncoderSupported(
AudioEncoder encoder) → Future< bool> - Checks if the given encoder is supported on the current platform.
-
isPaused(
) → Future< bool> - Checks if recording session is paused.
-
isRecording(
) → Future< bool> -
Checks if there's valid recording session.
So if session is paused, this method will still return
true. -
listInputDevices(
) → Future< List< InputDevice> > - Lists capture/input devices available on the platform.
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
onStateChanged(
) → Stream< RecordState> - Listen to recorder states RecordState.
-
pause(
) → Future< void> - Pauses recording session.
-
resume(
) → Future< void> - Resumes recording session after pause.
-
start(
{String? path, AudioEncoder encoder = AudioEncoder.aacLc, int bitRate = 128000, int samplingRate = 44100, int numChannels = 2, InputDevice? device}) → Future< void> - Starts new recording session.
-
stop(
) → Future< String?> - Stops recording session and release internal recorder resource. Returns the output path.
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited
Static Properties
- instance ↔ RecordPlatform
-
The default instance of RecordPlatform to use.
getter/setter pair