LatestMediaDiagnostics interface

Package:

@azure/communication-calling

Latest media diagnostics that were raised.

Properties

cameraFreeze	Raised to True when the local video stream is frozen. This means the remote side is seeing your video frozen on their screen. Raised to False when the freeze ends.
cameraPermissionDenied	Raised to True when camera permission is denied by system settings (video). Raised to False on successful stream acquisition. This diagnostic only works on MacOS Chrome
cameraStartFailed	Raised to True when we fail to start sending local video becuase the camera device may have been disabled in the system or it is being used by another process. Raised to False when selected camera device successfully sends local video again.
cameraStartTimedOut	Raised to True when camera device times out to start sending video stream. Raised to False when selected camera device successfully sends local video again
cameraStoppedUnexpectedly	Raised to True when camera enters stopped state unexpectedly. Raised to False when camera starts to successfully send video stream again.
capturerStartFailed	Raised to True when we fail to start capturing the screen. Raised to False when capturing the screen successfully can start.
capturerStoppedUnexpectedly	Raised to True when screen capturer enters stopped state unexpectedly. Raised to False when screen capturer starts to successfully capture again.
microphoneMuteUnexpectedly	Raised to True when microphone enters muted state unexpectedly. Raised to False when microphone starts to successfully send audio stream again.
microphoneNotFunctioning	Raised to True when we fail to start sending local audio stream becuase the microphone device may have been disabled in the system or it is being used by another process. Raised to False when microphone starts to successfully send audio stream again.
microphonePermissionDenied	Raised to True when audio permission is denied by system settings (audio). Raised to False on successful stream acquisition. This diagnostic only works on MacOS Chrome
noMicrophoneDevicesEnumerated	Raised to True when there are no microphone devices on the system. Raised to False when there is at least 1 microphone device on the system.
noSpeakerDevicesEnumerated	Raised to True when there are no speaker devices on the system, and speaker selection is supported. Raised to False when there is a least 1 speaker device on the system, and speaker selection is supported.
screenshareRecordingDisabled	Raised to True when screensharing permission is denied by system settings (sharing). Raised to False on successful stream acquisition. This diagnostic only works on MacOS Chrome
speakingWhileMicrophoneIsMuted	Raised to True when local microphone is muted and the local user is speaking. Raised to False when local user either stops speaking, or unmutes the microphone.

Property Details

cameraFreeze

Raised to True when the local video stream is frozen. This means the remote side is seeing your video frozen on their screen. Raised to False when the freeze ends.

cameraFreeze?: LatestDiagnosticValue

Property Value

LatestDiagnosticValue

cameraPermissionDenied

Raised to True when camera permission is denied by system settings (video). Raised to False on successful stream acquisition. This diagnostic only works on MacOS Chrome

cameraPermissionDenied?: LatestDiagnosticValue

Property Value

LatestDiagnosticValue

cameraStartFailed

Raised to True when we fail to start sending local video becuase the camera device may have been disabled in the system or it is being used by another process. Raised to False when selected camera device successfully sends local video again.

cameraStartFailed?: LatestDiagnosticValue

Property Value

LatestDiagnosticValue

cameraStartTimedOut

Raised to True when camera device times out to start sending video stream. Raised to False when selected camera device successfully sends local video again

cameraStartTimedOut?: LatestDiagnosticValue

Property Value

LatestDiagnosticValue

cameraStoppedUnexpectedly

Raised to True when camera enters stopped state unexpectedly. Raised to False when camera starts to successfully send video stream again.

cameraStoppedUnexpectedly?: LatestDiagnosticValue

Property Value

LatestDiagnosticValue

capturerStartFailed

Raised to True when we fail to start capturing the screen. Raised to False when capturing the screen successfully can start.

capturerStartFailed?: LatestDiagnosticValue

Property Value

LatestDiagnosticValue

capturerStoppedUnexpectedly

Raised to True when screen capturer enters stopped state unexpectedly. Raised to False when screen capturer starts to successfully capture again.

capturerStoppedUnexpectedly?: LatestDiagnosticValue

Property Value

LatestDiagnosticValue

microphoneMuteUnexpectedly

Raised to True when microphone enters muted state unexpectedly. Raised to False when microphone starts to successfully send audio stream again.

microphoneMuteUnexpectedly?: LatestDiagnosticValue

Property Value

LatestDiagnosticValue

microphoneNotFunctioning

Raised to True when we fail to start sending local audio stream becuase the microphone device may have been disabled in the system or it is being used by another process. Raised to False when microphone starts to successfully send audio stream again.

microphoneNotFunctioning?: LatestDiagnosticValue

Property Value

LatestDiagnosticValue

microphonePermissionDenied

Raised to True when audio permission is denied by system settings (audio). Raised to False on successful stream acquisition. This diagnostic only works on MacOS Chrome

microphonePermissionDenied?: LatestDiagnosticValue

Property Value

LatestDiagnosticValue

noMicrophoneDevicesEnumerated

Raised to True when there are no microphone devices on the system. Raised to False when there is at least 1 microphone device on the system.

noMicrophoneDevicesEnumerated?: LatestDiagnosticValue

Property Value

LatestDiagnosticValue

noSpeakerDevicesEnumerated

Raised to True when there are no speaker devices on the system, and speaker selection is supported. Raised to False when there is a least 1 speaker device on the system, and speaker selection is supported.

noSpeakerDevicesEnumerated?: LatestDiagnosticValue

Property Value

LatestDiagnosticValue

screenshareRecordingDisabled

Raised to True when screensharing permission is denied by system settings (sharing). Raised to False on successful stream acquisition. This diagnostic only works on MacOS Chrome

screenshareRecordingDisabled?: LatestDiagnosticValue

Property Value

LatestDiagnosticValue

speakingWhileMicrophoneIsMuted

Raised to True when local microphone is muted and the local user is speaking. Raised to False when local user either stops speaking, or unmutes the microphone.

speakingWhileMicrophoneIsMuted?: LatestDiagnosticValue

Property Value

LatestDiagnosticValue