Skip to content

Commit f788039

Browse files
authored
Update user-facing-diagnostics-web.md
1 parent 3dc17cc commit f788039

File tree

1 file changed

+43
-1
lines changed

1 file changed

+43
-1
lines changed

articles/communication-services/concepts/voice-video-calling/includes/user-facing-diagnostics-web.md

Lines changed: 43 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -79,6 +79,48 @@ The following user-facing diagnostics are available:
7979

8080
User-facing diagnostics is an extended feature of the core [`Call`](/javascript/api/azure-communication-services/@azure/communication-calling/call?view=azure-communication-services-js&preserve-view=true) API. You can understand more about the `UserFacingDiagnosticsFeature` interface [here](/javascript/api/azure-communication-services/@azure/communication-calling/userfacingdiagnosticsfeature?view=azure-communication-services-js&preserve-view=true).
8181

82+
UserFacingDiagnosticsFeature (extends CallFeature)
83+
├── network: NetworkDiagnostics
84+
│ ├── getLatest(): LatestNetworkDiagnostics
85+
│ ├── on('diagnosticChanged', listener)
86+
│ ├── off('diagnosticChanged', listener)
87+
│ └── LatestNetworkDiagnostics
88+
│ ├── networkReconnect?: LatestDiagnosticValue
89+
│ ├── networkReceiveQuality?: LatestDiagnosticValue
90+
│ ├── networkSendQuality?: LatestDiagnosticValue
91+
│ ├── noNetwork?: LatestDiagnosticValue
92+
│ └── networkRelaysNotReachable?: LatestDiagnosticValue
93+
94+
├── media: MediaDiagnostics
95+
│ ├── getLatest(): LatestMediaDiagnostics
96+
│ ├── on('diagnosticChanged', listener)
97+
│ ├── off('diagnosticChanged', listener)
98+
│ └── LatestMediaDiagnostics
99+
│ ├── speakingWhileMicrophoneIsMuted?: LatestDiagnosticValue
100+
│ ├── noSpeakerDevicesEnumerated?: LatestDiagnosticValue
101+
│ ├── noMicrophoneDevicesEnumerated?: LatestDiagnosticValue
102+
│ ├── cameraFreeze?: LatestDiagnosticValue
103+
│ ├── cameraStartFailed?: LatestDiagnosticValue
104+
│ ├── cameraStartTimedOut?: LatestDiagnosticValue
105+
│ ├── capturerStartFailed?: LatestDiagnosticValue
106+
│ ├── microphoneNotFunctioning?: LatestDiagnosticValue
107+
│ ├── microphoneMuteUnexpectedly?: LatestDiagnosticValue
108+
│ ├── cameraStoppedUnexpectedly?: LatestDiagnosticValue
109+
│ ├── capturerStoppedUnexpectedly?: LatestDiagnosticValue
110+
│ ├── screenshareRecordingDisabled?: LatestDiagnosticValue
111+
│ ├── microphonePermissionDenied?: LatestDiagnosticValue
112+
│ └── cameraPermissionDenied?: LatestDiagnosticValue
113+
114+
└── remote: RemoteDiagnostics
115+
├── isSendingDiagnosticsEnabled: boolean
116+
├── startSendingDiagnostics()
117+
├── stopSendingDiagnostics()
118+
├── getLatest(): RemoteParticipantDiagnosticsData
119+
├── on('diagnosticChanged', listener)
120+
├── off('diagnosticChanged', listener)
121+
└── RemoteParticipantDiagnosticsData
122+
└── diagnostics: RemoteDiagnostic
123+
82124
To utilize user facing diagnostics, first thing you must do is instantiate the user facing diagnostics feature from the call.
83125
```js
84126
const userFacingDiagnostics = call.feature(Features.UserFacingDiagnostics);
@@ -311,4 +353,4 @@ console.log(
311353
`value type = ${latestRemoteDiagnostics.cameraStoppedUnexpectedly.valueType}`
312354
);
313355

314-
```
356+
```

0 commit comments

Comments
 (0)