Skip to content

Commit 3a5cc38

Browse files
authored
Update video-effects-javascript.md
1 parent 5e2dc48 commit 3a5cc38

File tree

1 file changed

+11
-2
lines changed

1 file changed

+11
-2
lines changed

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

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,15 @@ ms.custom: mode-other
1414

1515
You can use the Video effects feature to add effects to your video in video calls.
1616

17+
>[!IMPORTANT]
18+
> 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.
19+
20+
> [!NOTE]
21+
> This API is provided as a preview ('beta') for developers and may change based on feedback that we receive.
22+
23+
> [!NOTE]
24+
> 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).
25+
1726
## Prerequisites
1827
- 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.
1928

@@ -32,7 +41,7 @@ npm install @azure/communication-calling-effects --save
3241
> - Background replacement with an image
3342
>
3443
35-
To use video effects with the Azure Communication Calling SDK, once you have created a `LocalVideoStream`, you need to get the `VideoEffects` feature API of the `LocalVideoStream` to start/stop video effects:
44+
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 start/stop video effects:
3645
```js
3746
import * as AzureCommunicationCallingSDK from '@azure/communication-calling';
3847

@@ -98,7 +107,7 @@ if (backgroundReplacementSupported) {
98107
}
99108
```
100109

101-
Changing the image for this effect can be done by passing it in in the configure method:
110+
Changing the image for this effect can be done by passing it via the configure method:
102111
```js
103112
const newBackgroundImage = 'https://linkToNewImageFile';
104113

0 commit comments

Comments
 (0)