@microsoft/teams-js 2.10.0 → 2.10.1-beta.0

package/README.md

@@ -24,7 +24,7 @@ To install the stable [version](https://learn.microsoft.com/javascript/api/overv
 
 ### Production
 
-You can reference these files directly [from here](https://res.cdn.office.net/teams-js/2.10.0/js/MicrosoftTeams.min.js) or point your package manager at them.
+You can reference these files directly [from here](https://res.cdn.office.net/teams-js/2.10.1/js/MicrosoftTeams.min.js) or point your package manager at them.
 
 ## Usage
 
@@ -45,13 +45,13 @@ Reference the library inside of your `.html` page using:
 ```html
 <!-- Microsoft Teams JavaScript API (via CDN) -->
 <script
-  src="https://res.cdn.office.net/teams-js/2.10.0/js/MicrosoftTeams.min.js"
-  integrity="sha384-7ZMvcfeIUPV84BQMdPBAJDk+zIac00KLvdNWZGZ0nF8FIDH0YE80EKj4ilp/VwZ1"
+  src="https://res.cdn.office.net/teams-js/2.10.1/js/MicrosoftTeams.min.js"
+  integrity="sha384-Tc1x2xjzm4vRqLV4l416qPm+i7t8ujpxrioZEjRCNP7g/gQNDW41TB1SpVkQxowY"
   crossorigin="anonymous"
 ></script>
 
 <!-- Microsoft Teams JavaScript API (via npm) -->
-<script src="node_modules/@microsoft/teams-js@2.10.0/dist/MicrosoftTeams.min.js"></script>
+<script src="node_modules/@microsoft/teams-js@2.10.1/dist/MicrosoftTeams.min.js"></script>
 
 <!-- Microsoft Teams JavaScript API (via local) -->
 <script src="MicrosoftTeams.min.js"></script>

package/dist/MicrosoftTeams.d.ts

@@ -2026,6 +2026,18 @@ export namespace teams {
     * Limited to Microsoft-internal use
     */
 export namespace videoEx {
+        /**
+            * @hidden
+            * Error level when notifying errors to the host, the host will decide what to do acording to the error level.
+            * @beta
+            *
+            * @internal
+            * Limited to Microsoft-internal use
+            */
+        enum ErrorLevel {
+                Fatal = "fatal",
+                Warn = "warn"
+        }
         /**
             * @hidden
             * Video frame configuration supplied to the host to customize the generated video frame parameters
@@ -2057,16 +2069,44 @@ export namespace videoEx {
         }
         /**
             * @hidden
-            * Error level when notifying errors to the host, the host will decide what to do acording to the error level.
+            * Represents a video frame
             * @beta
             *
             * @internal
             * Limited to Microsoft-internal use
             */
-        enum ErrorLevel {
-                Fatal = "fatal",
-                Warn = "warn"
+        interface VideoFrame extends video.VideoFrame {
+                /**
+                    * @hidden
+                    * The model output if you passed in an {@linkcode VideoFrameConfig.audioInferenceModel}
+                    * @beta
+                    *
+                    * @internal
+                    * Limited to Microsoft-internal use
+                    */
+                audioInferenceResult?: Uint8Array;
         }
+        /**
+            * @hidden
+            * Video frame call back function
+            * @beta
+            *
+            * @internal
+            * Limited to Microsoft-internal use
+            */
+        type VideoFrameCallback = (frame: VideoFrame, notifyVideoFrameProcessed: () => void, notifyError: (errorMessage: string) => void) => void;
+        /**
+            * @hidden
+            * Register to process video frames
+            * @beta
+            *
+            * @param frameCallback - The callback to invoke when registerForVideoFrame has completed
+            * @param config - VideoFrameConfig to customize generated video frame parameters
+            *
+            * @internal
+            * Limited to Microsoft-internal use
+            */
+        function registerForVideoFrame(frameCallback: VideoFrameCallback, config: VideoFrameConfig): void;
         /**
             * @hidden
             * Video extension should call this to notify host that the current selected effect parameter changed.
@@ -2160,69 +2200,6 @@ export namespace videoEx {
             * Limited to Microsoft-internal use
             */
         function notifyFatalError(errorMessage: string): void;
-        /**
-            * @hidden
-            * @internal
-            * @beta
-            * Namespace to get shared video framed.
-            * When the host supports this capability, developer should call {@link sharedFrame.registerForVideoFrame} to get the video frames.
-            */
-        namespace sharedFrame {
-                /**
-                    * @hidden
-                    *
-                    * Checks if video.sharedFrame capability is supported by the host
-                    * @beta
-                    *
-                    * @throws Error if {@linkcode app.initialize} has not successfully completed
-                    *
-                    * @returns boolean to represent whether the video.sharedFrame capability is supported
-                    *
-                    * @internal
-                    * Limited to Microsoft-internal use
-                    */
-                function isSupported(): boolean;
-                /**
-                    * @hidden
-                    * Represents a video frame
-                    * @beta
-                    *
-                    * @internal
-                    * Limited to Microsoft-internal use
-                    */
-                interface VideoFrame extends video.sharedFrame.VideoFrameData {
-                        /**
-                            * @hidden
-                            * The model output if you passed in an {@linkcode VideoFrameConfig.audioInferenceModel}
-                            * @beta
-                            *
-                            * @internal
-                            * Limited to Microsoft-internal use
-                            */
-                        audioInferenceResult?: Uint8Array;
-                }
-                /**
-                    * @hidden
-                    * Video frame call back function
-                    * @beta
-                    *
-                    * @internal
-                    * Limited to Microsoft-internal use
-                    */
-                type VideoFrameCallback = (frame: VideoFrame, notifyVideoFrameProcessed: () => void, notifyError: (errorMessage: string) => void) => void;
-                /**
-                    * @hidden
-                    * Register to process video frames
-                    * @beta
-                    *
-                    * @param frameCallback - The callback to invoke when registerForVideoFrame has completed
-                    * @param config - VideoFrameConfig to customize generated video frame parameters
-                    *
-                    * @internal
-                    * Limited to Microsoft-internal use
-                    */
-                function registerForVideoFrame(frameCallback: VideoFrameCallback, config: VideoFrameConfig): void;
-        }
 }
 
 /**
@@ -6749,12 +6726,46 @@ export interface ShowProfileRequestInternal {
     * @beta
     */
 export namespace video {
+        /**
+            * Represents a video frame
+            * @beta
+            */
+        interface VideoFrame {
+                /**
+                    * Video frame width
+                    */
+                width: number;
+                /**
+                    * Video frame height
+                    */
+                height: number;
+                /**
+                    * Video frame buffer
+                    */
+                data: Uint8ClampedArray;
+                /**
+                    * NV12 luma stride, valid only when video frame format is NV12
+                    */
+                lumaStride?: number;
+                /**
+                    * NV12 chroma stride, valid only when video frame format is NV12
+                    */
+                chromaStride?: number;
+                /**
+                    * RGB stride, valid only when video frame format is RGB
+                    */
+                stride?: number;
+                /**
+                    * The time stamp of the current video frame
+                    */
+                timestamp?: number;
+        }
         /**
             * Video frame format enum, currently only support NV12
             * @beta
             */
         enum VideoFrameFormat {
-                NV12 = "NV12"
+                NV12 = 0
         }
         /**
             * Video frame configuration supplied to the host to customize the generated video frame parameters, like format
@@ -6774,12 +6785,17 @@ export namespace video {
                 /**
                     * Current video effect changed
                     */
-                EffectChanged = "EffectChanged",
+                EffectChanged = 0,
                 /**
                     * Disable the video effect
                     */
-                EffectDisabled = "EffectDisabled"
+                EffectDisabled = 1
         }
+        /**
+            * Video frame call back function definition
+            * @beta
+            */
+        type VideoFrameCallback = (frame: VideoFrame, notifyVideoFrameProcessed: () => void, notifyError: (errorMessage: string) => void) => void;
         /**
             * Predefined failure reasons for preparing the selected video effect
             * @beta
@@ -6801,6 +6817,13 @@ export namespace video {
             * @beta
             */
         type VideoEffectCallback = (effectId: string | undefined) => Promise<void>;
+        /**
+            * Register to read the video frames in Permissions section
+            * @beta
+            * @param frameCallback - The callback to invoke when registerForVideoFrame has completed
+            * @param config - VideoFrameConfig to customize generated video frame parameters
+            */
+        function registerForVideoFrame(frameCallback: VideoFrameCallback, config: VideoFrameConfig): void;
         /**
             * Video extension should call this to notify host that the current selected effect parameter changed.
             * If it's pre-meeting, host will call videoEffectCallback immediately then use the videoEffect.
@@ -6825,118 +6848,6 @@ export namespace video {
             *
             */
         function isSupported(): boolean;
-        /**
-            * @beta
-            * Namespace to get video frames from a media stream.
-            * When the host supports this capability, developer should call {@link mediaStream.registerForVideoFrame} to get the video frames.
-            */
-        namespace mediaStream {
-                /**
-                    * @beta
-                    * Checks if video.mediaStream capability is supported by the host
-                    * @returns boolean to represent whether the video.medisStream capability is supported
-                    *
-                    * @throws Error if {@linkcode app.initialize} has not successfully completed
-                    *
-                    */
-                function isSupported(): boolean;
-                /**
-                    * @beta
-                    * Video frame data extracted from the media stream. More properties may be added in the future.
-                    */
-                type MediaStreamFrameData = {
-                        /**
-                            * The video frame from the media stream.
-                            */
-                        videoFrame: VideoFrame;
-                };
-                /**
-                    * @beta
-                    * Video effect change call back function definition.
-                    * The video app should resolve the promise to notify a successfully processed video frame.
-                    * The video app should reject the promise to notify a failure.
-                    */
-                type VideoFrameCallback = (receivedVideoFrame: MediaStreamFrameData) => Promise<VideoFrame>;
-                /**
-                    * @beta
-                    * Register to read the video frames from the media stream provided by the host.
-                    * @param frameCallback - The callback to invoke when recieve a video frame from the media stream.
-                    * @example
-                    * ```typescript
-                    * video.mediaStream.registerForVideoFrame(async (receivedVideoFrame) => {
-                    *  const { videoFrame } = receivedVideoFrame;
-                    *  try {
-                    *    return await processVideoFrame(videoFrame);
-                    *  } catch (error) {
-                    *   throw error;
-                    *  }
-                    * });
-                    * ```
-                    */
-                function registerForVideoFrame(frameCallback: VideoFrameCallback): void;
-        }
-        /**
-            * @beta
-            * Namespace to get shared video framed.
-            * When the host supports this capability, developer should call {@link sharedFrame.registerForVideoFrame} to get the video frames.
-            */
-        namespace sharedFrame {
-                /**
-                    * Checks if video.sharedFrame capability is supported by the host
-                    * @beta
-                    * @returns boolean to represent whether the video capability is supported
-                    *
-                    * @throws Error if {@linkcode app.initialize} has not successfully completed
-                    *
-                    */
-                function isSupported(): boolean;
-                /**
-                    * Represents a video frame
-                    * @beta
-                    */
-                interface VideoFrameData {
-                        /**
-                            * Video frame width
-                            */
-                        width: number;
-                        /**
-                            * Video frame height
-                            */
-                        height: number;
-                        /**
-                            * Video frame buffer
-                            */
-                        videoFrameBuffer: Uint8ClampedArray;
-                        /**
-                            * NV12 luma stride, valid only when video frame format is NV12
-                            */
-                        lumaStride?: number;
-                        /**
-                            * NV12 chroma stride, valid only when video frame format is NV12
-                            */
-                        chromaStride?: number;
-                        /**
-                            * RGB stride, valid only when video frame format is RGB
-                            */
-                        stride?: number;
-                        /**
-                            * The time stamp of the current video frame
-                            */
-                        timestamp?: number;
-                }
-                /**
-                    * Video frame call back function definition
-                    * @beta
-                    */
-                type VideoFrameCallback = (frame: VideoFrameData, notifyVideoFrameProcessed: () => void, notifyError: (errorMessage: string) => void) => void;
-                /**
-                    * Register to read the video frames in Permissions section
-                    * @beta
-                    * @param frameCallback - The callback to invoke when registerForVideoFrame has completed
-                    * @param config - VideoFrameConfig to customize generated video frame parameters
-                    */
-                function registerForVideoFrame(frameCallback: VideoFrameCallback, config: VideoFrameConfig): void;
-        }
 }
 
 /**