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/quickstarts/voice-video-calling/includes/video-effects/video-effects-android.md
+12-12Lines changed: 12 additions & 12 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,11 +1,11 @@
1
1
---
2
-
title: Quickstart - Add video effects to your video calls (Android)
3
-
titleSuffix: An Azure Communication Services quickstart
4
-
description: Learn how to add video effects in your video calls using Azure Communication Services.
2
+
title: Enable video background effects
3
+
titleSuffix: An Azure Communication Services article
4
+
description: This article describes how to add video effects in your video calls using Azure Communication Services.
5
5
author: jsaurezlee
6
6
7
7
ms.author: micahvivion
8
-
ms.date: 04/04/2023
8
+
ms.date: 06/24/2025
9
9
ms.topic: quickstart
10
10
ms.service: azure-communication-services
11
11
ms.subservice: calling
@@ -17,7 +17,7 @@ ms.custom: mode-other
17
17
18
18
You can use the Video Effects feature to add effects to your video in video calls. Background blur provides users with the mechanism to remove distractions behind a participant so that participants can communicate without disruptive activity or confidential information in the background. This feature is especially useful the context of telehealth, where a provider or patient might want to obscure their surroundings to protect sensitive information or personal data. Background blur can be applied across all virtual appointment scenarios, including telebanking and virtual hearings, to protect user privacy.
19
19
20
-
This quickstart builds on [Quickstart: Add 1:1 video calling to your app](../../get-started-with-video-calling.md?pivots=platform-android) for Android.
20
+
This article builds on [Add 1:1 video calling to your app](../../get-started-with-video-calling.md?pivots=platform-android) for Android.
21
21
22
22
## Using video effects
23
23
@@ -30,17 +30,17 @@ The `VideoEffectsLocalVideoStreamFeature` object has the following API structure
30
30
31
31
-`enableEffect`: Enables a Video Effect on the `LocalVideoStream` instance.
32
32
-`disableEffect`: Disables a Video Effect on the `LocalVideoStream` instance.
33
-
-`OnVideoEffectEnabledListener`: Event that is triggered when a Video Effect has been enabled successfully.
34
-
-`OnVideoEffectDisabledListener`: Event that is triggered when a Video Effect has been disabled successfully.
33
+
-`OnVideoEffectEnabledListener`: Event that is triggered when a Video Effect is enabled successfully.
34
+
-`OnVideoEffectDisabledListener`: Event that is triggered when a Video Effect is disabled successfully.
35
35
-`OnVideoEffectErrorListener`: Event that is triggered when a Video Effect operation fails.
36
36
37
-
The `VideoEffectEnabledEvent`, `VideoEffectDisabledEvent` and `VideoEffectErrorEvent` objects have the following API structure:
37
+
The `VideoEffectEnabledEvent`, `VideoEffectDisabledEvent`, and `VideoEffectErrorEvent` objects have the following API structure:
38
38
39
-
-`getVideoEffectName`: Gets the name of the Video Effect that triggered the event.
39
+
-`getVideoEffectName`: Gets the name of the Video Effect that triggered the event.
40
40
41
41
Once you have the `VideoEffectsLocalVideoStreamFeature` object, you can subscribe to the events:
42
42
43
-
To use Video Effects with the Azure Communication Calling SDK, once you've created a `LocalVideoStream`, you need to get the `VideoEffects` feature API of the `LocalVideoStream` to enable/disable Video Effects:
43
+
To use Video Effects with the Azure Communication Calling SDK, once you create a `LocalVideoStream`, you need to get the `VideoEffects` feature API of the `LocalVideoStream` to enable/disable Video Effects:
44
44
45
45
```java
46
46
// Obtain the Video Effects feature from the LocalVideoStream object that is sending the video.
Background Blur is a Video Effect that allows a person's background to be blurred. In order to use Background Video Effect, you need to obtain a `VideoEffectsLocalVideoStreamFeature` feature from a valid `LocalVideoStream`.
74
+
Background Blur is a Video Effect that enables the application to blue a person's background. In order to use Background Video Effect, you need to obtain a `VideoEffectsLocalVideoStreamFeature` feature from a valid `LocalVideoStream`.
Copy file name to clipboardExpand all lines: articles/communication-services/quickstarts/voice-video-calling/includes/video-effects/video-effects-ios.md
+51-34Lines changed: 51 additions & 34 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,9 +1,25 @@
1
+
---
2
+
title: Enable video background effects
3
+
titleSuffix: An Azure Communication Services article
4
+
description: This article describes how to add video effects in your video calls using Azure Communication Services.
5
+
author: sloanster
6
+
7
+
ms.author: micahvivion
8
+
ms.date: 06/24/2025
9
+
ms.topic: quickstart
10
+
ms.service: azure-communication-services
11
+
ms.subservice: calling
12
+
ms.custom: mode-other
13
+
---
14
+
1
15
> [!Note]
2
-
> In order to use Video Effects on the iOS Calling SDK, a machine learning model is downloaded to the customer's device. We encourage you to review the privacy notes in your application and update them accordingly, if necessary.
16
+
> To use Video Effects on the iOS Calling SDK, Azure Communication Services downloads a machine learning model to the customer's device. We encourage you to review the privacy notes in your application and update them accordingly, if necessary.
17
+
18
+
You can use the Video Effects feature to add effects to your video in video calls. Background blur provides users with the mechanism to remove distractions behind a participant so that participants can communicate without disruptive activity or confidential information in the background.
3
19
4
-
You can use the Video Effects feature to add effects to your video in video calls. Background blur provides users with the mechanism to remove distractions behind a participant so that participants can communicate without disruptive activity or confidential information in the background. This feature is especially useful the context of telehealth, where a provider or patient might want to obscure their surroundings to protect sensitive information or personal data. Background blur can be applied across all virtual appointment scenarios, including telebanking and virtual hearings, to protect user privacy.
20
+
This feature is most useful the context of telehealth, where a provider or patient might want to obscure their surroundings to protect sensitive information or personal data. Background blur can be applied across all virtual appointment scenarios, including telebanking and virtual hearings, to protect user privacy.
5
21
6
-
## Using video effects
22
+
## Implement video effects
7
23
8
24
> [!Note]
9
25
> Video effects support on iOS is limited to the **two** most recent major versions of iOS. For example, when a new, major version of iOS is released, the iOS requirement is the new version and the most recent versions that preceded it.
@@ -15,13 +31,13 @@ The `LocalVideoEffectsFeature` object has the following API structure:
15
31
-`enable`: Enables a Video Effect on the `LocalVideoStream` instance.
16
32
-`disable`: Disables a Video Effect on the `LocalVideoStream` instance.
17
33
-`isSupported`: Indicates if a Video Effect is supported on the `LocalVideoStream` instance.
18
-
-`onVideoEffectEnabled`: Event that is triggered when a Video Effect has been enabled successfully.
19
-
-`onVideoEffectDisabled`: Event that is triggered when a Video Effect has been disabled successfully.
34
+
-`onVideoEffectEnabled`: Event that is triggered when a Video Effect is enabled successfully.
35
+
-`onVideoEffectDisabled`: Event that is triggered when a Video Effect is disabled successfully.
20
36
-`onVideoEffectError`: Event that is triggered when a Video Effect operation fails.
21
37
22
38
Once you have the `LocalVideoEffectsFeature` object, you can subscribe to the events, events have the following delegates: `didEnableVideoEffect`, `didDisableVideoEffect`, `didReceiveVideoEffectError`.
23
39
24
-
To use Video Effects with the Azure Communication Calling SDK, once you've created a `LocalVideoStream`, you need to get the `VideoEffects` feature API of the `LocalVideoStream` to enable/disable Video Effects:
40
+
To use Video Effects with the Azure Communication Calling SDK, once you create a `LocalVideoStream`, you need to get the `VideoEffects` feature API of the `LocalVideoStream` to enable/disable Video Effects:
25
41
26
42
```swift
27
43
// Obtain the Video Effects feature from the LocalVideoStream object that is sending the video.
@@ -42,7 +58,7 @@ public func localVideoEffectsFeature(_ videoEffectsLocalVideoStreamFeature: Loca
42
58
}
43
59
```
44
60
45
-
and start using the APIs to enable and disable Video Effects:
61
+
Then start using the APIs to enable and disable Video Effects:
Background Blur is a Video Effect that allows a person's background to be blurred. In order to use Background Video Effect, you need to obtain a `LocalVideoEffectsFeature` feature from a valid `LocalVideoStream`.
70
+
Background Blur is a Video Effect that enables the application to blur a person's background. To use Background Video Effect, you need to obtain a `LocalVideoEffectsFeature` feature from a valid `LocalVideoStream`.
55
71
56
72
- Create a new Background Blur Video Effect object:
Background Replacement is a Video Effect that allows a person to set their own custom background. In order to use Background Replacement Effect, you need to obtain a `LocalVideoEffectsFeature` feature from a valid `LocalVideoStream`.
94
+
95
+
Background Replacement is a Video Effect that enables a person to set their own custom background. To use Background Replacement Effect, you need to obtain a `LocalVideoEffectsFeature` feature from a valid `LocalVideoStream`.
79
96
80
97
- Create a new Background Replacement Video Effect object:
0 commit comments