MediaDiagnostics Class

Package:

com.azure.android.communication.calling

• java.lang.Object
• • com.azure.android.communication.calling.MediaDiagnostics

public class MediaDiagnostics

Represents an object where media diagnostics are accessed.

Method Summary

Modifier and Type	Method and Description
void	addOnIsCameraFrozenChangedListener(DiagnosticFlagChangedListener listener) Adds the specified listener to receive OnIsCameraFrozenChanged events. Camera stops producing frames for more than 5 seconds.
void	addOnIsCameraPermissionDeniedChangedListener(DiagnosticFlagChangedListener listener) Adds the specified listener to receive OnIsCameraPermissionDeniedChanged events. Camera permissions were denied in settings.
void	addOnIsCameraStartFailedChangedListener(DiagnosticFlagChangedListener listener) Adds the specified listener to receive OnIsCameraStartFailedChanged events. Generic camera failure.
void	addOnIsCameraStartTimedOutChangedListener(DiagnosticFlagChangedListener listener) Adds the specified listener to receive OnIsCameraStartTimedOutChanged events. Common scenario where camera is in bad state.
void	addOnIsMicrophoneBusyChangedListener(DiagnosticFlagChangedListener listener) Adds the specified listener to receive OnIsMicrophoneBusyChanged events. Microphone is already in use. Either the device is being used in exclusive mode, or the device is being used in shared mode and the caller asked to use the device in exclusive mode.
void	addOnIsMicrophoneMutedUnexpectedlyChangedListener(DiagnosticFlagChangedListener listener) Adds the specified listener to receive OnIsMicrophoneMutedUnexpectedlyChanged events. Microphone enters muted state unexpectedly.
void	addOnIsMicrophoneNotFunctioningChangedListener(DiagnosticFlagChangedListener listener) Adds the specified listener to receive OnIsMicrophoneNotFunctioningChanged events. Microphone is not functioning.
void	addOnIsNoMicrophoneDevicesAvailableChangedListener(DiagnosticFlagChangedListener listener) Adds the specified listener to receive OnIsNoMicrophoneDevicesAvailableChanged events. No audio microphone devices on the user's system.
void	addOnIsNoSpeakerDevicesAvailableChangedListener(DiagnosticFlagChangedListener listener) Adds the specified listener to receive OnIsNoSpeakerDevicesAvailableChanged events. There is no audio speaker device on the user's system.
void	addOnIsSpeakerBusyChangedListener(DiagnosticFlagChangedListener listener) Adds the specified listener to receive OnIsSpeakerBusyChanged events. Speaker is already in use. Either the device is being used in exclusive mode, or the device is being used in shared mode and the caller asked to use the device in exclusive mode.
void	addOnIsSpeakerMutedChangedListener(DiagnosticFlagChangedListener listener) Adds the specified listener to receive OnIsSpeakerMutedChanged events. Speaker is muted.
void	addOnIsSpeakerNotFunctioningChangedListener(DiagnosticFlagChangedListener listener) Adds the specified listener to receive OnIsSpeakerNotFunctioningChanged events. Speaker is not functioning (failed to initialized the audio device client or device became inactive for more than 5 seconds).
void	addOnIsSpeakerVolumeZeroChangedListener(DiagnosticFlagChangedListener listener) Adds the specified listener to receive OnIsSpeakerVolumeZeroChanged events. Zero volume on a speaker.
void	addOnIsSpeakingWhileMicrophoneIsMutedChangedListener(DiagnosticFlagChangedListener listener) Adds the specified listener to receive OnIsSpeakingWhileMicrophoneIsMutedChanged events. Speaking while being on mute.
void	finalize() Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
MediaDiagnosticValues	getLatestDiagnostics() Stored latest values for all known media diagnostics.
void	removeOnIsCameraFrozenChangedListener(DiagnosticFlagChangedListener listener) Removes the specified listener to receive OnIsCameraFrozenChanged events. Camera stops producing frames for more than 5 seconds.
void	removeOnIsCameraPermissionDeniedChangedListener(DiagnosticFlagChangedListener listener) Removes the specified listener to receive OnIsCameraPermissionDeniedChanged events. Camera permissions were denied in settings.
void	removeOnIsCameraStartFailedChangedListener(DiagnosticFlagChangedListener listener) Removes the specified listener to receive OnIsCameraStartFailedChanged events. Generic camera failure.
void	removeOnIsCameraStartTimedOutChangedListener(DiagnosticFlagChangedListener listener) Removes the specified listener to receive OnIsCameraStartTimedOutChanged events. Common scenario where camera is in bad state.
void	removeOnIsMicrophoneBusyChangedListener(DiagnosticFlagChangedListener listener) Removes the specified listener to receive OnIsMicrophoneBusyChanged events. Microphone is already in use. Either the device is being used in exclusive mode, or the device is being used in shared mode and the caller asked to use the device in exclusive mode.
void	removeOnIsMicrophoneMutedUnexpectedlyChangedListener(DiagnosticFlagChangedListener listener) Removes the specified listener to receive OnIsMicrophoneMutedUnexpectedlyChanged events. Microphone enters muted state unexpectedly.
void	removeOnIsMicrophoneNotFunctioningChangedListener(DiagnosticFlagChangedListener listener) Removes the specified listener to receive OnIsMicrophoneNotFunctioningChanged events. Microphone is not functioning.
void	removeOnIsNoMicrophoneDevicesAvailableChangedListener(DiagnosticFlagChangedListener listener) Removes the specified listener to receive OnIsNoMicrophoneDevicesAvailableChanged events. No audio microphone devices on the user's system.
void	removeOnIsNoSpeakerDevicesAvailableChangedListener(DiagnosticFlagChangedListener listener) Removes the specified listener to receive OnIsNoSpeakerDevicesAvailableChanged events. There is no audio speaker device on the user's system.
void	removeOnIsSpeakerBusyChangedListener(DiagnosticFlagChangedListener listener) Removes the specified listener to receive OnIsSpeakerBusyChanged events. Speaker is already in use. Either the device is being used in exclusive mode, or the device is being used in shared mode and the caller asked to use the device in exclusive mode.
void	removeOnIsSpeakerMutedChangedListener(DiagnosticFlagChangedListener listener) Removes the specified listener to receive OnIsSpeakerMutedChanged events. Speaker is muted.
void	removeOnIsSpeakerNotFunctioningChangedListener(DiagnosticFlagChangedListener listener) Removes the specified listener to receive OnIsSpeakerNotFunctioningChanged events. Speaker is not functioning (failed to initialized the audio device client or device became inactive for more than 5 seconds).
void	removeOnIsSpeakerVolumeZeroChangedListener(DiagnosticFlagChangedListener listener) Removes the specified listener to receive OnIsSpeakerVolumeZeroChanged events. Zero volume on a speaker.
void	removeOnIsSpeakingWhileMicrophoneIsMutedChangedListener(DiagnosticFlagChangedListener listener) Removes the specified listener to receive OnIsSpeakingWhileMicrophoneIsMutedChanged events. Speaking while being on mute.

