LocalAudioStreamReason enum

Reasons for local audio state change.

Inheritance
Available extensions
Annotations
  • @JsonEnum.new(alwaysCreate: true)

Values

localAudioStreamReasonOk → const LocalAudioStreamReason

0: Local audio is working properly.

localAudioStreamReasonFailure → const LocalAudioStreamReason

1: Unknown reason for local audio failure. Suggest prompting the user to try rejoining the channel.

localAudioStreamReasonDeviceNoPermission → const LocalAudioStreamReason

2: No permission to start local audio capture device. Prompt the user to grant permission. Deprecated: This enum is deprecated. Use recordAudio in the onPermissionError callback instead.

localAudioStreamReasonDeviceBusy → const LocalAudioStreamReason

3: (Android and iOS only) Local audio capture device is in use. Prompt the user to check if the microphone is occupied by another app. Local audio capture will automatically resume about 5 seconds after the microphone becomes idle, or you can try rejoining the channel after it becomes idle.

localAudioStreamReasonRecordFailure → const LocalAudioStreamReason

4: Local audio capture failed.

localAudioStreamReasonEncodeFailure → const LocalAudioStreamReason

5: Local audio encoding failed.

localAudioStreamReasonNoRecordingDevice → const LocalAudioStreamReason

6: (Windows and macOS only) No local audio capture device. Prompt the user to check in the control panel whether the microphone is properly connected and working.

localAudioStreamReasonNoPlayoutDevice → const LocalAudioStreamReason

7: (Windows and macOS only) No local audio playback device. Prompt the user to check in the control panel whether the speaker is properly connected and working.

localAudioStreamReasonInterrupted → const LocalAudioStreamReason

8: (Android and iOS only) Local audio capture was interrupted by system call, smart assistant, or alarm. To resume local audio capture, ask the user to end the call, assistant, or alarm.

localAudioStreamReasonRecordInvalidId → const LocalAudioStreamReason

9: (Windows only) Invalid ID for local audio capture device. Prompt the user to check the audio capture device ID.

localAudioStreamReasonPlayoutInvalidId → const LocalAudioStreamReason

10: (Windows only) Invalid ID for local audio playback device. Prompt the user to check the audio playback device ID.

Properties

hashCode → int
The hash code for this object.
no setterinherited
index → int
A numeric identifier for the enumerated value.
no setterinherited
name → String

Available on Enum, provided by the EnumName extension

The name of the enum value.
no setter
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

Constants

values → const List<LocalAudioStreamReason>
A constant List of the values in this enum, in order of their declaration.