@microsoft/teams-js 2.16.0-beta.1 → 2.16.0-beta.2

package/dist/MicrosoftTeams.d.ts

@@ -2025,7 +2025,7 @@ export namespace teams {
     * @internal
     * Limited to Microsoft-internal use
     */
-export namespace videoEx {
+export namespace videoEffectsEx {
         /**
             * @hidden
             * Error level when notifying errors to the host, the host will decide what to do acording to the error level.
@@ -2046,7 +2046,7 @@ export namespace videoEx {
             * @internal
             * Limited to Microsoft-internal use
             */
-        interface VideoFrameConfig extends video.VideoFrameConfig {
+        interface VideoFrameConfig extends videoEffects.VideoFrameConfig {
                 /**
                     * @hidden
                     * Flag to indicate use camera stream to synthesize video frame or not.
@@ -2075,7 +2075,7 @@ export namespace videoEx {
             * @internal
             * Limited to Microsoft-internal use
             */
-        interface VideoBufferData extends video.VideoBufferData {
+        interface VideoBufferData extends videoEffects.VideoBufferData {
                 /**
                     * @hidden
                     * The model output if you passed in an {@linkcode VideoFrameConfig.audioInferenceModel}
@@ -2106,7 +2106,7 @@ export namespace videoEx {
             * @internal
             * Limited to Microsoft-internal use
             */
-        type VideoFrameData = video.VideoFrameData & {
+        type VideoFrameData = videoEffects.VideoFrameData & {
                 /**
                     * @hidden
                     * The model output if you passed in an {@linkcode VideoFrameConfig.audioInferenceModel}
@@ -2128,7 +2128,7 @@ export namespace videoEx {
             * @internal
             * Limited to Microsoft-internal use
             */
-        type VideoFrameHandler = (receivedVideoFrame: VideoFrameData) => Promise<video.VideoFrame>;
+        type VideoFrameHandler = (receivedVideoFrame: VideoFrameData) => Promise<videoEffects.VideoFrame>;
         /**
             * @hidden
             * @beta
@@ -2176,7 +2176,7 @@ export namespace videoEx {
             * @internal
             * Limited to Microsoft-internal use
             */
-        function notifySelectedVideoEffectChanged(effectChangeType: video.EffectChangeType, effectId: string | undefined, effectParam?: string): void;
+        function notifySelectedVideoEffectChanged(effectChangeType: videoEffects.EffectChangeType, effectId: string | undefined, effectParam?: string): void;
         /**
             * @hidden
             * Register the video effect callback, host uses this to notify the video extension the new video effect will by applied
@@ -3363,7 +3363,7 @@ export interface Context {
             * @deprecated
             * As of 2.0.0, please use {@link app.AppInfo.sessionId | app.Context.app.sessionId} instead
             *
-            * Unique ID for the current session for use in correlating telemetry data.
+            * Unique ID for the current session for use in correlating telemetry data. A session corresponds to the lifecycle of an app. A new session begins upon the creation of a webview (on Teams mobile) or iframe (in Teams desktop) hosting the app, and ends when it is destroyed.
             */
         appSessionId?: string;
         /**
@@ -3874,7 +3874,7 @@ export namespace app {
                     */
                 theme: string;
                 /**
-                    * Unique ID for the current session for use in correlating telemetry data.
+                    * Unique ID for the current session for use in correlating telemetry data. A session corresponds to the lifecycle of an app. A new session begins upon the creation of a webview (on Teams mobile) or iframe (in Teams desktop) hosting the app, and ends when it is destroyed.
                     */
                 sessionId: string;
                 /**
@@ -6159,6 +6159,8 @@ export namespace location {
     * Interact with meetings, including retrieving meeting details, getting mic status, and sharing app content.
     * This namespace is used to handle meeting related functionality like
     * get meeting details, get/update state of mic, sharing app content and more.
+    *
+    * To learn more, visit https://aka.ms/teamsmeetingapps
     */
 export namespace meeting {
         /** Error callback function type */
@@ -6277,10 +6279,15 @@ export namespace meeting {
                     */
                 tenantId?: string;
         }
-        /** Represents the current live streaming state of a meeting */
+        /**
+            * Represents the current Real-Time Messaging Protocol (RTMP) live streaming state of a meeting.
+            *
+            * @remarks
+            * RTMP is a popular communication protocol for streaming audio, video, and data over the Internet.
+            */
         export interface LiveStreamState {
                 /**
-                    * indicates whether meeting is streaming
+                    * true when the current meeting is being streamed through RTMP, or false if it is not.
                     */
                 isStreaming: boolean;
                 /**
@@ -6296,7 +6303,8 @@ export namespace meeting {
         /** Represents app permission to share contents to meeting. */
         export interface IAppContentStageSharingCapabilities {
                 /**
-                    * indicates whether app has permission to share contents to meeting stage
+                    * indicates whether app has permission to share contents to meeting stage.
+                    * true when your `configurableTabs` or `staticTabs` entry's `context` array includes `meetingStage`.
                     */
                 doesAppHaveSharePermission: boolean;
         }
@@ -6313,8 +6321,7 @@ export namespace meeting {
             */
         export interface ISpeakingState {
                 /**
-                    * Indicates whether one or more participants in a meeting are speaking, or
-                    * if no participants are speaking
+                    * true when one or more participants in a meeting are speaking, or false if no participants are speaking
                     */
                 isSpeakingDetected: boolean;
                 /**
@@ -6454,54 +6461,123 @@ export namespace meeting {
                 surprised = "surprised",
                 applause = "applause"
         }
-        /** Represents the type of a meeting */
+        /**
+            * Represents the type of a meeting
+            *
+            * @hidden
+            * Hide from docs.
+            *
+            * @remarks
+            * Teams has several types of meetings to account for different user scenarios and requirements.
+            */
         export enum MeetingType {
-                /** Used when the meeting type is not known. */
+                /**
+                    * Used when the meeting type is not known.
+                    *
+                    * @remarks
+                    * This response is not an expected case.
+                    */
                 Unknown = "Unknown",
-                /** Used for ad hoc meetings that are created on the fly. */
+                /**
+                    * Used for group call meeting types.
+                    *
+                    * @remarks
+                    * To test this meeting type in Teams, start a chat with two or more users and click the "Call" button.
+                    * Note that a group call may return as this or {@link CallType.GroupCall}. These two different response types should be considered as equal.
+                    */
                 Adhoc = "Adhoc",
-                /** Used for meetings that have been scheduled in advance. */
+                /**
+                    * Used for single-occurrence meetings that have been scheduled in advance.
+                    *
+                    * @remarks
+                    * To create a meeting of this type in Teams, press the "New meeting" button from the calendar and enter a meeting title.
+                    * Before saving, ensure that the "Online Meeting" field is checked.
+                    */
                 Scheduled = "Scheduled",
-                /** Used for meetings that occur on a recurring basis. */
+                /**
+                    * Used for meetings that occur on a recurring basis.
+                    *
+                    * @remarks
+                    * To create a meeting of this type in Teams, press the "New meeting" button from the calendar, enter a meeting title, and then change the field labeled "Does not repeat" to some other value.
+                    * Before saving, ensure that the "Online Meeting" field is checked.
+                    */
                 Recurring = "Recurring",
-                /** Used for live events or webinars. */
+                /**
+                    * Used for webinars.
+                    *
+                    * @remarks
+                    * Meeting apps are only supported for those in the "event group" of a webinar, which are those who'll be presenting and producing the webinar.
+                    * To learn how to create a meeting of this type, visit https://aka.ms/teams/howto/webinars.
+                    */
                 Broadcast = "Broadcast",
-                /** Used for meetings that are created on the fly, but with a more polished experience than ad hoc meetings. */
+                /**
+                    * Used for meet now meetings, which are meetings users create on the fly.
+                    *
+                    * @remarks
+                    * To create a meeting of this type, click the "Meet now" button from the calendar in Teams or the "Teams call" button in Outlook.
+                    */
                 MeetNow = "MeetNow"
         }
-        /** Represents the type of a call. */
+        /**
+            * Represents the type of a call.
+            *
+            * @hidden
+            * Hide from docs.
+            */
         export enum CallType {
-                /** Represents a call between two people. */
+                /**
+                    * Represents a call between two people.
+                    *
+                    * @remarks
+                    * To test this feature, start a chat with one other user and click the "Call" button.
+                    */
                 OneOnOneCall = "oneOnOneCall",
-                /** Represents a call between more than two people. */
+                /**
+                    * Represents a call between more than two people.
+                    *
+                    * @remarks
+                    * To test this meeting type in Teams, start a chat with two or more users and click the "Call" button.
+                    * Note that a group call may return as this or {@link MeetingType.Adhoc}. These two different response types should be considered as equal.
+                    */
                 GroupCall = "groupCall"
         }
         /**
-            * Allows an app to get the incoming audio speaker setting for the meeting user
+            * Allows an app to get the incoming audio speaker setting for the meeting user.
+            * To learn more, visit https://aka.ms/teamsjs/getIncomingClientAudioState
             *
-            * @param callback - Callback contains 2 parameters, error and result.
+            * @remarks
+            * Use {@link toggleIncomingClientAudio} to toggle the current audio state.
+            * For private scheduled meetings, meet now, or calls, include the `OnlineMeetingParticipant.ToggleIncomingAudio.Chat` RSC permission in your app manifest.
+            * Find the app manifest reference at https://aka.ms/teamsAppManifest/authorization.
+            * This API can only be used in the `sidePanel` and `meetingStage` frame contexts.
             *
-            * error can either contain an error of type SdkError, incase of an error, or null when fetch is successful
-            * result can either contain the true/false value, incase of a successful fetch or null when the fetching fails
-            * result: True means incoming audio is muted and false means incoming audio is unmuted
+            * @param callback - Callback contains 2 parameters, `error` and `result`.
+            * `error` can either contain an error of type `SdkError`, in case of an error, or null when fetch is successful.
+            * `result` will be true when incoming audio is muted and false when incoming audio is unmuted, or null when the request fails.
             */
         export function getIncomingClientAudioState(callback: errorCallbackFunctionType): void;
         /**
-            * Allows an app to toggle the incoming audio speaker setting for the meeting user from mute to unmute or vice-versa
+            * Allows an app to toggle the incoming audio speaker setting for the meeting user from mute to unmute or vice-versa.
+            * To learn more, visit https://aka.ms/teamsjs/toggleIncomingClientAudio
             *
-            * @param callback - Callback contains 2 parameters, error and result.
-            * error can either contain an error of type SdkError, incase of an error, or null when toggle is successful
-            * result can either contain the true/false value, incase of a successful toggle or null when the toggling fails
-            * result: True means incoming audio is muted and false means incoming audio is unmuted
+            * @remarks
+            * Use {@link getIncomingClientAudioState} to get the current audio state.
+            * For private scheduled meetings, meet now, or calls, include the `OnlineMeetingParticipant.ToggleIncomingAudio.Chat` RSC permission in your app manifest.
+            * Find the app manifest reference at https://aka.ms/teamsAppManifest/authorization.
+            * This API can only be used in the `sidePanel` and `meetingStage` frame contexts.
+            *
+            * @param callback - Callback contains 2 parameters, `error` and `result`.
+            * `error` can either contain an error of type `SdkError`, in case of an error, or null when toggle is successful.
+            * `result` will be true when incoming audio is muted and false when incoming audio is unmuted, or null when the toggling fails.
             */
         export function toggleIncomingClientAudio(callback: errorCallbackFunctionType): void;
         /**
             * @hidden
             * Allows an app to get the meeting details for the meeting
             *
-            * @param callback - Callback contains 2 parameters, error and meetingDetailsResponse.
-            * error can either contain an error of type SdkError, incase of an error, or null when get is successful
-            * result can either contain a IMeetingDetailsResponse value, in case of a successful get or null when the get fails
+            * @param callback - Callback contains 2 parameters, `error` and `meetingDetailsResponse`.
+            * `error` can either contain an error of type `SdkError`, in case of an error, or null when get is successful
+            * `result` can either contain a {@link IMeetingDetailsResponse} value, in case of a successful get or null when the get fails
             *
             * @internal
             * Limited to Microsoft-internal use
@@ -6511,67 +6587,105 @@ export namespace meeting {
             * @hidden
             * Allows an app to get the authentication token for the anonymous or guest user in the meeting
             *
-            * @param callback - Callback contains 2 parameters, error and authenticationTokenOfAnonymousUser.
-            * error can either contain an error of type SdkError, incase of an error, or null when get is successful
-            * authenticationTokenOfAnonymousUser can either contain a string value, incase of a successful get or null when the get fails
+            * @param callback - Callback contains 2 parameters, `error` and `authenticationTokenOfAnonymousUser`.
+            * `error` can either contain an error of type `SdkError`, in case of an error, or null when get is successful
+            * `authenticationTokenOfAnonymousUser` can either contain a string value, in case of a successful get or null when the get fails
             *
             * @internal
             * Limited to Microsoft-internal use
             */
         export function getAuthenticationTokenForAnonymousUser(callback: (error: SdkError | null, authenticationTokenOfAnonymousUser: string | null) => void): void;
         /**
-            * Allows an app to get the state of the live stream in the current meeting
+            * Allows an app to get the state of the outgoing live stream in the current meeting.
             *
-            * @param callback - Callback contains 2 parameters: error and liveStreamState.
-            * error can either contain an error of type SdkError, in case of an error, or null when get is successful
-            * liveStreamState can either contain a LiveStreamState value, or null when operation fails
+            * @remarks
+            * Use {@link requestStartLiveStreaming} or {@link requestStopLiveStreaming} to start/stop a live stream.
+            * This API can only be used in the `sidePanel` frame context.
+            * The `meetingExtensionDefinition.supportsStreaming` field in your app manifest must be `true` to use this API.
+            * Find the app manifest reference at https://aka.ms/teamsAppManifest/meetingExtensionDefinition.
+            *
+            * @param callback - Callback contains 2 parameters: `error` and `liveStreamState`.
+            * `error` can either contain an error of type `SdkError`, in case of an error, or null when the request is successful
+            * `liveStreamState` can either contain a `LiveStreamState` value, or null when operation fails
             */
         export function getLiveStreamState(callback: getLiveStreamStateCallbackFunctionType): void;
         /**
-            * Allows an app to request the live streaming be started at the given streaming url
+            * Allows an app to ask the local user to begin live streaming the current meeting to the given Real-Time Messaging Protocol (RTMP) stream url.
+            * A confirmation dialog will be shown to the local user with options to "Allow" or "Cancel" this request.
             *
             * @remarks
-            * Use getLiveStreamState or registerLiveStreamChangedHandler to get updates on the live stream state
+            * Meeting content (e.g., user video, screenshare, audio, etc.) can be externally streamed to any platform that supports the popular RTMP standard.
+            * Content broadcasted through RTMP is automatically formatted and cannot be customized.
+            * Use {@link getLiveStreamState} or {@link registerLiveStreamChangedHandler} to get updates on the live stream state.
+            * This API can only be used in the `sidePanel` frame context.
+            * The `meetingExtensionDefinition.supportsStreaming` field in your app manifest must be `true` to use this API.
+            * Find the app manifest reference at https://aka.ms/teamsAppManifest/meetingExtensionDefinition.
             *
-            * @param streamUrl - the url to the stream resource
-            * @param streamKey - the key to the stream resource
-            * @param callback - Callback contains error parameter which can be of type SdkError in case of an error, or null when operation is successful
+            * @param callback - completion callback that contains an `error` parameter, which can be of type `SdkError` in case of an error, or null when operation is successful
+            * @param streamUrl - the url to the RTMP stream resource
+            * @param streamKey - the key to the RTMP stream resource
             */
         export function requestStartLiveStreaming(callback: liveStreamErrorCallbackFunctionType, streamUrl: string, streamKey?: string): void;
         /**
-            * Allows an app to request the live streaming be stopped at the given streaming url
+            * Allows an app to request that live streaming be stopped.
             *
             * @remarks
-            * Use getLiveStreamState or registerLiveStreamChangedHandler to get updates on the live stream state
+            * Use {@link getLiveStreamState} or {@link registerLiveStreamChangedHandler} to get updates on the live stream state.
+            * This API can only be used in the `sidePanel` frame context.
+            * The `meetingExtensionDefinition.supportsStreaming` field in your app manifest must be `true` to use this API.
+            * Find the app manifest reference at https://aka.ms/teamsAppManifest/meetingExtensionDefinition.
             *
-            * @param callback - Callback contains error parameter which can be of type SdkError in case of an error, or null when operation is successful
+            * @param callback - completion callback that contains an error parameter, which can be of type `SdkError` in case of an error, or null when operation is successful
             */
         export function requestStopLiveStreaming(callback: liveStreamErrorCallbackFunctionType): void;
         /**
-            * Registers a handler for changes to the live stream.
+            * Registers an event handler for state changes to the live stream.
             *
             * @remarks
             * Only one handler can be registered at a time. A subsequent registration replaces an existing registration.
+            * Use {@link requestStartLiveStreaming} or {@link requestStopLiveStreaming} to start/stop a live stream.
+            * This API can only be used in the `sidePanel` frame context.
+            * The `meetingExtensionDefinition.supportsStreaming` field in your app manifest must be `true` to use this API.
+            * Find the app manifest reference at https://aka.ms/teamsAppManifest/meetingExtensionDefinition.
             *
             * @param handler - The handler to invoke when the live stream state changes
             */
         export function registerLiveStreamChangedHandler(handler: registerLiveStreamChangedHandlerFunctionType): void;
         /**
-            * Allows an app to share contents in the meeting
+            * Allows an app to share a given URL to the meeting stage for all users in the meeting.
+            * To learn more, visit https://aka.ms/teamsjs/shareAppContentToStage
             *
-            * @param callback - Callback contains 2 parameters, error and result.
-            * error can either contain an error of type SdkError, incase of an error, or null when share is successful
-            * result can either contain a true value, incase of a successful share or null when the share fails
-            * @param appContentUrl - is the input URL which needs to be shared on to the stage
+            * @remarks
+            * This API can only be used in the `sidePanel` and `meetingStage` frame contexts.
+            * For private scheduled meetings, meet now, or calls, include the `MeetingStage.Write.Chat` RSC permission in your app manifest.
+            * For channel meetings, include the `ChannelMeetingStage.Write.Group` RSC permission in your app manifest.
+            * Find the app manifest reference at https://aka.ms/teamsAppManifest/authorization.
+            * Use {@link getAppContentStageSharingCapabilities} to determine if the local user is eligible to use this API.
+            * Use {@link getAppContentStageSharingState} to determine whether app content is already being shared to the meeting stage.
+            *
+            * @param callback - Callback contains 2 parameters, `error` and `result`.
+            * `error` can either contain an error of type `SdkError`, in case of an error, or null when share is successful
+            * `result` can either contain a true value, in case of a successful share or null when the share fails
+            * @param appContentUrl - is the input URL to be shared to the meeting stage.
+            * the URL origin must be included in your app manifest's `validDomains` field.
             */
         export function shareAppContentToStage(callback: errorCallbackFunctionType, appContentUrl: string): void;
         /**
-            * Provides information related app's in-meeting sharing capabilities
+            * Allows an app to request whether the local user's app version has the required app manifest permissions to share content to meeting stage.
+            * To learn more, visit https://aka.ms/teamsjs/getAppContentStageSharingCapabilities
             *
-            * @param callback - Callback contains 2 parameters, error and result.
-            * error can either contain an error of type SdkError (error indication), or null (non-error indication)
-            * appContentStageSharingCapabilities can either contain an IAppContentStageSharingCapabilities object
-            * (indication of successful retrieval), or null (indication of failed retrieval)
+            * @remarks
+            * If you are updating your published app to include the share to stage feature, you can use this API to prompt users to update their app if they are using an older version.
+            * Your app's `configurableTabs` or `staticTabs` entry's `context` array must include `meetingStage` for `doesAppHaveSharePermission` to be `true` in the `callback` response.
+            *
+            * @throws error if API is being used outside of `sidePanel` or `meetingStage` frame contexts.
+            * @throws error if your app manifest does not include the `MeetingStage.Write.Chat` RSC permission in your app manifest in a private scheduled meeting, meet now, or call --
+            * or if it does not include the `ChannelMeetingStage.Write.Group` RSC permission in your app manifest in a channel meeting.
+            * Find the app manifest reference at https://aka.ms/teamsAppManifest/authorization.
+            *
+            * @param callback - Completion callback contains 2 parameters: `error` and `appContentStageSharingCapabilities`.
+            * `error` can either contain an error of type `SdkError` (error indication), or null (non-error indication).
+            * `appContentStageSharingCapabilities` will contain an {@link IAppContentStageSharingCapabilities} object if the request succeeds, or null if it failed.
             */
         export function getAppContentStageSharingCapabilities(callback: getAppContentCallbackFunctionType): void;
         /**
@@ -6585,18 +6699,32 @@ export namespace meeting {
             */
         export function stopSharingAppContentToStage(callback: errorCallbackFunctionType): void;
         /**
-            * Provides information related to current stage sharing state for app
+            * Provides information related to current stage sharing state for your app.
+            * To learn more, visit https://aka.ms/teamsjs/getAppContentStageSharingState
             *
-            * @param callback - Callback contains 2 parameters, error and result.
+            * @remarks
+            * This API can only be used in the `sidePanel` and `meetingStage` frame contexts.
+            * For private scheduled meetings, meet now, or calls, include the `MeetingStage.Write.Chat` RSC permission in your app manifest.
+            * For channel meetings, include the `ChannelMeetingStage.Write.Group` RSC permission in your app manifest.
+            * Find the app manifest reference at https://aka.ms/teamsAppManifest/authorization.
+            *
+            * @param callback - Callback contains 2 parameters, `error` and `appContentStageSharingState`.
             * error can either contain an error of type SdkError (error indication), or null (non-error indication)
-            * appContentStageSharingState can either contain an IAppContentStageSharingState object
-            * (indication of successful retrieval), or null (indication of failed retrieval)
+            * `appContentStageSharingState` can either contain an `IAppContentStageSharingState` object if the request succeeds, or null if it failed
             */
         export function getAppContentStageSharingState(callback: getAppContentStageCallbackFunctionType): void;
         /**
-            * Registers a handler for changes to paticipant speaking states. This API returns {@link ISpeakingState}, which will have isSpeakingDetected
-            * and/or an error object. If any participant is speaking, isSpeakingDetected will be true. If no participants are speaking, isSpeakingDetected
-            * will be false. Default value is false. Only one handler can be registered at a time. A subsequent registration replaces an existing registration.
+            * Registers a handler for changes to participant speaking states.
+            * To learn more, visit https://aka.ms/teamsjs/registerSpeakingStateChangeHandler
+            *
+            * @remarks
+            * This API returns {@link ISpeakingState}, which will have `isSpeakingDetected` and/or an error object.
+            * If any participant is speaking, `isSpeakingDetected` will be true, or false if no participants are speaking.
+            * Only one handler can be registered at a time. Subsequent registrations replace existing registrations.
+            * This API can only be used in the `sidePanel` and `meetingStage` frame contexts.
+            * For private scheduled meetings, meet now, or calls, include the `OnlineMeetingIncomingAudio.Detect.Chat` RSC permission in your app manifest.
+            * For channel meetings, include the `OnlineMeetingIncomingAudio.Detect.Group` RSC permission in your app manifest.
+            * Find the app manifest reference at https://aka.ms/teamsAppManifest/authorization.
             *
             * @param handler The handler to invoke when the speaking state of any participant changes (start/stop speaking).
             */
@@ -6636,12 +6764,24 @@ export namespace meeting {
         /**
             * Nested namespace for functions to control behavior of the app share button
             *
+            * @hidden
+            * Hide from docs.
+            *
+            * @internal
+            * Limited to Microsoft-internal use
+            *
             * @beta
             */
         export namespace appShareButton {
                 /**
                     * Property bag for the setVisibilityInfo
                     *
+                    * @hidden
+                    * Hide from docs.
+                    *
+                    * @internal
+                    * Limited to Microsoft-internal use
+                    *
                     * @beta
                     */
                 interface ShareInformation {
@@ -6662,6 +6802,13 @@ export namespace meeting {
                     * @throws standard Invalid Url error
                     * @param shareInformation has two elements, one isVisible boolean flag and another
                     * optional string contentUrl, which will override contentUrl coming from Manifest
+                    *
+                    * @hidden
+                    * Hide from docs.
+                    *
+                    * @internal
+                    * Limited to Microsoft-internal use
+                    *
                     * @beta
                     */
                 function setOptions(shareInformation: ShareInformation): void;
@@ -7197,7 +7344,7 @@ export interface ShowProfileRequestInternal {
     * Namespace to video extensibility of the SDK
     * @beta
     */
-export namespace video {
+export namespace videoEffects {
         /** Notify video frame processed function type */
         type notifyVideoFrameProcessedFunctionType = () => void;
         /** Notify error function type */
@@ -7352,7 +7499,7 @@ export namespace video {
             *
             * @example
             * ```typescript
-            * video.registerForVideoFrame({
+            * videoEffects.registerForVideoFrame({
             *   videoFrameHandler: async (videoFrameData) => {
             *     const originalFrame = videoFrameData.videoFrame as VideoFrame;
             *     try {
@@ -7375,7 +7522,7 @@ export namespace video {
             *       }
             *     },
             *   config: {
-            *     format: video.VideoPixelFormat.NV12,
+            *     format: videoEffects.VideoPixelFormat.NV12,
             *   }
             * });
             * ```
@@ -8745,7 +8892,7 @@ export namespace marketplace {
     * @hidden
     * Create a MediaStreamTrack from the media stream with the given streamId and processed by videoFrameHandler.
     */
-export function processMediaStream(streamId: string, videoFrameHandler: video.VideoFrameHandler, notifyError: (string: any) => void, videoPerformanceMonitor?: VideoPerformanceMonitor): Promise<void>;
+export function processMediaStream(streamId: string, videoFrameHandler: videoEffects.VideoFrameHandler, notifyError: (string: any) => void, videoPerformanceMonitor?: VideoPerformanceMonitor): Promise<void>;
 /**
     * @hidden
     * Create a MediaStreamTrack from the media stream with the given streamId and processed by videoFrameHandler.
@@ -8754,7 +8901,7 @@ export function processMediaStream(streamId: string, videoFrameHandler: video.Vi
     * @internal
     * Limited to Microsoft-internal use
     */
-export function processMediaStreamWithMetadata(streamId: string, videoFrameHandler: videoEx.VideoFrameHandler, notifyError: (string: any) => void, videoPerformanceMonitor?: VideoPerformanceMonitor): Promise<void>;
+export function processMediaStreamWithMetadata(streamId: string, videoFrameHandler: videoEffectsEx.VideoFrameHandler, notifyError: (string: any) => void, videoPerformanceMonitor?: VideoPerformanceMonitor): Promise<void>;
 /**
     * @hidden
     * Video effect change call back function definition