Method Details

addOnIsCameraFrozenChangedListener

public void addOnIsCameraFrozenChangedListener(DiagnosticFlagChangedListener listener)

Adds the specified listener to receive OnIsCameraFrozenChanged events. Camera stops producing frames for more than 5 seconds.

Parameters:

listener

addOnIsCameraPermissionDeniedChangedListener

public void addOnIsCameraPermissionDeniedChangedListener(DiagnosticFlagChangedListener listener)

Adds the specified listener to receive OnIsCameraPermissionDeniedChanged events. Camera permissions were denied in settings.

Parameters:

listener

addOnIsCameraStartFailedChangedListener

public void addOnIsCameraStartFailedChangedListener(DiagnosticFlagChangedListener listener)

Adds the specified listener to receive OnIsCameraStartFailedChanged events. Generic camera failure.

Parameters:

listener

addOnIsCameraStartTimedOutChangedListener

public void addOnIsCameraStartTimedOutChangedListener(DiagnosticFlagChangedListener listener)

Adds the specified listener to receive OnIsCameraStartTimedOutChanged events. Common scenario where camera is in bad state.

Parameters:

listener

addOnIsMicrophoneBusyChangedListener

public void addOnIsMicrophoneBusyChangedListener(DiagnosticFlagChangedListener listener)

