Skip to content

Commit f687328

Browse files
Merge pull request #270984 from sloanster/patch-5
Update manage-calls-web.md
2 parents 5972575 + bdbfa45 commit f687328

File tree

1 file changed

+13
-20
lines changed

1 file changed

+13
-20
lines changed

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

Lines changed: 13 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,15 @@
11
---
2-
author: probableprime
2+
author: sloanster
33
ms.service: azure-communication-services
44
ms.topic: include
5-
ms.date: 09/08/2021
6-
ms.author: rifox
5+
ms.date: 03/02/2024
6+
ms.author: micahvivion
77
---
88
[!INCLUDE [Install SDK](../install-sdk/install-sdk-web.md)]
99

1010
## Place a call
1111

12-
To create and start a call, use one of the APIs on `callAgent` and provide a user that you've created through the Communication Services identity SDK.
12+
To create and start a call, use one of the APIs on `callAgent` and provide a user that you created through the Communication Services identity SDK.
1313

1414
Call creation and start are synchronous. The `call` instance allows you to subscribe to call events.
1515

@@ -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/accepting a call with video on, if the specified video camera device is being used by another process or if it's disabled in the system, the call starts with video off, and a cameraStartFailed: true call diagnostic will be raised.
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.
115115

116116
## Hold and resume call
117117

@@ -124,17 +124,17 @@ To hold the call
124124
```js
125125
await call.hold();
126126
```
127-
When `hold` API will resolve, call state will be set to 'LocalHold' , if this is a 1:1 call, other participant will be also put on hold, and state of the call from the perspective of that participant will be set to 'RemoteHold', That participant may further put its call on hold, which would result in state change to 'LocalHold'
128-
If this is a group call - hold is just a local operation, it won't hold the call for other participants of that call.
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.
129129
To fully resume that call all users who initiated hold must resume it.
130130

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

137-
## Mute and unmute
137+
## Mute and unmute a call
138138

139139
To mute or unmute the local endpoint, you can use the `mute` and `unmute` asynchronous APIs:
140140

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

161-
When incoming audio is muted, the participant will still receive the call audio (remote participant's audio). The call audio won't play 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 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.
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 represented by `RemoteParticipant` type and available through `remoteParticipants` collection on a call instance.
179+
All remote participants are detailed in the `RemoteParticipant` API and available through the `remoteParticipants` collection on a call instance.
180180

181181
### List the participants in a call
182182

@@ -188,7 +188,7 @@ call.remoteParticipants; // [remoteParticipant, remoteParticipant....]
188188

189189
### Add a participant to a call
190190

191-
To add a participant (either a user or a phone number) to a call, you can use `addParticipant`. Provide one of the `Identifier` types. It synchronously returns the `remoteParticipant` instance. The `remoteParticipantsUpdated` event from Call is raised when a participant is successfully added to the call.
191+
To add a participant (either a user or a phone number) to a call, you can use the `addParticipant` API. Provide one of the `Identifier` types. It synchronously returns the `remoteParticipant` instance. The `remoteParticipantsUpdated` event from Call is raised when a participant is successfully added to the call.
192192

193193
```js
194194
const userIdentifier = { communicationUserId: '<ACS_USER_ID>' };
@@ -277,29 +277,22 @@ const state = remoteParticipant.state;
277277
## Check call properties
278278
279279
Get the unique ID (string) for a call:
280-
281280
```js
282281
const callId: string = call.id;
283282
```
284283
285284
Get the local participant Id:
286-
> [!NOTE]
287-
> This API is provided as a preview for developers and may change based on feedback that we receive. To use this api please use 'beta' release of Azure Communication Services Calling Web SDK
288285
```js
289286
const participantId: string = call.info.participantId;
290287
```
291288
*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.*
292289
293290
Retrieve the thread ID if joining a Teams meeting:
294-
> [!NOTE]
295-
> This API is provided as a preview for developers and may change based on feedback that we receive. To use this api please use 'beta' release of Azure Communication Services Calling Web SDK
296291
```js
297292
const threadId: string | undefined = call.info.threadId;
298293
```
299294
300295
Get information about the call:
301-
> [!NOTE]
302-
> This API is provided as a preview for developers and may change based on feedback that we receive. To use this api please use 'beta' release of Azure Communication Services Calling Web SDK
303296
```js
304297
const callInfo = call.info;
305298
```
@@ -351,7 +344,7 @@ const isIncoming = call.direction == 'Incoming';
351344
const isOutgoing = call.direction == 'Outgoing';
352345
```
353346

354-
Inspect active video streams and active screen sharing streams by checking the `localVideoStreams` collection. It 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 or type `Video`, `ScreenSharing` or `RawMedia`.
355348

356349
```js
357350
const localVideoStreams = call.localVideoStreams;

0 commit comments

Comments
 (0)