Skip to content

Commit cf8a601

Browse files
Merge pull request #272565 from kevinlg-mstdl/patch-2
Rewamp of manage-call-web.md
2 parents 4555ccf + 8980bc5 commit cf8a601

File tree

1 file changed

+16
-16
lines changed

1 file changed

+16
-16
lines changed

articles/communication-services/how-tos/calling-sdk/includes/manage-calls/manage-calls-web.md

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ Call creation and start are synchronous. The `call` instance allows you to subsc
1717

1818
To call another Communication Services user, use the `startCall` method on `callAgent` and pass the recipient's `CommunicationUserIdentifier` that you [created with the Communication Services administration library](../../../../quickstarts/identity/access-tokens.md).
1919

20-
For a 1:1 call to a user, use the following code:
20+
For a "1:1" call to a user, use the following code:
2121

2222
```js
2323
const userCallee = { communicationUserId: '<ACS_USER_ID>' }
@@ -111,7 +111,7 @@ callAgentInstance.on('incomingCall', incomingCallHandler);
111111

112112
The `incomingCall` event includes an `incomingCall` instance that you can accept or reject.
113113

114-
When starting, joining, or accepting a call with video on, if the camera is being used by another process or if it's disabled in the operating system, the call starts with video off, and a cameraStartFailed: true call diagnostic is raised.
114+
The Azure Communication Calling SDK raises a cameraStartFailed: true call diagnostic if the camera isn't available when starting, accepting, or joining a call with video enabled. In this case, the call starts with video off. The camera might not be available because it's being used by another process or because it's disabled in the operating system.
115115

116116
## Hold and resume call
117117

@@ -124,15 +124,15 @@ To hold the call
124124
```js
125125
await call.hold();
126126
```
127-
When `hold` API resolves, the call state will be set to `LocalHold`, if this is a 1:1 call, the other participant will be also put on hold, and state of the call from the perspective of that participant will be set to 'RemoteHold'. The other participant may further put its call on hold, which would result in state change to `LocalHold`.
128-
If this is a group call - the `hold` is just a local operation, it won't hold the call for other participants of that call.
129-
To fully resume that call all users who initiated hold must resume it.
127+
When `hold` API resolves, the call state is set to `LocalHold`. In a 1:1 call, the other participant is also put on hold, and state of the call from the perspective of that participant is set to 'RemoteHold'. Later, the other participant might put its call on hold, which would result in a state change to `LocalHold`.
128+
In a group call or meeting - the `hold` is a local operation, it doesn't hold the call for other call participants.
129+
To resume the call all users who initiated hold must resume it.
130130

131131
To resume call from hold:
132132
```
133133
await call.resume();
134134
```
135-
When the `resume` API resolves, the call state will be set again to `Connected`.
135+
When the `resume` API resolves, the call state is set again to `Connected`.
136136

137137
## Mute and unmute a call
138138

@@ -158,7 +158,7 @@ await call.muteIncomingAudio();
158158
await call.unmuteIncomingAudio();
159159
```
160160

