@microsoft/teams-js 2.8.0 → 2.9.0-beta.0

package/dist/MicrosoftTeams.d.ts

@@ -6690,11 +6690,27 @@ export namespace video {
             * @beta
             */
         type VideoFrameCallback = (frame: VideoFrame, notifyVideoFrameProcessed: () => void, notifyError: (errorMessage: string) => void) => void;
+        /**
+            * Predefined failure reasons for preparing the selected video effect
+            * @beta
+            */
+        enum EffectFailureReason {
+                /**
+                    * A wrong effect id is provide.
+                    * Use this reason when the effect id is not found or empty, this may indicate a mismatch between the app and its manifest or a bug of the host.
+                    */
+                InvalidEffectId = "InvalidEffectId",
+                /**
+                    * The effect can't be initialized
+                    */
+                InitializationFailure = "InitializationFailure"
+        }
         /**
             * Video effect change call back function definition
+            * Return a Promise which will be resolved when the effect is prepared, or throw an {@link EffectFailureReason} on error.
             * @beta
             */
-        type VideoEffectCallBack = (effectId: string | undefined) => void;
+        type VideoEffectCallback = (effectId: string | undefined) => Promise<void>;
         /**
             * Register to read the video frames in Permissions section
             * @beta
@@ -6712,11 +6728,11 @@ export namespace video {
             */
         function notifySelectedVideoEffectChanged(effectChangeType: EffectChangeType, effectId: string | undefined): void;
         /**
-            * Register the video effect callback, host uses this to notify the video extension the new video effect will by applied
+            * Register a callback to be notified when a new video effect is applied.
             * @beta
-            * @param callback - The VideoEffectCallback to invoke when registerForVideoEffect has completed
+            * @param callback - Function to be called when new video effect is applied.
             */
-        function registerForVideoEffect(callback: VideoEffectCallBack): void;
+        function registerForVideoEffect(callback: VideoEffectCallback): void;
         /**
             * Checks if video capability is supported by the host
             * @beta

package/dist/MicrosoftTeams.js

@@ -2151,7 +2151,7 @@ var _minRuntimeConfigToUninitialize = {
 };
 
 ;// CONCATENATED MODULE: ./src/public/version.ts
-var version = "2.8.0";
+var version = "2.9.0-beta.0";
 
 ;// CONCATENATED MODULE: ./src/internal/internalAPIs.ts
 
@@ -7800,6 +7800,22 @@ var video;
          */
         EffectChangeType[EffectChangeType["EffectDisabled"] = 1] = "EffectDisabled";
     })(EffectChangeType = video.EffectChangeType || (video.EffectChangeType = {}));
+    /**
+     * Predefined failure reasons for preparing the selected video effect
+     * @beta
+     */
+    var EffectFailureReason;
+    (function (EffectFailureReason) {
+        /**
+         * A wrong effect id is provide.
+         * Use this reason when the effect id is not found or empty, this may indicate a mismatch between the app and its manifest or a bug of the host.
+         */
+        EffectFailureReason["InvalidEffectId"] = "InvalidEffectId";
+        /**
+         * The effect can't be initialized
+         */
+        EffectFailureReason["InitializationFailure"] = "InitializationFailure";
+    })(EffectFailureReason = video.EffectFailureReason || (video.EffectFailureReason = {}));
     /**
      * Register to read the video frames in Permissions section
      * @beta
@@ -7839,16 +7855,26 @@ var video;
     }
     video.notifySelectedVideoEffectChanged = notifySelectedVideoEffectChanged;
     /**
-     * Register the video effect callback, host uses this to notify the video extension the new video effect will by applied
+     * Register a callback to be notified when a new video effect is applied.
      * @beta
-     * @param callback - The VideoEffectCallback to invoke when registerForVideoEffect has completed
+     * @param callback - Function to be called when new video effect is applied.
      */
     function registerForVideoEffect(callback) {
         ensureInitialized(runtime, FrameContexts.sidePanel);
         if (!isSupported()) {
             throw errorNotSupportedOnPlatform;
         }
-        registerHandler('video.effectParameterChange', callback, false);
+        var effectParameterChangeHandler = function (effectId) {
+            callback(effectId)
+                .then(function () {
+                sendMessageToParent('video.videoEffectReadiness', [true, effectId]);
+            })
+                .catch(function (reason) {
+                var validReason = reason in EffectFailureReason ? reason : EffectFailureReason.InitializationFailure;
+                sendMessageToParent('video.videoEffectReadiness', [false, effectId, validReason]);
+            });
+        };
+        registerHandler('video.effectParameterChange', effectParameterChangeHandler, false);
         sendMessageToParent('video.registerForVideoEffect');
     }
     video.registerForVideoEffect = registerForVideoEffect;