You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: articles/communication-services/concepts/voice-video-calling/includes/user-facing-diagnostics-web.md
+11-7Lines changed: 11 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -76,7 +76,7 @@ The following user-facing diagnostics are available:
76
76
77
77
## Accessing diagnostics
78
78
79
-
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) API. You can understand more about the `UserFacingDiagnosticsFeature` interface [here](/javascript/api/azure-communication-services/@azure/communication-calling/userfacingdiagnosticsfeature?view=azure-communication-services-js).
79
+
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).
To send remote UFDs to all participants on a call, you must first UDF's to sent. You enable or disable this on a per client basis. Once activated, the client will begin transmitting its local UFDs remotely to all participants for their consumption and processing. Please note that when the number of participants on a call exceeds 20, the transmission of remote UFDs from the local client will cease. This measure is in place to prevent excessive consumption of network bandwidth due to UFD traffic.
122
+
123
+
```js
124
+
// Start the local client to send its local UFD to all participants (send local UFD to remote clients).
125
+
remoteUfdsFeature.startSendingDiagnostics();
126
+
// Stop sending local UFDs to remote clients.
127
+
remoteUfdsFeature.stopSendingDiagnostics();
128
+
```
129
+
121
130
RemoteParticipantDiagnosticsData has the following data
122
131
- diagnostic contains array of diagnostics UFD that have been fired off on a remote machines. For example a UFD of `NetworkSendQuality`.
123
132
- value is `DiagnosticQuality` or `DiagnosticFlag`:
// Start sending local UFDs to remote clients. Must call this API so that local UFDs can start sending out and remote clients can receive them.
149
-
remoteUfdsFeature.startSendingDiagnostics();
150
-
// Stop sending local UFDs to remote clients.
151
-
remoteUfdsFeature.stopSendingDiagnostics();
152
156
```
153
157
154
158
155
-
## Raise the latest User Facing Diagnostics fired off
159
+
## Raise the latest User Facing Diagnostics event that was received:
156
160
157
161
Here's sample code to generate the latest diagnostic value raised by the calling SDK. If a diagnostic is undefined, it means the UFD has not been raised.
0 commit comments