AudioPreview class
The AudioPreview model allows the local participant to test different capture modes and voice fonts before a conference. The model is supported only in SDK 3.10 and later.
Constructors
Properties
- hashCode → int
-
The hash code for this object.
read-onlyinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
read-onlyinherited
Methods
-
getCaptureMode(
) → Future< AudioCaptureOptions> - Gets an audio capture mode for the audio preview.
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a non-existent method or property is accessed.
inherited
-
onStatusChanged(
) → Stream< Event< AudioPreviewEventNames, AudioPreviewStatus> > - Returns a Stream of the AudioPreviewEventNames.onStatusChanged events. By subscribing to the returned stream you will be notified about new conference invitations.
-
play(
bool loop) → Future< void> -
Plays back the recorded audio sample. To test how your audio sounds while using different capture modes and voice fonts, set the captureMode to a preferred setting before using the method.
loop
A boolean that indicates wether the SDK should play the recorded audio in a loop. -
record(
int duration) → Future< void> -
Starts recording an audio sample if no recording is in progress.
duration
- The preferred recording duration, in seconds. -
release(
) → Future< void> - Release the internal memory and restart the audio session configuration.
-
setCaptureMode(
AudioCaptureOptions captureMode) → Future< void> -
Sets an audio capture mode for the audio preview.
captureMode
- a capture mode to test -
status(
) → Future< AudioPreviewStatus> - Gets the recording status.
-
stop(
) → Future< bool> - Stops recording or playing an audio sample.
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited