Skip to content

Commit 2e09815

Browse files
Merge pull request #273452 from allchiang-msft/allchiang-msft/mute-others-calling-sdk-event
Update documentation for soft mute for ACS Calling SDKs
2 parents 3ed3a87 + b94b55c commit 2e09815

File tree

4 files changed

+10
-5
lines changed

4 files changed

+10
-5
lines changed

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

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -174,7 +174,7 @@ call.unmute(appContext).get();
174174

175175
## Mute other participants
176176
> [!NOTE]
177-
> This API is provided as a public 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 Android SDK version 2.6.0-beta.5 or higher.
177+
> This API is provided as a public 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 Android SDK version 2.6.0-beta.8 or higher.
178178
179179
To mute all other participants in a call, use the `muteAllRemoteParticipants` API on the call.
180180

@@ -188,6 +188,8 @@ To mute a specific remote participant, use the `mute` API on a given remote part
188188
remoteParticipant.mute();
189189
```
190190

191+
To notify the local participant they have been muted by others, subscribe to the `onMutedByOthers` event.
192+
191193
## Change the volume of the call
192194

193195
While you are in a call, the hardware volume keys on the phone should allow the user to change the call volume.

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

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -180,7 +180,7 @@ call!.unmute { (error) in
180180

181181
## Mute other participants
182182
> [!NOTE]
183-
> This API is provided as a public 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 iOS SDK version 2.7.0-beta.3 or higher.
183+
> This API is provided as a public 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 iOS SDK version 2.9.0-beta.1 or higher.
184184
185185
To mute all other participants in a call, use the `muteAllRemoteParticipants` API on the call.
186186

@@ -206,6 +206,7 @@ remoteParticipant.mute { (error) in
206206
}
207207
```
208208

209+
To notify the local participant they have been muted by others, subscribe to the `onMutedByOthers` event.
209210

210211
## Manage remote participants
211212

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -162,9 +162,9 @@ When incoming audio is muted, the participant client SDK still receives the call
162162

163163
## Mute other participants
164164
> [!NOTE]
165-
> 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 version 1.18.1 or higher.
165+
> 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 version 1.24.1 or higher.
166166
167-
To mute all other participants or mute a specific participant, you can use the asynchronous APIs `muteAllRemoteParticipants` on the call and `mute` on the remote participant:
167+
To mute all other participants or mute a specific participant, you can use the asynchronous APIs `muteAllRemoteParticipants` on the call and `mute` on the remote participant. The `mutedByOthers` event from Call is raised when the local participant has been muted by others.
168168

169169
```js
170170
//mute all participants except yourself

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

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -141,7 +141,7 @@ await this.call.UnmuteOutgoingAudioAsync();
141141

142142
## Mute other participants
143143
> [!NOTE]
144-
> This API is provided as a public 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 Windows SDK version 1.4.0-beta.1 or higher.
144+
> This API is provided as a public 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 Windows SDK version 1.6.0-beta.1 or higher.
145145
146146
To mute all other participants or mute a specific participant, you can use the asynchronous APIs `MuteAllRemoteParticipantsAsync` on the call and `MuteAsync` on the remote participant:
147147

@@ -153,6 +153,8 @@ await this.call.MuteAllRemoteParticipantsAsync();
153153
await this.call.RemoteParticipants.FirstOrDefault().MuteAsync();
154154
```
155155

156+
To notify the local participant they have been muted by others, subscribe to the `MutedByOthers` event.
157+
156158
## End a call
157159

158160
Once a call is placed, the `HangupAsync` method of the `CommunicationCall` object should be used to hang up the call.

0 commit comments

Comments
 (0)