LocalAudioStreamReason enum

Reasons for local audio state changes.

Inheritance

• Object
• Enum
• LocalAudioStreamReason

Annotations

• @JsonEnum(alwaysCreate: true)

Constructors

LocalAudioStreamReason()

const

Values

localAudioStreamReasonOk → const LocalAudioStreamReason

0: The local audio is normal.

localAudioStreamReasonFailure → const LocalAudioStreamReason

1: No specified reason for the local audio failure. Remind your users to try to rejoin the channel.

localAudioStreamReasonDeviceNoPermission → const LocalAudioStreamReason

2: No permission to use the local audio capturing device. Remind your users to grant permission. Deprecated: This enumerator is deprecated. Please use recordAudio in the onPermissionError callback instead.

localAudioStreamReasonDeviceBusy → const LocalAudioStreamReason

3: (Android and iOS only) The local audio capture device is already in use. Remind your users to check whether another application occupies the microphone. Local audio capture automatically resumes after the microphone is idle for about five seconds. You can also try to rejoin the channel after the microphone is idle.

localAudioStreamReasonRecordFailure → const LocalAudioStreamReason

4: The local audio capture fails.

localAudioStreamReasonEncodeFailure → const LocalAudioStreamReason

5: The local audio encoding fails.

localAudioStreamReasonNoRecordingDevice → const LocalAudioStreamReason

6: (Windows and macOS only) No local audio capture device. Remind your users to check whether the microphone is connected to the device properly in the control plane of the device or if the microphone is working properly.

localAudioStreamReasonNoPlayoutDevice → const LocalAudioStreamReason

7: (Windows and macOS only) No local audio capture device. Remind your users to check whether the speaker is connected to the device properly in the control plane of the device or if the speaker is working properly.

localAudioStreamReasonInterrupted → const LocalAudioStreamReason

8: (Android and iOS only) The local audio capture is interrupted by a system call, Siri, or alarm clock. Remind your users to end the phone call, Siri, or alarm clock if the local audio capture is required.

localAudioStreamReasonRecordInvalidId → const LocalAudioStreamReason

9: (Windows only) The ID of the local audio-capture device is invalid. Check the audio capture device ID.

localAudioStreamReasonPlayoutInvalidId → const LocalAudioStreamReason

10: (Windows only) The ID of the local audio-playback device is invalid. Check the audio playback device ID.

Properties

hashCode → int

The hash code for this object.

no setter, inherited

index → int

A numeric identifier for the enumerated value.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

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.