speakingWhileMicrophoneIsMuted UFD
The speakingWhileMicrophoneIsMuted
UFD event with a true
value occurs when the SDK detects that the audio input volume isn't muted although the user did mute the microphone.
This event can remind the user who may want to speak something but forgot to unmute their microphone.
In this case, since the microphone state in the SDK is muted, no audio is sent.
speakingWhileMicrophoneIsMuted | Detail |
---|---|
UFD type | MediaDiagnostics |
value type | DiagnosticFlag |
possible values | true, false |
Example
call.feature(Features.UserFacingDiagnostics).media.on('diagnosticChanged', (diagnosticInfo) => {
if (diagnosticInfo.diagnostic === 'speakingWhileMicrophoneIsMuted') {
if (diagnosticInfo.value === true) {
// show a warning message on UI
} else {
// The speakingWhileMicrophoneIsMuted UFD recovered, notify the user
}
}
});
How to mitigate or resolve
The speakingWhileMicrophoneIsMuted
UFD event isn't an error, but rather an indication of an inconsistency between the audio input volume and the microphone's muted state in the SDK.
The purpose of this event is for the application to show a message on your user interface as a hint, so the user can know that the microphone is muted while they're speaking.
Next steps
- Learn more about User Facing Diagnostics feature.