Merge pull request #270129 from DaybreakQuip/patch-5

Update ACS Calling Video Effects

Author: Stacyrch140

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

@@ -120,3 +120,70 @@ public void disableBackgroundBlur() {
     videoEffectsFeature.disableEffect(backgroundBlurEffect);
 }
 ```
+
+### Background replacement
+
+Background Replacement is a Video Effect that allows a person's background to be replaced. In order to use Background Video Effect, you need to obtain a `VideoEffectsLocalVideoStreamFeature` feature from a valid `LocalVideoStream`.
+
+To enable Background Replacement Video Effect:
+
+- Create a method that obtains the `VideoEFfects` Feature subscribes to the events:
+
+```java
+private void handleOnVideoEffectEnabled(VideoEffectEnabledEvent args) {
+   Log.i("VideoEfects", "Effect enabled for effect " + args.getVideoEffectName());
+}
+private void handleOnVideoEffectDisabled(VideoEffectDisabledEvent args) {
+   Log.i("VideoEfects", "Effect disabled for effect " + args.getVideoEffectName());
+}
+private void handleOnVideoEffectError(VideoEffectErrorEvent args) {
+   Log.i("VideoEfects", "Error " + args.getCode() + ":" + args.getMessage()
+           + " for effect " + args.getVideoEffectName());
+}
+
+VideoEffectsLocalVideoStreamFeature videoEffectsFeature;
+public void createVideoEffectsFeature() {
+    videoEffectsFeature = currentVideoStream.feature(Features.LOCAL_VIDEO_EFFECTS);
+    videoEffectsFeature.addOnVideoEffectEnabledListener(this::handleOnVideoEffectEnabled);
+    videoEffectsFeature.addOnVideoEffectDisabledListener(this::handleOnVideoEffectDisabled);
+    videoEffectsFeature.addOnVideoEffectErrorListener(this::handleOnVideoEffectError);
+}
+
+```
+
+- Create a new Background Replacement Video Effect object:
+
+```java
+BackgroundReplacementEffect backgroundReplacementVideoEffect = new BackgroundReplacementEffect();
+```
+
+- Set a custom background by passing in the image through a buffer.
+
+```java
+//example of where we can get an image from, in this case, this is from assets in Android folder
+InputStream inputStream = getAssets().open("image.jpg");
+Bitmap bitmap = BitmapFactory.decodeStream(inputStream);
+ByteArrayOutputStream stream = new ByteArrayOutputStream();
+bitmap.compress(Bitmap.CompressFormat.JPEG, 100, stream);
+byte[] data = stream.toByteArray();
+ByteBuffer dataBuffer = ByteBuffer.allocateDirect(data.length);
+dataBuffer.put(data);
+dataBuffer.rewind();
+backgroundReplacementVideoEffect.setBuffer(dataBuffer);
+```
+
+- Call `EnableEffect` on the `videoEffectsFeature` object:
+
+```java
+public void enableBackgroundReplacement() {
+    videoEffectsFeature.enableEffect(backgroundReplacementVideoEffect);
+}
+```
+
+To disable Background Replacement Video Effect:
+
+```java
+public void disableBackgroundReplacement() {
+    videoEffectsFeature.disableEffect(backgroundReplacementVideoEffect);
+}
+```

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

@@ -73,3 +73,37 @@ To disable Background Blur Video Effect:
 ```swift
 localVideoEffectsFeature.disable(effect: backgroundBlurVideoEffect)
 ```
+
+### Background Replacement
+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`.
+
+- Create a new Background Replacement Video Effect object:
+
+```swift
+@State var backgroundReplacementVideoEffect: BackgroundReplacementEffect?
+```
+
+- Set a custom background by passing in the image through a buffer.
+
+```swift
+let image = UIImage(named:"image.png")
+guard let imageData = image?.jpegData(compressionQuality: 1.0) else {
+return
+}
+backgroundReplacementVideoEffect.buffer = imageData
+```
+
+- Check if `BackgroundReplacementEffect` is supported and call `Enable` on the `videoEffectsFeature` object:
+
+```swift
+if((localVideoEffectsFeature.isSupported(effect: backgroundReplacementVideoEffect)) != nil)
+{
+    localVideoEffectsFeature.enable(effect: backgroundReplacementVideoEffect)
+}
+```
+
+To disable Background Replacement Video Effect:
+
+```swift
+localVideoEffectsFeature.disable(effect: backgroundReplacementVideoEffect)
+```

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