Adds the specified listener to receive OnIsMicrophoneBusyChanged events. Microphone is already in use. Either the device is being used in exclusive mode, or the device is being used in shared mode and the caller asked to use the device in exclusive mode.

Parameters:

listener

addOnIsMicrophoneMutedUnexpectedlyChangedListener

public void addOnIsMicrophoneMutedUnexpectedlyChangedListener(DiagnosticFlagChangedListener listener)

Adds the specified listener to receive OnIsMicrophoneMutedUnexpectedlyChanged events. Microphone enters muted state unexpectedly.

Parameters:

listener

addOnIsMicrophoneNotFunctioningChangedListener

public void addOnIsMicrophoneNotFunctioningChangedListener(DiagnosticFlagChangedListener listener)

Adds the specified listener to receive OnIsMicrophoneNotFunctioningChanged events. Microphone is not functioning.

Parameters:

listener

addOnIsNoMicrophoneDevicesAvailableChangedListener

public void addOnIsNoMicrophoneDevicesAvailableChangedListener(DiagnosticFlagChangedListener listener)

Adds the specified listener to receive OnIsNoMicrophoneDevicesAvailableChanged events. No audio microphone devices on the user's system.

Parameters:

listener

addOnIsNoSpeakerDevicesAvailableChangedListener

public void addOnIsNoSpeakerDevicesAvailableChangedListener(DiagnosticFlagChangedListener listener)

Adds the specified listener to receive OnIsNoSpeakerDevicesAvailableChanged events. There is no audio speaker device on the user's system.

Parameters:

listener

addOnIsSpeakerBusyChangedListener

public void addOnIsSpeakerBusyChangedListener(DiagnosticFlagChangedListener listener)

Adds the specified listener to receive OnIsSpeakerBusyChanged events. Speaker is already in use. Either the device is being used in exclusive mode, or the device is being used in shared mode and the caller asked to use the device in exclusive mode.

Parameters:

listener

addOnIsSpeakerMutedChangedListener

public void addOnIsSpeakerMutedChangedListener(DiagnosticFlagChangedListener listener)

Adds the specified listener to receive OnIsSpeakerMutedChanged events. Speaker is muted.

Parameters:

listener

addOnIsSpeakerNotFunctioningChangedListener

public void addOnIsSpeakerNotFunctioningChangedListener(DiagnosticFlagChangedListener listener)

Adds the specified listener to receive OnIsSpeakerNotFunctioningChanged events. Speaker is not functioning (failed to initialized the audio device client or device became inactive for more than 5 seconds).

Parameters:

listener

addOnIsSpeakerVolumeZeroChangedListener

public void addOnIsSpeakerVolumeZeroChangedListener(DiagnosticFlagChangedListener listener)

Adds the specified listener to receive OnIsSpeakerVolumeZeroChanged events. Zero volume on a speaker.

Parameters:

listener

addOnIsSpeakingWhileMicrophoneIsMutedChangedListener

public void addOnIsSpeakingWhileMicrophoneIsMutedChangedListener(DiagnosticFlagChangedListener listener)

Adds the specified listener to receive OnIsSpeakingWhileMicrophoneIsMutedChanged events. Speaking while being on mute.

Parameters:

listener

finalize

protected void finalize()

Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.

getLatestDiagnostics

public MediaDiagnosticValues getLatestDiagnostics()

Stored latest values for all known media diagnostics.

removeOnIsCameraFrozenChangedListener

public void removeOnIsCameraFrozenChangedListener(DiagnosticFlagChangedListener listener)

Removes the specified listener to receive OnIsCameraFrozenChanged events. Camera stops producing frames for more than 5 seconds.

Parameters:

listener

removeOnIsCameraPermissionDeniedChangedListener

public void removeOnIsCameraPermissionDeniedChangedListener(DiagnosticFlagChangedListener listener)

