Skip to content

Commit ae1fa1f

Browse files
authored
Merge pull request #223829 from sloanster/patch-10
Create get-started-video-effects.md
2 parents a681918 + 6d4a97e commit ae1fa1f

File tree

3 files changed

+33
-6
lines changed

3 files changed

+33
-6
lines changed
Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
---
2+
title: Quickstart - Add video effects to your video calls
3+
titleSuffix: An Azure Communication Services quickstart
4+
description: Learn how to add video effects in your video calls using Azure Communication Services.
5+
author: sloanster
6+
7+
ms.author: micahvivion
8+
manager: nmurav
9+
ms.date: 01/09/2023
10+
ms.topic: quickstart
11+
ms.service: azure-communication-services
12+
ms.subservice: calling
13+
ms.custom: mode-other
14+
---
15+
16+
17+
# QuickStart: Add video effects to your video calls
18+
[!INCLUDE [Video effects with JavaScript](./includes/video-effects/video-effects-javascript.md)]
19+
20+
21+
## Next steps
22+
For more information, see the following articles:
23+
24+
- Check out our [calling hero sample](../../samples/calling-hero-sample.md)
25+
- Get started with the [UI Library](https://aka.ms/acsstorybook)
26+
- Learn about [Calling SDK capabilities](./getting-started-with-calling.md?pivots=platform-web)
27+
- Learn more about [how calling works](../../concepts/voice-video-calling/about-call-types.md)

articles/communication-services/quickstarts/voice-video-calling/includes/video-effects/video-effects-javascript.md

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -5,14 +5,14 @@ description: Learn how to add video effects in your video calls using Azure Comm
55
author: sloanster
66

77
ms.author: micahvivion
8-
ms.date: 01/09/2023
8+
ms.date: 01/20/2023
99
ms.topic: quickstart
1010
ms.service: azure-communication-services
1111
ms.subservice: calling
1212
ms.custom: mode-other
1313
---
1414

15-
You can use the Video effects feature to add effects to your video in video calls.
15+
You can use the Video effects feature to add effects to your video in video calls. This feature enables developers to build background visual effects and background video replacement into the calling experience. 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 is especially useful the context of telehealth, where a provider or patient might want to obscure their surroundings to protect sensitive information or personally identifiable information. Background blur can be applied across all virtual appointment scenarios, including telebanking and virtual hearings, to protect user privacy. In addition to enhanced confidentiality, background blur allows for more creativity of expression, allowing users to upload custom backgrounds to host a more fun, personalized calling experience.
1616

1717
>[!IMPORTANT]
1818
> The Calling Video effects are available starting on the public preview version [1.9.1-beta.1](https://www.npmjs.com/package/@azure/communication-calling/v/1.9.1-beta.1) of the Calling SDK. Please ensure that you use this or a newer SDK when using video effects.
@@ -23,8 +23,6 @@ You can use the Video effects feature to add effects to your video in video call
2323
> [!NOTE]
2424
> The calling effect library cannot be used standalone and can only work when used with the Azure Communication Calling client library for WebJS (https://www.npmjs.com/package/@azure/communication-calling).
2525
26-
## Prerequisites
27-
- Setup Azure Communication Services to be able to start video calls. [Follow this guide](../video-calling/video-calling-javascript.md). You'll need the `LocalVideoStream` to be able to start effects.
2826

2927
## Using video effects
3028
### Install the package
@@ -66,7 +64,7 @@ videoEffectsFeatureApi.on(‘effectsError’, (error) => {
6664
});
6765
```
6866

69-
### Background blur:
67+
### Background blur
7068
```js
7169
// Create the effect instance
7270
const backgroundBlurEffect = new BackgroundBlurEffect();
@@ -80,7 +78,7 @@ if (backgroundBlurSupported) {
8078
}
8179
```
8280

83-
### Background replacement with an image:
81+
### Background replacement with an image
8482
You need to provide the URL of the image you want as the background to this effect.
8583
> [!IMPORTANT]
8684
> The `startEffects` method will fail if the URL is not of an image or is unreachable/unreadable.

articles/communication-services/toc.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -87,6 +87,8 @@ items:
8787
href: quickstarts/voice-video-calling/get-started-volume-indicator.md
8888
- name: Raw media access
8989
href: quickstarts/voice-video-calling/get-started-raw-media-access.md
90+
- name: Modifying and replacing the background image
91+
href: quickstarts/voice-video-calling/get-started-video-effects.md
9092
- name: Call Automation
9193
items:
9294
- name: Handle an inbound phone call

0 commit comments

Comments
 (0)