@@ -158,3 +158,96 @@ private async void BackgroundBlur_Click(object sender, RoutedEventArgs e)
     }
 }
 ```
+
+### Background replacement
+
+Background Replacement is a Video Effect that allows a person's background to be replaced. In order to use Background Video Effect, you need to obtain a `VideoEffectsLocalVideoStreamFeature` feature from a valid `LocalVideoStream`.
+
+To enable Background Replacement Video Effect:
+
+- Add the `BackgroundReplacementEffect` instance to the MainPage.
+
+```C#
+public sealed partial class MainPage : Page
+{
+    private BackgroundReplacementEffect backgroundReplacementVideoEffect = new BackgroundReplacementEffect();
+}
+```
+
+- Create a method that obtains the `VideoEFfects` Feature subscribes to the events:
+
+```C#
+private async void LocalVideoEffectsFeature_VideoEffectEnabled(object sender, VideoEffectEnabledEventArgs e)
+{
+    await Dispatcher.RunAsync(Windows.UI.Core.CoreDispatcherPriority.Normal, async () =>
+    {
+        BackgroundReplacement.IsChecked = true;
+    });
+}
+
+private async void LocalVideoEffectsFeature_VideoEffectDisabled(object sender, VideoEffectDisabledEventArgs e)
+{
+    await Dispatcher.RunAsync(Windows.UI.Core.CoreDispatcherPriority.Normal, async () =>
+    {
+        BackgroundReplacement.IsChecked = false;
+    });
+}
+
+private void LocalVideoEffectsFeature_VideoEffectError(object sender, VideoEffectErrorEventArgs e)
+{
+    String effectName = args.VideoEffectName;
+    String errorCode = args.Code;
+    String errorMessage = args.Message;
+
+    Trace.WriteLine("VideoEffects VideoEffectError on effect " + effectName + "with code "
+        + errorCode + "and error message " + errorMessage);
+}
+```
+
+- Set a custom background by passing in the image through a buffer.
+
+```C#
+//example of getting the image from storage folder
+MemoryBuffer memoryBuffer = new MemoryBuffer(0);
+StorageFolder InstallationFolder = Windows.ApplicationModel.Package.Current.InstalledLocation;
+StorageFile file = InstallationFolder.GetFileAsync("image.jpg").GetAwaiter().GetResult();
+if (File.Exists(file.Path))
+{
+    byte[] imageBytes = File.ReadAllBytes(file.Path);
+    memoryBuffer = new MemoryBuffer((uint)imageBytes.Length);
+    using (IMemoryBufferReference reference = memoryBuffer.CreateReference())
+    {
+        byte* dataInBytes;
+        uint capacityInBytes;
+
+        (reference.As<IMemoryBufferByteAccess>()).GetBuffer(out dataInBytes, out capacityInBytes);
+        for (int i = 0; i < imageBytes.Length; i++)
+        {
+            dataInBytes[i] = imageBytes[i];
+        }
+    }
+    return memoryBuffer;
+}
+backgroundReplacementVideoEffect.Buffer = memoryBuffer;
+```
+
+
+- Enable and disable the Background Replacement effect:
+
+```C#
+private async void BackgroundReplacement_Click(object sender, RoutedEventArgs e)
+{
+    if (localVideoEffectsFeature.IsEffectSupported(backgroundReplacementVideoEffect))
+    {
+        var backgroundReplacementCheckbox = sender as CheckBox;
+        if (backgroundReplacementCheckbox.IsChecked.Value)
+        {
+            localVideoEffectsFeature.EnableEffect(backgroundReplacementVideoEffect);
+        }
+        else
+        {
+            localVideoEffectsFeature.DisableEffect(backgroundReplacementVideoEffect);
+        }
+    }
+}
+```