Skip to content

Commit a5fb0ea

Browse files
Merge pull request #287282 from allchiang-msft/allchiang-msft/mute-others-native-ga-callingsdkdoc
[ACS][Calling SDK][Native] Release Soft Mute/Mute Others to GA
2 parents de216f8 + 282fd47 commit a5fb0ea

File tree

4 files changed

+64
-65
lines changed

4 files changed

+64
-65
lines changed

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

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -172,24 +172,6 @@ call.mute(appContext).get();
172172
call.unmute(appContext).get();
173173
```
174174

175-
## Mute other participants
176-
> [!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.8 or higher.
178-
179-
To mute all other participants in a call, use the `muteAllRemoteParticipants` API on the call.
180-
181-
```java
182-
call.muteAllRemoteParticipants();
183-
```
184-
185-
To mute a specific remote participant, use the `mute` API on a given remote participant.
186-
187-
```java
188-
remoteParticipant.mute();
189-
```
190-
191-
To notify the local participant they have been muted by others, subscribe to the `onMutedByOthers` event.
192-
193175
## Change the volume of the call
194176

195177
While you are in a call, the hardware volume keys on the phone should allow the user to change the call volume.
@@ -281,6 +263,24 @@ State can be one of
281263
```java
282264
List<RemoteVideoStream> videoStreams = remoteParticipant.getVideoStreams(); // [RemoteVideoStream, RemoteVideoStream, ...]
283265
```
266+
### Mute other participants
267+
> [!NOTE]
268+
> To use this API please use the Azure Communication Services Calling Android SDK version 2.11.0 or higher.
269+
270+
To mute all other participants in a call, use the `muteAllRemoteParticipants` API on the call.
271+
272+
```java
273+
call.muteAllRemoteParticipants();
274+
```
275+
276+
To mute a specific remote participant, use the `mute` API on a given remote participant.
277+
278+
```java
279+
remoteParticipant.mute();
280+
```
281+
282+
To notify the local participant they have been muted by others, subscribe to the `onMutedByOthers` event.
283+
284284
## Using Foreground Services
285285

286286
In cases when you want to run a user visible task even when your application is in background, you can use [Foreground Services](https://developer.android.com/guide/components/foreground-services).

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

Lines changed: 30 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -178,36 +178,6 @@ call!.unmute { (error) in
178178
}
179179
```
180180

181-
## Mute other participants
182-
> [!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.9.0-beta.1 or higher.
184-
185-
To mute all other participants in a call, use the `muteAllRemoteParticipants` API on the call.
186-
187-
```swift
188-
call!.muteAllRemoteParticipants { (error) in
189-
if error == nil {
190-
print("Successfully muted all remote participants.")
191-
} else {
192-
print("Failed to mute remote participants.")
193-
}
194-
}
195-
```
196-
197-
To mute a specific remote participant, use the `mute` API on a given remote participant.
198-
199-
```swift
200-
remoteParticipant.mute { (error) in
201-
if error == nil {
202-
print("Successfully muted participant.")
203-
} else {
204-
print("Failed to mute participant.")
205-
}
206-
}
207-
```
208-
209-
To notify the local participant they have been muted by others, subscribe to the `onMutedByOthers` event.
210-
211181
## Manage remote participants
212182

213183
All remote participants are represented by the `RemoteParticipant` type and are available through the `remoteParticipants` collection on a call instance.
@@ -263,3 +233,33 @@ var isSpeaking = remoteParticipant.isSpeaking
263233
// RemoteVideoStream[] - collection of video streams this participants has
264234
var videoStreams = remoteParticipant.videoStreams // [RemoteVideoStream, RemoteVideoStream, ...]
265235
```
236+
237+
### Mute other participants
238+
> [!NOTE]
239+
> To use this API please use the Azure Communication Services Calling iOS SDK version 2.13.0 or higher.
240+
241+
To mute all other participants in a call, use the `muteAllRemoteParticipants` API on the call.
242+
243+
```swift
244+
call!.muteAllRemoteParticipants { (error) in
245+
if error == nil {
246+
print("Successfully muted all remote participants.")
247+
} else {
248+
print("Failed to mute remote participants.")
249+
}
250+
}
251+
```
252+
253+
To mute a specific remote participant, use the `mute` API on a given remote participant.
254+
255+
```swift
256+
remoteParticipant.mute { (error) in
257+
if error == nil {
258+
print("Successfully muted participant.")
259+
} else {
260+
print("Failed to mute participant.")
261+
}
262+
}
263+
```
264+
265+
To notify the local participant they have been muted by others, subscribe to the `onMutedByOthers` event.

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

Lines changed: 15 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -160,22 +160,6 @@ await call.unmuteIncomingAudio();
160160

161161
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

163-
## Mute other participants
164-
> [!NOTE]
165-
> To use this API please use Azure Communication Services Calling Web SDK version 1.26.1 or higher.
166-
167-
To mute all other participants or mute a specific participant who are connected to a call, 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.
168-
169-
*Note: The scenarios to mute PSTN (phone number) participants or 1:1 call participants are not supported.*
170-
171-
```js
172-
//mute all participants except yourself
173-
await call.muteAllRemoteParticipants();
174-
175-
//mute a specific participant
176-
await call.remoteParticipants[0].mute();
177-
```
178-
179163
## Manage remote participants
180164

181165
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.
@@ -277,6 +261,21 @@ const state = remoteParticipant.state;
277261
```
278262
*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.*
279263
264+
### Mute other participants
265+
> [!NOTE]
266+
> To use this API please use Azure Communication Services Calling Web SDK version 1.26.1 or higher.
267+
268+
To mute all other participants or mute a specific participant who are connected to a call, 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.
269+
270+
*Note: The scenarios to mute PSTN (phone number) participants or 1:1 call participants are not supported.*
271+
272+
```js
273+
//mute all participants except yourself
274+
await call.muteAllRemoteParticipants();
275+
276+
//mute a specific participant
277+
await call.remoteParticipants[0].mute();
278+
```
280279
## Check call properties
281280
282281
Get the unique ID (string) for a call:

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

Lines changed: 1 addition & 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.6.0-beta.1 or higher.
144+
> To use this API please use the Azure Communication Services Calling Windows SDK version 1.9.0 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

0 commit comments

Comments
 (0)