@microsoft/teams-js 2.0.0-beta.3-dev.39 → 2.0.0-beta.3-dev.40

package/dist/MicrosoftTeams.d.ts

@@ -802,7 +802,6 @@ export namespace files {
             *
             * @param folder - Cloud storage folder (CloudStorageFolder) / sub directory (CloudStorageFolderItem)
             * @param providerCode - Code of the cloud storage folder provider
-            * @param callback - Callback that will be triggered post contents are loaded
             */
         export function getCloudStorageFolderContents(folder: CloudStorageFolder | CloudStorageFolderItem, providerCode: CloudStorageProvider): Promise<CloudStorageFolderItem[]>;
         /**
@@ -3268,6 +3267,10 @@ export namespace media {
                     * Additional properties for customization of select media - Image in mobile devices
                     */
                 imageProps?: ImageProps;
+                /**
+                    * Additional properties for customization of select media - Video in mobile devices
+                    */
+                videoProps?: VideoProps;
                 /**
                     * Additional properties for customization of select media - VideoAndImage in mobile devices
                     */
@@ -3282,8 +3285,6 @@ export namespace media {
             * Hide from docs
             * --------
             * All properties common to Image and Video Props
-            *
-            * @internal
             */
         interface MediaProps {
                 /**
@@ -3326,20 +3327,30 @@ export namespace media {
                 enableFilter?: boolean;
         }
         /**
-            * @hidden
-            * Hide from docs
-            * --------
             * All properties in VideoProps are optional and have default values in the platform
-            *
-            * @internal
             */
-        interface VideoProps extends MediaProps {
+        export interface VideoProps extends MediaProps {
                 /**
-                    * @hidden
                     * Optional; the maximum duration in minutes after which the recording should terminate automatically.
                     * Default value is defined by the platform serving the API.
                     */
                 maxDuration?: number;
+                /**
+                    * Optional; to determine if the video capturing flow needs to be launched
+                    * in Full Screen Mode (Lens implementation) or PictureInPicture Mode (Native implementation).
+                    * Default value is true, indicating video will always launch in Full Screen Mode via lens.
+                    */
+                isFullScreenMode?: boolean;
+                /**
+                    * Optional; controls the visibility of stop button in PictureInPicture Mode.
+                    * Default value is true, indicating the user will be able to stop the video.
+                    */
+                isStopButtonVisible?: boolean;
+                /**
+                    * Optional; setting VideoController will register your app to listen to the lifecycle events during the video capture flow.
+                    * Your app can also dynamically control the experience while capturing the video by notifying the host client.
+                    */
+                videoController?: VideoController;
         }
         /**
             * All properties in VideoAndImageProps are optional and have default values in the platform
@@ -3351,11 +3362,68 @@ export namespace media {
             */
         export interface AudioProps {
                 /**
-                    * Optional; the maximum duration in minutes after which the recording should terminate automatically.
+                    * Optional; the maximum duration in minutes after which the recording should terminate automatically
                     * Default value is defined by the platform serving the API.
                     */
                 maxDuration?: number;
         }
+        /**
+            * @hidden
+            * Hide from docs
+            * --------
+            * Base class which holds the callback and notifies events to the host client
+            */
+        abstract class MediaController<T> {
+                protected controllerCallback: T;
+                constructor(controllerCallback?: T);
+                protected abstract getMediaType(): MediaType;
+                /**
+                    * @hidden
+                    * Hide from docs
+                    * --------
+                    * This function will be implemented by the respective media class which holds the logic
+                    * of specific events that needs to be notified to the app.
+                    * @param mediaEvent indicates the event signed by the host client to the app
+                    */
+                protected abstract notifyEventToApp(mediaEvent: MediaControllerEvent): void;
+                /**
+                    * @hidden
+                    * Hide from docs
+                    * --------
+                    * Function to notify the host client to programatically control the experience
+                    * @param mediaEvent indicates what the event that needs to be signaled to the host client
+                    * Optional; @param callback is used to send app if host client has successfully handled the notification event or not
+                    */
+                protected notifyEventToHost(mediaEvent: MediaControllerEvent, callback?: (err?: SdkError) => void): void;
+                /**
+                    * Function to programatically stop the ongoing media event
+                    * Optional; @param callback is used to send app if host client has successfully stopped the event or not
+                    */
+                stop(callback?: (err?: SdkError) => void): void;
+        }
+        /**
+            * Callback which will register your app to listen to lifecycle events during the video capture flow
+            */
+        export interface VideoControllerCallback {
+                onRecordingStarted?(): void;
+        }
+        /**
+            * VideoController class is used to communicate between the app and the host client during the video capture flow
+            */
+        export class VideoController extends MediaController<VideoControllerCallback> {
+                protected getMediaType(): MediaType;
+                notifyEventToApp(mediaEvent: MediaControllerEvent): void;
+        }
+        /**
+            * @hidden
+            * Hide from docs
+            * --------
+            * Events which are used to communicate between the app and the host client during the media recording flow
+            */
+        enum MediaControllerEvent {
+                StartRecording = 1,
+                StopRecording = 2
+        }
         /**
             * The modes in which camera can be launched in select Media API
             */
@@ -3377,6 +3445,7 @@ export namespace media {
             */
         export enum MediaType {
                 Image = 1,
+                Video = 2,
                 VideoAndImage = 3,
                 Audio = 4
         }
@@ -3427,12 +3496,6 @@ export namespace media {
                 sequence: number;
                 file: Blob;
         }
-        /**
-            * Select an attachment using camera/gallery
-            *
-            * @param mediaInputs - The input params to customize the media to be selected
-            * @returns A promise resolved with the collection of @see Media objects selected or rejected with a @see SdkError
-            */
         export function selectMedia(mediaInputs: MediaInputs): Promise<Media[]>;
         /**
             * Select an attachment using camera/gallery
@@ -3863,6 +3926,7 @@ export namespace meeting {
             */
         function registerLiveStreamChangedHandler(handler: (liveStreamState: LiveStreamState) => void): void;
         /**
+            * @hidden
             * Allows an app to share contents in the meeting
             *
             * @param appContentUrl - appContentUrl is the input URL which needs to be shared on to the stage
@@ -3870,6 +3934,7 @@ export namespace meeting {
             */
         function shareAppContentToStage(appContentUrl: string): Promise<boolean>;
         /**
+            * @hidden
             * @deprecated
             * As of 2.0.0-beta.1, please use {@link meeting.shareAppContentToStage meeting.shareAppContentToStage(appContentUrl: string): Promise\<boolean\>} instead.
             *
@@ -3882,12 +3947,14 @@ export namespace meeting {
             */
         function shareAppContentToStage(callback: (error: SdkError | null, result: boolean | null) => void, appContentUrl: string): void;
         /**
+            * @hidden
             * Provides information related to app's in-meeting sharing capabilities
             *
             * @returns Promise resolved with sharing capability details or rejected with SdkError value
             */
         function getAppContentStageSharingCapabilities(): Promise<IAppContentStageSharingCapabilities>;
         /**
+            * @hidden
             * @deprecated
             * As of 2.0.0-beta.1, please use {@link meeting.getAppContentStageSharingCapabilities meeting.getAppContentStageSharingCapabilities(): Promise\<IAppContentStageSharingCapabilities\>} instead.
             *