Removes the specified listener to receive OnIsCameraPermissionDeniedChanged events. Camera permissions were denied in settings.

Parameters:

listener

removeOnIsCameraStartFailedChangedListener

public void removeOnIsCameraStartFailedChangedListener(DiagnosticFlagChangedListener listener)

Removes the specified listener to receive OnIsCameraStartFailedChanged events. Generic camera failure.

Parameters:

listener

removeOnIsCameraStartTimedOutChangedListener

public void removeOnIsCameraStartTimedOutChangedListener(DiagnosticFlagChangedListener listener)

Removes the specified listener to receive OnIsCameraStartTimedOutChanged events. Common scenario where camera is in bad state.

Parameters:

listener

removeOnIsMicrophoneBusyChangedListener

public void removeOnIsMicrophoneBusyChangedListener(DiagnosticFlagChangedListener listener)

Removes the specified listener to receive OnIsMicrophoneBusyChanged events. Microphone is already in use. Either the device is being used in exclusive mode, or the device is being used in shared mode and the caller asked to use the device in exclusive mode.

Parameters:

listener

removeOnIsMicrophoneMutedUnexpectedlyChangedListener

public void removeOnIsMicrophoneMutedUnexpectedlyChangedListener(DiagnosticFlagChangedListener listener)

Removes the specified listener to receive OnIsMicrophoneMutedUnexpectedlyChanged events. Microphone enters muted state unexpectedly.

Parameters:

listener

removeOnIsMicrophoneNotFunctioningChangedListener

public void removeOnIsMicrophoneNotFunctioningChangedListener(DiagnosticFlagChangedListener listener)

Removes the specified listener to receive OnIsMicrophoneNotFunctioningChanged events. Microphone is not functioning.

Parameters:

listener

removeOnIsNoMicrophoneDevicesAvailableChangedListener

public void removeOnIsNoMicrophoneDevicesAvailableChangedListener(DiagnosticFlagChangedListener listener)

Removes the specified listener to receive OnIsNoMicrophoneDevicesAvailableChanged events. No audio microphone devices on the user's system.

Parameters:

listener

removeOnIsNoSpeakerDevicesAvailableChangedListener

public void removeOnIsNoSpeakerDevicesAvailableChangedListener(DiagnosticFlagChangedListener listener)

Removes the specified listener to receive OnIsNoSpeakerDevicesAvailableChanged events. There is no audio speaker device on the user's system.

Parameters:

listener

removeOnIsSpeakerBusyChangedListener

public void removeOnIsSpeakerBusyChangedListener(DiagnosticFlagChangedListener listener)

Removes the specified listener to receive OnIsSpeakerBusyChanged events. Speaker is already in use. Either the device is being used in exclusive mode, or the device is being used in shared mode and the caller asked to use the device in exclusive mode.

Parameters:

listener

removeOnIsSpeakerMutedChangedListener

public void removeOnIsSpeakerMutedChangedListener(DiagnosticFlagChangedListener listener)

Removes the specified listener to receive OnIsSpeakerMutedChanged events. Speaker is muted.

Parameters:

listener

removeOnIsSpeakerNotFunctioningChangedListener

public void removeOnIsSpeakerNotFunctioningChangedListener(DiagnosticFlagChangedListener listener)

Removes the specified listener to receive OnIsSpeakerNotFunctioningChanged events. Speaker is not functioning (failed to initialized the audio device client or device became inactive for more than 5 seconds).

Parameters:

listener

removeOnIsSpeakerVolumeZeroChangedListener

public void removeOnIsSpeakerVolumeZeroChangedListener(DiagnosticFlagChangedListener listener)

Removes the specified listener to receive OnIsSpeakerVolumeZeroChanged events. Zero volume on a speaker.

Parameters:

listener

removeOnIsSpeakingWhileMicrophoneIsMutedChangedListener

public void removeOnIsSpeakingWhileMicrophoneIsMutedChangedListener(DiagnosticFlagChangedListener listener)

Removes the specified listener to receive OnIsSpeakingWhileMicrophoneIsMutedChanged events. Speaking while being on mute.

Parameters:

listener