161-
When incoming audio is muted, the participant client SDK will still receive the call audio (remote participant's audio). The call audio won't be heard in the speaker and the participant won't be able to listen until 'call.unmuteIncomingAudio()' is called. However, we can apply filter on call audio and play the filtered audio.
161+
When incoming audio is muted, the participant client SDK still receives the call audio (remote participant's audio). The call audio isn't heard in the speaker and the participant isn't able to listen until 'call.unmuteIncomingAudio()' is called. However, we can apply filter on call audio and play the filtered audio.
162162

163163
## Mute other participants
164164
> [!NOTE]
@@ -176,7 +176,7 @@ await call.remoteParticipants[0].mute();
176176

177177
## Manage remote participants
178178

179-
All remote participants are detailed in the `RemoteParticipant` API and available through the `remoteParticipants` collection on a call instance.
179+
All remote participants are detailed in the `RemoteParticipant` object and available through the `remoteParticipants` collection on a call instance. The `remoteParticipants` is accessible from a `Call` instance.
180180

181181
### List the participants in a call
182182

@@ -244,7 +244,7 @@ const state = remoteParticipant.state;
244244
```
245245
Note:
246246
- This property is only set when adding a remote participant via the Call.addParticipant() API, and the remote participant declines for example.
247-
- In the scenario, where for example, UserB kicks UserC, from UserA's perspective, UserA won't see this flag get set for UserC. In other words UserA won't see UserC's callEndReason property get set at all.
247+
- In the scenario, where UserB kicks UserC, from UserA's perspective, UserA doesn't see this flag get set for UserC. In other words, UserA doesn't see UserC's callEndReason property get set at all.
248248

249249
- `isMuted` status: To find out if a remote participant is muted, check the `isMuted` property. It returns `Boolean`.
250250

@@ -272,7 +272,7 @@ const state = remoteParticipant.state;
272272
```js
273273
const endpointDetails: EndpointDetails[] = remoteParticipant.endpointDetails;
274274
```
275-
*Note: A remote participant could be in the call from many endpoints, and each endpoint will have its own unique `participantId`. `participantId` is different from the RemoteParticipant.identifier's raw Id.*
275+
*Note: A remote participant could be in the call from many endpoints, and each endpoint has its own unique `participantId`. `participantId` is different from the RemoteParticipant.identifier's raw ID.*
276276
277277
## Check call properties
278278
@@ -281,11 +281,11 @@ Get the unique ID (string) for a call:
281281
const callId: string = call.id;
282282
```
283283
284-
Get the local participant Id:
284+
Get the local participant ID:
285285
```js
286286
const participantId: string = call.info.participantId;
287287
```
288-
*Note: An Azure Communication Services identity can use the web calling sdk in many endpoints, and each endpoint will have its own unique `participantId`. `participantId` is different from the Azure Communication Services identity raw Id.*
288+
*Note: An Azure Communication Services identity can use the web calling SDK in many endpoints, and each endpoint has its own unique `participantId`. `participantId` is different from the Azure Communication Services identity raw ID.*
289289
290290
Retrieve the thread ID if joining a Teams meeting:
291291
```js
@@ -323,8 +323,8 @@ This returns a string representing the current state of a call:
323323
- `Ringing`: For an outgoing call, indicates that a call is ringing for remote participants. It's `Incoming` on their side.
324324
- `EarlyMedia`: Indicates a state in which an announcement is played before the call is connected.
325325
- `Connected`: Indicates that the call is connected.
326-
- `LocalHold`: Indicates that the call is put on hold by a local participant. No media is flowing between the local endpoint and remote participants.
327-
- `RemoteHold`: Indicates that the call was put on hold by remote participant. No media is flowing between the local endpoint and remote participants.
326+
- `LocalHold`: Indicates that a local participant the call put the call on hold. No media is flowing between the local endpoint and remote participants.
327+
- `RemoteHold`: Indicates that a remote participant the call put the call on hold. No media is flowing between the local endpoint and remote participants.
328328
- `InLobby`: Indicates that user is in lobby.
329329
- `Disconnecting`: Transition state before the call goes to a `Disconnected` state.
330330
- `Disconnected`: Final call state. If the network connection is lost, the state changes to `Disconnected` after two minutes.
@@ -344,7 +344,7 @@ const isIncoming = call.direction == 'Incoming';
344344
const isOutgoing = call.direction == 'Outgoing';
345345
```
346346

347-
Inspect the active video streams and active screen sharing streams by checking the `localVideoStreams` collection. The `localVideoStreams` API returns `LocalVideoStream` objects or type `Video`, `ScreenSharing` or `RawMedia`.
347+
Inspect the active video streams and active screen sharing streams by checking the `localVideoStreams` collection. The `localVideoStreams` API returns `LocalVideoStream` objects of type `Video`, `ScreenSharing`, or `RawMedia`.
348348

349349
```js
350350
const localVideoStreams = call.localVideoStreams;
@@ -359,7 +359,7 @@ const muted = call.isMuted;
359359
Check if the current incoming audio (speaker) is muted. It returns `Boolean`.
360360

361361
```js
362-
const incomingAudioMuted = call._isIncomingAudioMuted;
362+
const incomingAudioMuted = call.isIncomingAudioMuted;
363363
```
364364

365365
Check if video is on. It returns `Boolean`.

0 commit comments

Comments
 (0)