@microsoft/teams-js 2.31.0-beta.0 → 2.31.0-beta.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/esm/packages/teams-js/dts/internal/appHelpers.d.ts +12 -2
- package/dist/esm/packages/teams-js/dts/internal/dialogHelpers.d.ts +32 -0
- package/dist/esm/packages/teams-js/dts/internal/handlers.d.ts +11 -1
- package/dist/esm/packages/teams-js/dts/internal/hostToAppTelemetry.d.ts +51 -0
- package/dist/esm/packages/teams-js/dts/internal/interfaces.d.ts +11 -0
- package/dist/esm/packages/teams-js/dts/internal/marketplaceUtils.d.ts +1 -1
- package/dist/esm/packages/teams-js/dts/internal/mediaUtil.d.ts +2 -2
- package/dist/esm/packages/teams-js/dts/internal/messageObjects.d.ts +5 -0
- package/dist/esm/packages/teams-js/dts/internal/pagesHelpers.d.ts +24 -0
- package/dist/esm/packages/teams-js/dts/internal/profileUtil.d.ts +23 -1
- package/dist/esm/packages/teams-js/dts/internal/uint8array-extras/uint8array-extras.d.ts +6 -0
- package/dist/esm/packages/teams-js/dts/internal/utils.d.ts +20 -1
- package/dist/esm/packages/teams-js/dts/internal/videoEffectsUtils.d.ts +2 -2
- package/dist/esm/packages/teams-js/dts/internal/visualMediaHelpers.d.ts +14 -0
- package/dist/esm/packages/teams-js/dts/internal/webStorageHelpers.d.ts +4 -0
- package/dist/esm/packages/teams-js/dts/private/appEntity.d.ts +61 -61
- package/dist/esm/packages/teams-js/dts/private/conversations.d.ts +48 -48
- package/dist/esm/packages/teams-js/dts/private/copilot/copilot.d.ts +2 -0
- package/dist/esm/packages/teams-js/dts/private/copilot/eligibility.d.ts +29 -0
- package/dist/esm/packages/teams-js/dts/private/externalAppAuthentication.d.ts +355 -349
- package/dist/esm/packages/teams-js/dts/private/externalAppAuthenticationForCEA.d.ts +67 -68
- package/dist/esm/packages/teams-js/dts/private/externalAppCardActions.d.ts +104 -105
- package/dist/esm/packages/teams-js/dts/private/externalAppCardActionsForCEA.d.ts +41 -42
- package/dist/esm/packages/teams-js/dts/private/externalAppCommands.d.ts +113 -114
- package/dist/esm/packages/teams-js/dts/private/files.d.ts +590 -582
- package/dist/esm/packages/teams-js/dts/private/hostEntity/hostEntity.d.ts +42 -0
- package/dist/esm/packages/teams-js/dts/private/hostEntity/tab.d.ts +134 -0
- package/dist/esm/packages/teams-js/dts/private/index.d.ts +19 -18
- package/dist/esm/packages/teams-js/dts/private/logs.d.ts +31 -25
- package/dist/esm/packages/teams-js/dts/private/meetingRoom.d.ts +147 -142
- package/dist/esm/packages/teams-js/dts/private/messageChannels/dataLayer.d.ts +39 -0
- package/dist/esm/packages/teams-js/dts/private/messageChannels/messageChannels.d.ts +28 -0
- package/dist/esm/packages/teams-js/dts/private/messageChannels/telemetry.d.ts +39 -0
- package/dist/esm/packages/teams-js/dts/private/notifications.d.ts +31 -25
- package/dist/esm/packages/teams-js/dts/private/otherAppStateChange.d.ts +69 -70
- package/dist/esm/packages/teams-js/dts/private/remoteCamera.d.ts +219 -214
- package/dist/esm/packages/teams-js/dts/private/teams/fullTrust/fullTrust.d.ts +31 -0
- package/dist/esm/packages/teams-js/dts/private/teams/fullTrust/joinedTeams.d.ts +30 -0
- package/dist/esm/packages/teams-js/dts/private/teams/teams.d.ts +63 -0
- package/dist/esm/packages/teams-js/dts/private/videoEffectsEx.d.ts +192 -186
- package/dist/esm/packages/teams-js/dts/public/{app.d.ts → app/app.d.ts} +33 -45
- package/dist/esm/packages/teams-js/dts/public/app/lifecycle.d.ts +41 -0
- package/dist/esm/packages/teams-js/dts/public/appInitialization.d.ts +2 -2
- package/dist/esm/packages/teams-js/dts/public/authentication.d.ts +6 -0
- package/dist/esm/packages/teams-js/dts/public/barCode.d.ts +2 -1
- package/dist/esm/packages/teams-js/dts/public/calendar.d.ts +1 -0
- package/dist/esm/packages/teams-js/dts/public/call.d.ts +1 -0
- package/dist/esm/packages/teams-js/dts/public/chat.d.ts +30 -28
- package/dist/esm/packages/teams-js/dts/public/clipboard.d.ts +1 -0
- package/dist/esm/packages/teams-js/dts/public/dialog/adaptiveCard/adaptiveCard.d.ts +26 -0
- package/dist/esm/packages/teams-js/dts/public/dialog/adaptiveCard/bot.d.ts +27 -0
- package/dist/esm/packages/teams-js/dts/public/dialog/dialog.d.ts +56 -0
- package/dist/esm/packages/teams-js/dts/public/dialog/update.d.ts +24 -0
- package/dist/esm/packages/teams-js/dts/public/dialog/url/bot.d.ts +30 -0
- package/dist/esm/packages/teams-js/dts/public/dialog/url/parentCommunication.d.ts +50 -0
- package/dist/esm/packages/teams-js/dts/public/dialog/url/url.d.ts +60 -0
- package/dist/esm/packages/teams-js/dts/public/geoLocation/geoLocation.d.ts +68 -0
- package/dist/esm/packages/teams-js/dts/public/geoLocation/map.d.ts +33 -0
- package/dist/esm/packages/teams-js/dts/public/index.d.ts +29 -27
- package/dist/esm/packages/teams-js/dts/public/interfaces.d.ts +23 -1
- package/dist/esm/packages/teams-js/dts/public/liveShareHost.d.ts +135 -136
- package/dist/esm/packages/teams-js/dts/public/location.d.ts +75 -76
- package/dist/esm/packages/teams-js/dts/public/mail.d.ts +80 -81
- package/dist/esm/packages/teams-js/dts/public/marketplace.d.ts +315 -316
- package/dist/esm/packages/teams-js/dts/public/media.d.ts +423 -428
- package/dist/esm/packages/teams-js/dts/public/meeting/appShareButton.d.ts +51 -0
- package/dist/esm/packages/teams-js/dts/public/meeting/meeting.d.ts +854 -0
- package/dist/esm/packages/teams-js/dts/public/menus.d.ts +165 -166
- package/dist/esm/packages/teams-js/dts/public/monetization.d.ts +56 -50
- package/dist/esm/packages/teams-js/dts/public/navigation.d.ts +2 -1
- package/dist/esm/packages/teams-js/dts/public/nestedAppAuth.d.ts +10 -11
- package/dist/esm/packages/teams-js/dts/public/pages/appButton.d.ts +30 -0
- package/dist/esm/packages/teams-js/dts/public/pages/backStack.d.ts +44 -0
- package/dist/esm/packages/teams-js/dts/public/pages/config.d.ts +123 -0
- package/dist/esm/packages/teams-js/dts/public/pages/currentApp.d.ts +46 -0
- package/dist/esm/packages/teams-js/dts/public/pages/fullTrust.d.ts +33 -0
- package/dist/esm/packages/teams-js/dts/public/pages/pages.d.ts +253 -0
- package/dist/esm/packages/teams-js/dts/public/pages/tabs.d.ts +32 -0
- package/dist/esm/packages/teams-js/dts/public/people.d.ts +61 -63
- package/dist/esm/packages/teams-js/dts/public/profile.d.ts +81 -103
- package/dist/esm/packages/teams-js/dts/public/runtime.d.ts +3 -0
- package/dist/esm/packages/teams-js/dts/public/search.d.ts +81 -82
- package/dist/esm/packages/teams-js/dts/public/secondaryBrowser.d.ts +26 -27
- package/dist/esm/packages/teams-js/dts/public/settings.d.ts +4 -3
- package/dist/esm/packages/teams-js/dts/public/sharing/history.d.ts +47 -0
- package/dist/esm/packages/teams-js/dts/public/sharing/sharing.d.ts +76 -0
- package/dist/esm/packages/teams-js/dts/public/stageView/self.d.ts +23 -0
- package/dist/esm/packages/teams-js/dts/public/stageView/stageView.d.ts +81 -0
- package/dist/esm/packages/teams-js/dts/public/tasks.d.ts +46 -56
- package/dist/esm/packages/teams-js/dts/public/teamsAPIs.d.ts +78 -76
- package/dist/esm/packages/teams-js/dts/public/thirdPartyCloudStorage.d.ts +98 -99
- package/dist/esm/packages/teams-js/dts/public/videoEffects.d.ts +209 -210
- package/dist/esm/packages/teams-js/dts/public/visualMedia/image.d.ts +64 -0
- package/dist/esm/packages/teams-js/dts/public/visualMedia/visualMedia.d.ts +116 -0
- package/dist/esm/packages/teams-js/dts/public/webStorage.d.ts +20 -22
- package/dist/esm/packages/teams-js/src/index.js +1 -1
- package/dist/esm/packages/teams-js/src/internal/appHelpers.js +1 -1
- package/dist/esm/packages/teams-js/src/internal/communication.js +1 -1
- package/dist/esm/packages/teams-js/src/internal/deepLinkUtilities.js +1 -1
- package/dist/esm/packages/teams-js/src/internal/dialogHelpers.js +1 -0
- package/dist/esm/packages/teams-js/src/internal/handlers.js +1 -1
- package/dist/esm/packages/teams-js/src/internal/hostToAppTelemetry.js +1 -0
- package/dist/esm/packages/teams-js/src/internal/marketplaceUtils.js +1 -1
- package/dist/esm/packages/teams-js/src/internal/mediaUtil.js +1 -1
- package/dist/esm/packages/teams-js/src/internal/messageObjects.js +1 -1
- package/dist/esm/packages/teams-js/src/internal/pagesHelpers.js +1 -0
- package/dist/esm/packages/teams-js/src/internal/uint8array-extras/uint8array-extras.js +1 -0
- package/dist/esm/packages/teams-js/src/internal/utils.js +1 -1
- package/dist/esm/packages/teams-js/src/internal/validOrigins.js +1 -1
- package/dist/esm/packages/teams-js/src/internal/videoEffectsUtils.js +1 -1
- package/dist/esm/packages/teams-js/src/internal/visualMediaHelpers.js +1 -0
- package/dist/esm/packages/teams-js/src/internal/webStorageHelpers.js +1 -0
- package/dist/esm/packages/teams-js/src/private/appEntity.js +1 -1
- package/dist/esm/packages/teams-js/src/private/conversations.js +1 -1
- package/dist/esm/packages/teams-js/src/private/copilot/copilot.js +1 -0
- package/dist/esm/packages/teams-js/src/private/copilot/eligibility.js +1 -0
- package/dist/esm/packages/teams-js/src/private/externalAppAuthentication.js +1 -1
- package/dist/esm/packages/teams-js/src/private/externalAppAuthenticationForCEA.js +1 -1
- package/dist/esm/packages/teams-js/src/private/externalAppCardActions.js +1 -1
- package/dist/esm/packages/teams-js/src/private/externalAppCardActionsForCEA.js +1 -1
- package/dist/esm/packages/teams-js/src/private/externalAppCommands.js +1 -1
- package/dist/esm/packages/teams-js/src/private/files.js +1 -1
- package/dist/esm/packages/teams-js/src/private/hostEntity/hostEntity.js +1 -0
- package/dist/esm/packages/teams-js/src/private/hostEntity/tab.js +1 -0
- package/dist/esm/packages/teams-js/src/private/logs.js +1 -1
- package/dist/esm/packages/teams-js/src/private/meetingRoom.js +1 -1
- package/dist/esm/packages/teams-js/src/private/messageChannels/dataLayer.js +1 -0
- package/dist/esm/packages/teams-js/src/private/messageChannels/messageChannels.js +1 -0
- package/dist/esm/packages/teams-js/src/private/messageChannels/telemetry.js +1 -0
- package/dist/esm/packages/teams-js/src/private/notifications.js +1 -1
- package/dist/esm/packages/teams-js/src/private/otherAppStateChange.js +1 -1
- package/dist/esm/packages/teams-js/src/private/remoteCamera.js +1 -1
- package/dist/esm/packages/teams-js/src/private/teams/fullTrust/fullTrust.js +1 -0
- package/dist/esm/packages/teams-js/src/private/teams/fullTrust/joinedTeams.js +1 -0
- package/dist/esm/packages/teams-js/src/private/teams/teams.js +1 -0
- package/dist/esm/packages/teams-js/src/private/videoEffectsEx.js +1 -1
- package/dist/esm/packages/teams-js/src/public/app/app.js +1 -0
- package/dist/esm/packages/teams-js/src/public/app/lifecycle.js +1 -0
- package/dist/esm/packages/teams-js/src/public/appInitialization.js +1 -1
- package/dist/esm/packages/teams-js/src/public/chat.js +1 -1
- package/dist/esm/packages/teams-js/src/public/clipboard.js +1 -1
- package/dist/esm/packages/teams-js/src/public/dialog/adaptiveCard/adaptiveCard.js +1 -0
- package/dist/esm/packages/teams-js/src/public/dialog/adaptiveCard/bot.js +1 -0
- package/dist/esm/packages/teams-js/src/public/dialog/dialog.js +1 -0
- package/dist/esm/packages/teams-js/src/public/dialog/update.js +1 -0
- package/dist/esm/packages/teams-js/src/public/dialog/url/bot.js +1 -0
- package/dist/esm/packages/teams-js/src/public/dialog/url/parentCommunication.js +1 -0
- package/dist/esm/packages/teams-js/src/public/dialog/url/url.js +1 -0
- package/dist/esm/packages/teams-js/src/public/geoLocation/geoLocation.js +1 -0
- package/dist/esm/packages/teams-js/src/public/geoLocation/map.js +1 -0
- package/dist/esm/packages/teams-js/src/public/liveShareHost.js +1 -1
- package/dist/esm/packages/teams-js/src/public/location.js +1 -1
- package/dist/esm/packages/teams-js/src/public/mail.js +1 -1
- package/dist/esm/packages/teams-js/src/public/marketplace.js +1 -1
- package/dist/esm/packages/teams-js/src/public/media.js +1 -1
- package/dist/esm/packages/teams-js/src/public/meeting/appShareButton.js +1 -0
- package/dist/esm/packages/teams-js/src/public/meeting/meeting.js +1 -0
- package/dist/esm/packages/teams-js/src/public/menus.js +1 -1
- package/dist/esm/packages/teams-js/src/public/monetization.js +1 -1
- package/dist/esm/packages/teams-js/src/public/navigation.js +1 -1
- package/dist/esm/packages/teams-js/src/public/nestedAppAuth.js +1 -1
- package/dist/esm/packages/teams-js/src/public/pages/appButton.js +1 -0
- package/dist/esm/packages/teams-js/src/public/pages/backStack.js +1 -0
- package/dist/esm/packages/teams-js/src/public/pages/config.js +1 -0
- package/dist/esm/packages/teams-js/src/public/pages/currentApp.js +1 -0
- package/dist/esm/packages/teams-js/src/public/pages/fullTrust.js +1 -0
- package/dist/esm/packages/teams-js/src/public/pages/pages.js +1 -0
- package/dist/esm/packages/teams-js/src/public/pages/tabs.js +1 -0
- package/dist/esm/packages/teams-js/src/public/people.js +1 -1
- package/dist/esm/packages/teams-js/src/public/profile.js +1 -1
- package/dist/esm/packages/teams-js/src/public/publicAPIs.js +1 -1
- package/dist/esm/packages/teams-js/src/public/runtime.js +1 -1
- package/dist/esm/packages/teams-js/src/public/search.js +1 -1
- package/dist/esm/packages/teams-js/src/public/secondaryBrowser.js +1 -1
- package/dist/esm/packages/teams-js/src/public/settings.js +1 -1
- package/dist/esm/packages/teams-js/src/public/sharing/history.js +1 -0
- package/dist/esm/packages/teams-js/src/public/sharing/sharing.js +1 -0
- package/dist/esm/packages/teams-js/src/public/stageView/self.js +1 -0
- package/dist/esm/packages/teams-js/src/public/stageView/stageView.js +1 -0
- package/dist/esm/packages/teams-js/src/public/tasks.js +1 -1
- package/dist/esm/packages/teams-js/src/public/teamsAPIs.js +1 -1
- package/dist/esm/packages/teams-js/src/public/thirdPartyCloudStorage.js +1 -1
- package/dist/esm/packages/teams-js/src/public/version.js +1 -1
- package/dist/esm/packages/teams-js/src/public/videoEffects.js +1 -1
- package/dist/esm/packages/teams-js/src/public/visualMedia/image.js +1 -0
- package/dist/esm/packages/teams-js/src/public/visualMedia/visualMedia.js +1 -0
- package/dist/esm/packages/teams-js/src/public/webStorage.js +1 -1
- package/dist/umd/MicrosoftTeams.d.ts +8195 -7407
- package/dist/umd/MicrosoftTeams.js +12298 -12356
- package/dist/umd/MicrosoftTeams.js.map +1 -1
- package/dist/umd/MicrosoftTeams.min.js +1 -1
- package/dist/umd/MicrosoftTeams.min.js.map +1 -1
- package/package.json +1 -1
- package/dist/esm/packages/teams-js/dts/private/copilot.d.ts +0 -39
- package/dist/esm/packages/teams-js/dts/private/hostEntity.d.ts +0 -176
- package/dist/esm/packages/teams-js/dts/private/messageChannels.d.ts +0 -107
- package/dist/esm/packages/teams-js/dts/private/teams.d.ts +0 -116
- package/dist/esm/packages/teams-js/dts/public/dialog.d.ts +0 -286
- package/dist/esm/packages/teams-js/dts/public/geoLocation.d.ts +0 -100
- package/dist/esm/packages/teams-js/dts/public/meeting.d.ts +0 -906
- package/dist/esm/packages/teams-js/dts/public/pages.d.ts +0 -574
- package/dist/esm/packages/teams-js/dts/public/sharing.d.ts +0 -124
- package/dist/esm/packages/teams-js/dts/public/stageView.d.ts +0 -104
- package/dist/esm/packages/teams-js/dts/public/visualMedia.d.ts +0 -192
- package/dist/esm/packages/teams-js/src/private/copilot.js +0 -1
- package/dist/esm/packages/teams-js/src/private/hostEntity.js +0 -1
- package/dist/esm/packages/teams-js/src/private/messageChannels.js +0 -1
- package/dist/esm/packages/teams-js/src/private/teams.js +0 -1
- package/dist/esm/packages/teams-js/src/public/app.js +0 -1
- package/dist/esm/packages/teams-js/src/public/dialog.js +0 -1
- package/dist/esm/packages/teams-js/src/public/geoLocation.js +0 -1
- package/dist/esm/packages/teams-js/src/public/meeting.js +0 -1
- package/dist/esm/packages/teams-js/src/public/pages.js +0 -1
- package/dist/esm/packages/teams-js/src/public/sharing.js +0 -1
- package/dist/esm/packages/teams-js/src/public/stageView.js +0 -1
- package/dist/esm/packages/teams-js/src/public/visualMedia.js +0 -1
- /package/dist/esm/node_modules/.pnpm/{@rollup_plugin-typescript@11.1.6_rollup@4.24.0_tslib@2.6.3_typescript@4.9.5 → @rollup_plugin-typescript@11.1.6_rollup@4.24.4_tslib@2.6.3_typescript@4.9.5}/node_modules/tslib/tslib.es6.js +0 -0
|
@@ -1,213 +1,212 @@
|
|
|
1
1
|
/**
|
|
2
|
-
*
|
|
3
|
-
* @beta
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
/**
|
|
16
|
-
* Video frame width
|
|
17
|
-
*/
|
|
18
|
-
width: number;
|
|
19
|
-
/**
|
|
20
|
-
* Video frame height
|
|
21
|
-
*/
|
|
22
|
-
height: number;
|
|
23
|
-
/**
|
|
24
|
-
* Video frame buffer
|
|
25
|
-
*/
|
|
26
|
-
videoFrameBuffer: Uint8ClampedArray;
|
|
27
|
-
/**
|
|
28
|
-
* NV12 luma stride, valid only when video frame format is NV12
|
|
29
|
-
*/
|
|
30
|
-
lumaStride?: number;
|
|
31
|
-
/**
|
|
32
|
-
* NV12 chroma stride, valid only when video frame format is NV12
|
|
33
|
-
*/
|
|
34
|
-
chromaStride?: number;
|
|
35
|
-
/**
|
|
36
|
-
* RGB stride, valid only when video frame format is RGB
|
|
37
|
-
*/
|
|
38
|
-
stride?: number;
|
|
39
|
-
/**
|
|
40
|
-
* The time stamp of the current video frame
|
|
41
|
-
*/
|
|
42
|
-
timestamp?: number;
|
|
43
|
-
}
|
|
44
|
-
/**
|
|
45
|
-
* Video frame format enum, currently only support NV12
|
|
46
|
-
* @beta
|
|
47
|
-
*/
|
|
48
|
-
enum VideoFrameFormat {
|
|
49
|
-
/** Video format used for encoding and decoding YUV color data in video streaming and storage applications. */
|
|
50
|
-
NV12 = "NV12"
|
|
51
|
-
}
|
|
2
|
+
* Module to support video extensibility of the SDK
|
|
3
|
+
* @beta
|
|
4
|
+
* @module
|
|
5
|
+
*/
|
|
6
|
+
/** Notify video frame processed function type */
|
|
7
|
+
export type notifyVideoFrameProcessedFunctionType = () => void;
|
|
8
|
+
/** Notify error function type */
|
|
9
|
+
export type notifyErrorFunctionType = (errorMessage: string) => void;
|
|
10
|
+
/**
|
|
11
|
+
* Represents a video frame
|
|
12
|
+
* @beta
|
|
13
|
+
*/
|
|
14
|
+
export interface VideoBufferData {
|
|
52
15
|
/**
|
|
53
|
-
* Video frame
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
/**
|
|
77
|
-
*
|
|
78
|
-
|
|
79
|
-
|
|
80
|
-
enum EffectFailureReason {
|
|
81
|
-
/**
|
|
82
|
-
* A wrong effect id is provide.
|
|
83
|
-
* 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.
|
|
84
|
-
*/
|
|
85
|
-
InvalidEffectId = "InvalidEffectId",
|
|
86
|
-
/**
|
|
87
|
-
* The effect can't be initialized
|
|
88
|
-
*/
|
|
89
|
-
InitializationFailure = "InitializationFailure"
|
|
90
|
-
}
|
|
91
|
-
/**
|
|
92
|
-
* Video effect change call back function definition
|
|
93
|
-
* Return a Promise which will be resolved when the effect is prepared, or throw an {@link EffectFailureReason} on error.
|
|
94
|
-
* @beta
|
|
95
|
-
*/
|
|
96
|
-
type VideoEffectCallback = (effectId: string | undefined) => Promise<void>;
|
|
97
|
-
/**
|
|
98
|
-
* @beta
|
|
99
|
-
* Video frame call back function definition
|
|
100
|
-
* The callback will be called on every frame when running on the supported host.
|
|
101
|
-
* We require the frame rate of the video to be at least 22fps for 720p, thus the callback should process a frame timely.
|
|
102
|
-
* The video app should call `notifyVideoFrameProcessed` to notify a successfully processed video frame.
|
|
103
|
-
* The video app should call `notifyError` to notify a failure. When the failures accumulate to a certain number, the host will see the app is "frozen" and ask the user to close it or not.
|
|
104
|
-
*/
|
|
105
|
-
type VideoBufferHandler = (videoBufferData: VideoBufferData, notifyVideoFrameProcessed: notifyVideoFrameProcessedFunctionType, notifyError: notifyErrorFunctionType) => void;
|
|
106
|
-
/**
|
|
107
|
-
* @beta
|
|
108
|
-
* VideoFrame definition, align with the W3C spec: https://www.w3.org/TR/webcodecs/#videoframe-interface.
|
|
109
|
-
* The current version of typescript doesn't have the definition of VideoFrame so we have to define it here.
|
|
110
|
-
* At runtime it can be cast to VideoFrame directly: `(videoFrame as VideoFrame)`.
|
|
111
|
-
*/
|
|
112
|
-
interface VideoFrame {
|
|
113
|
-
}
|
|
114
|
-
/**
|
|
115
|
-
* @beta
|
|
116
|
-
* Video frame data extracted from the media stream. More properties may be added in the future.
|
|
117
|
-
*/
|
|
118
|
-
type VideoFrameData = {
|
|
119
|
-
/**
|
|
120
|
-
* The video frame from the media stream.
|
|
121
|
-
*/
|
|
122
|
-
videoFrame: VideoFrame;
|
|
123
|
-
};
|
|
124
|
-
/**
|
|
125
|
-
* @beta
|
|
126
|
-
* Video frame call back function definition.
|
|
127
|
-
* The callback will be called on every frame when running on the supported host.
|
|
128
|
-
* We require the frame rate of the video to be at least 22fps for 720p, thus the callback should process a frame timely.
|
|
129
|
-
* The video app should resolve the promise to notify a successfully processed video frame.
|
|
130
|
-
* The video app should reject the promise to notify a failure. When the failures accumulate to a certain number, the host will see the app is "frozen" and ask the user to close it or not.
|
|
131
|
-
*/
|
|
132
|
-
type VideoFrameHandler = (receivedVideoFrame: VideoFrameData) => Promise<VideoFrame>;
|
|
133
|
-
/**
|
|
134
|
-
* @beta
|
|
135
|
-
* Callbacks and configuration supplied to the host to process the video frames.
|
|
136
|
-
*/
|
|
137
|
-
type RegisterForVideoFrameParameters = {
|
|
138
|
-
/**
|
|
139
|
-
* Callback function to process the video frames extracted from a media stream.
|
|
140
|
-
*/
|
|
141
|
-
videoFrameHandler: VideoFrameHandler;
|
|
142
|
-
/**
|
|
143
|
-
* Callback function to process the video frames shared by the host.
|
|
144
|
-
*/
|
|
145
|
-
videoBufferHandler: VideoBufferHandler;
|
|
146
|
-
/**
|
|
147
|
-
* Video frame configuration supplied to the host to customize the generated video frame parameters, like format
|
|
148
|
-
*/
|
|
149
|
-
config: VideoFrameConfig;
|
|
150
|
-
};
|
|
151
|
-
/**
|
|
152
|
-
* Register callbacks to process the video frames if the host supports it.
|
|
153
|
-
* @beta
|
|
154
|
-
* @param parameters - Callbacks and configuration to process the video frames. A host may support either {@link VideoFrameHandler} or {@link VideoBufferHandler}, but not both.
|
|
155
|
-
* To ensure the video effect works on all supported hosts, the video app must provide both {@link VideoFrameHandler} and {@link VideoBufferHandler}.
|
|
156
|
-
* The host will choose the appropriate callback based on the host's capability.
|
|
157
|
-
*
|
|
158
|
-
* @example
|
|
159
|
-
* ```typescript
|
|
160
|
-
* videoEffects.registerForVideoFrame({
|
|
161
|
-
* videoFrameHandler: async (videoFrameData) => {
|
|
162
|
-
* const originalFrame = videoFrameData.videoFrame as VideoFrame;
|
|
163
|
-
* try {
|
|
164
|
-
* const processedFrame = await processFrame(originalFrame);
|
|
165
|
-
* return processedFrame;
|
|
166
|
-
* } catch (e) {
|
|
167
|
-
* throw e;
|
|
168
|
-
* }
|
|
169
|
-
* },
|
|
170
|
-
* videoBufferHandler: (
|
|
171
|
-
* bufferData: VideoBufferData,
|
|
172
|
-
* notifyVideoFrameProcessed: notifyVideoFrameProcessedFunctionType,
|
|
173
|
-
* notifyError: notifyErrorFunctionType
|
|
174
|
-
* ) => {
|
|
175
|
-
* try {
|
|
176
|
-
* processFrameInplace(bufferData);
|
|
177
|
-
* notifyVideoFrameProcessed();
|
|
178
|
-
* } catch (e) {
|
|
179
|
-
* notifyError(e);
|
|
180
|
-
* }
|
|
181
|
-
* },
|
|
182
|
-
* config: {
|
|
183
|
-
* format: videoEffects.VideoPixelFormat.NV12,
|
|
184
|
-
* }
|
|
185
|
-
* });
|
|
186
|
-
* ```
|
|
187
|
-
*/
|
|
188
|
-
function registerForVideoFrame(parameters: RegisterForVideoFrameParameters): void;
|
|
189
|
-
/**
|
|
190
|
-
* Video extension should call this to notify host that the current selected effect parameter changed.
|
|
191
|
-
* If it's pre-meeting, host will call videoEffectCallback immediately then use the videoEffect.
|
|
192
|
-
* If it's the in-meeting scenario, we will call videoEffectCallback when apply button clicked.
|
|
193
|
-
* @beta
|
|
194
|
-
* @param effectChangeType - the effect change type.
|
|
195
|
-
* @param effectId - Newly selected effect id.
|
|
196
|
-
*/
|
|
197
|
-
function notifySelectedVideoEffectChanged(effectChangeType: EffectChangeType, effectId: string | undefined): void;
|
|
198
|
-
/**
|
|
199
|
-
* Register a callback to be notified when a new video effect is applied.
|
|
200
|
-
* @beta
|
|
201
|
-
* @param callback - Function to be called when new video effect is applied.
|
|
202
|
-
*/
|
|
203
|
-
function registerForVideoEffect(callback: VideoEffectCallback): void;
|
|
204
|
-
/**
|
|
205
|
-
* Checks if video capability is supported by the host.
|
|
206
|
-
* @beta
|
|
207
|
-
* @returns boolean to represent whether the video capability is supported
|
|
208
|
-
*
|
|
209
|
-
* @throws Error if {@linkcode app.initialize} has not successfully completed
|
|
210
|
-
*
|
|
211
|
-
*/
|
|
212
|
-
function isSupported(): boolean;
|
|
16
|
+
* Video frame width
|
|
17
|
+
*/
|
|
18
|
+
width: number;
|
|
19
|
+
/**
|
|
20
|
+
* Video frame height
|
|
21
|
+
*/
|
|
22
|
+
height: number;
|
|
23
|
+
/**
|
|
24
|
+
* Video frame buffer
|
|
25
|
+
*/
|
|
26
|
+
videoFrameBuffer: Uint8ClampedArray;
|
|
27
|
+
/**
|
|
28
|
+
* NV12 luma stride, valid only when video frame format is NV12
|
|
29
|
+
*/
|
|
30
|
+
lumaStride?: number;
|
|
31
|
+
/**
|
|
32
|
+
* NV12 chroma stride, valid only when video frame format is NV12
|
|
33
|
+
*/
|
|
34
|
+
chromaStride?: number;
|
|
35
|
+
/**
|
|
36
|
+
* RGB stride, valid only when video frame format is RGB
|
|
37
|
+
*/
|
|
38
|
+
stride?: number;
|
|
39
|
+
/**
|
|
40
|
+
* The time stamp of the current video frame
|
|
41
|
+
*/
|
|
42
|
+
timestamp?: number;
|
|
213
43
|
}
|
|
44
|
+
/**
|
|
45
|
+
* Video frame format enum, currently only support NV12
|
|
46
|
+
* @beta
|
|
47
|
+
*/
|
|
48
|
+
export declare enum VideoFrameFormat {
|
|
49
|
+
/** Video format used for encoding and decoding YUV color data in video streaming and storage applications. */
|
|
50
|
+
NV12 = "NV12"
|
|
51
|
+
}
|
|
52
|
+
/**
|
|
53
|
+
* Video frame configuration supplied to the host to customize the generated video frame parameters, like format
|
|
54
|
+
* @beta
|
|
55
|
+
*/
|
|
56
|
+
export interface VideoFrameConfig {
|
|
57
|
+
/**
|
|
58
|
+
* Video format
|
|
59
|
+
*/
|
|
60
|
+
format: VideoFrameFormat;
|
|
61
|
+
}
|
|
62
|
+
/**
|
|
63
|
+
* Video effect change type enum
|
|
64
|
+
* @beta
|
|
65
|
+
*/
|
|
66
|
+
export declare enum EffectChangeType {
|
|
67
|
+
/**
|
|
68
|
+
* Current video effect changed
|
|
69
|
+
*/
|
|
70
|
+
EffectChanged = "EffectChanged",
|
|
71
|
+
/**
|
|
72
|
+
* Disable the video effect
|
|
73
|
+
*/
|
|
74
|
+
EffectDisabled = "EffectDisabled"
|
|
75
|
+
}
|
|
76
|
+
/**
|
|
77
|
+
* Predefined failure reasons for preparing the selected video effect
|
|
78
|
+
* @beta
|
|
79
|
+
*/
|
|
80
|
+
export declare enum EffectFailureReason {
|
|
81
|
+
/**
|
|
82
|
+
* A wrong effect id is provide.
|
|
83
|
+
* 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.
|
|
84
|
+
*/
|
|
85
|
+
InvalidEffectId = "InvalidEffectId",
|
|
86
|
+
/**
|
|
87
|
+
* The effect can't be initialized
|
|
88
|
+
*/
|
|
89
|
+
InitializationFailure = "InitializationFailure"
|
|
90
|
+
}
|
|
91
|
+
/**
|
|
92
|
+
* Video effect change call back function definition
|
|
93
|
+
* Return a Promise which will be resolved when the effect is prepared, or throw an {@link EffectFailureReason} on error.
|
|
94
|
+
* @beta
|
|
95
|
+
*/
|
|
96
|
+
export type VideoEffectCallback = (effectId: string | undefined) => Promise<void>;
|
|
97
|
+
/**
|
|
98
|
+
* @beta
|
|
99
|
+
* Video frame call back function definition
|
|
100
|
+
* The callback will be called on every frame when running on the supported host.
|
|
101
|
+
* We require the frame rate of the video to be at least 22fps for 720p, thus the callback should process a frame timely.
|
|
102
|
+
* The video app should call `notifyVideoFrameProcessed` to notify a successfully processed video frame.
|
|
103
|
+
* The video app should call `notifyError` to notify a failure. When the failures accumulate to a certain number, the host will see the app is "frozen" and ask the user to close it or not.
|
|
104
|
+
*/
|
|
105
|
+
export type VideoBufferHandler = (videoBufferData: VideoBufferData, notifyVideoFrameProcessed: notifyVideoFrameProcessedFunctionType, notifyError: notifyErrorFunctionType) => void;
|
|
106
|
+
/**
|
|
107
|
+
* @beta
|
|
108
|
+
* VideoFrame definition, align with the W3C spec: https://www.w3.org/TR/webcodecs/#videoframe-interface.
|
|
109
|
+
* The current version of typescript doesn't have the definition of VideoFrame so we have to define it here.
|
|
110
|
+
* At runtime it can be cast to VideoFrame directly: `(videoFrame as VideoFrame)`.
|
|
111
|
+
*/
|
|
112
|
+
export interface VideoFrame {
|
|
113
|
+
}
|
|
114
|
+
/**
|
|
115
|
+
* @beta
|
|
116
|
+
* Video frame data extracted from the media stream. More properties may be added in the future.
|
|
117
|
+
*/
|
|
118
|
+
export type VideoFrameData = {
|
|
119
|
+
/**
|
|
120
|
+
* The video frame from the media stream.
|
|
121
|
+
*/
|
|
122
|
+
videoFrame: VideoFrame;
|
|
123
|
+
};
|
|
124
|
+
/**
|
|
125
|
+
* @beta
|
|
126
|
+
* Video frame call back function definition.
|
|
127
|
+
* The callback will be called on every frame when running on the supported host.
|
|
128
|
+
* We require the frame rate of the video to be at least 22fps for 720p, thus the callback should process a frame timely.
|
|
129
|
+
* The video app should resolve the promise to notify a successfully processed video frame.
|
|
130
|
+
* The video app should reject the promise to notify a failure. When the failures accumulate to a certain number, the host will see the app is "frozen" and ask the user to close it or not.
|
|
131
|
+
*/
|
|
132
|
+
export type VideoFrameHandler = (receivedVideoFrame: VideoFrameData) => Promise<VideoFrame>;
|
|
133
|
+
/**
|
|
134
|
+
* @beta
|
|
135
|
+
* Callbacks and configuration supplied to the host to process the video frames.
|
|
136
|
+
*/
|
|
137
|
+
export type RegisterForVideoFrameParameters = {
|
|
138
|
+
/**
|
|
139
|
+
* Callback function to process the video frames extracted from a media stream.
|
|
140
|
+
*/
|
|
141
|
+
videoFrameHandler: VideoFrameHandler;
|
|
142
|
+
/**
|
|
143
|
+
* Callback function to process the video frames shared by the host.
|
|
144
|
+
*/
|
|
145
|
+
videoBufferHandler: VideoBufferHandler;
|
|
146
|
+
/**
|
|
147
|
+
* Video frame configuration supplied to the host to customize the generated video frame parameters, like format
|
|
148
|
+
*/
|
|
149
|
+
config: VideoFrameConfig;
|
|
150
|
+
};
|
|
151
|
+
/**
|
|
152
|
+
* Register callbacks to process the video frames if the host supports it.
|
|
153
|
+
* @beta
|
|
154
|
+
* @param parameters - Callbacks and configuration to process the video frames. A host may support either {@link VideoFrameHandler} or {@link VideoBufferHandler}, but not both.
|
|
155
|
+
* To ensure the video effect works on all supported hosts, the video app must provide both {@link VideoFrameHandler} and {@link VideoBufferHandler}.
|
|
156
|
+
* The host will choose the appropriate callback based on the host's capability.
|
|
157
|
+
*
|
|
158
|
+
* @example
|
|
159
|
+
* ```typescript
|
|
160
|
+
* videoEffects.registerForVideoFrame({
|
|
161
|
+
* videoFrameHandler: async (videoFrameData) => {
|
|
162
|
+
* const originalFrame = videoFrameData.videoFrame as VideoFrame;
|
|
163
|
+
* try {
|
|
164
|
+
* const processedFrame = await processFrame(originalFrame);
|
|
165
|
+
* return processedFrame;
|
|
166
|
+
* } catch (e) {
|
|
167
|
+
* throw e;
|
|
168
|
+
* }
|
|
169
|
+
* },
|
|
170
|
+
* videoBufferHandler: (
|
|
171
|
+
* bufferData: VideoBufferData,
|
|
172
|
+
* notifyVideoFrameProcessed: notifyVideoFrameProcessedFunctionType,
|
|
173
|
+
* notifyError: notifyErrorFunctionType
|
|
174
|
+
* ) => {
|
|
175
|
+
* try {
|
|
176
|
+
* processFrameInplace(bufferData);
|
|
177
|
+
* notifyVideoFrameProcessed();
|
|
178
|
+
* } catch (e) {
|
|
179
|
+
* notifyError(e);
|
|
180
|
+
* }
|
|
181
|
+
* },
|
|
182
|
+
* config: {
|
|
183
|
+
* format: videoEffects.VideoPixelFormat.NV12,
|
|
184
|
+
* }
|
|
185
|
+
* });
|
|
186
|
+
* ```
|
|
187
|
+
*/
|
|
188
|
+
export declare function registerForVideoFrame(parameters: RegisterForVideoFrameParameters): void;
|
|
189
|
+
/**
|
|
190
|
+
* Video extension should call this to notify host that the current selected effect parameter changed.
|
|
191
|
+
* If it's pre-meeting, host will call videoEffectCallback immediately then use the videoEffect.
|
|
192
|
+
* If it's the in-meeting scenario, we will call videoEffectCallback when apply button clicked.
|
|
193
|
+
* @beta
|
|
194
|
+
* @param effectChangeType - the effect change type.
|
|
195
|
+
* @param effectId - Newly selected effect id.
|
|
196
|
+
*/
|
|
197
|
+
export declare function notifySelectedVideoEffectChanged(effectChangeType: EffectChangeType, effectId: string | undefined): void;
|
|
198
|
+
/**
|
|
199
|
+
* Register a callback to be notified when a new video effect is applied.
|
|
200
|
+
* @beta
|
|
201
|
+
* @param callback - Function to be called when new video effect is applied.
|
|
202
|
+
*/
|
|
203
|
+
export declare function registerForVideoEffect(callback: VideoEffectCallback): void;
|
|
204
|
+
/**
|
|
205
|
+
* Checks if video capability is supported by the host.
|
|
206
|
+
* @beta
|
|
207
|
+
* @returns boolean to represent whether the video capability is supported
|
|
208
|
+
*
|
|
209
|
+
* @throws Error if {@linkcode app.initialize} has not successfully completed
|
|
210
|
+
*
|
|
211
|
+
*/
|
|
212
|
+
export declare function isSupported(): boolean;
|
|
@@ -0,0 +1,64 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* @hidden
|
|
3
|
+
* To enable this image capability will let the app developer ask the user to get images from camera/local storage
|
|
4
|
+
*
|
|
5
|
+
* @beta
|
|
6
|
+
* @module
|
|
7
|
+
*/
|
|
8
|
+
import { VisualMediaProps } from '../../internal/visualMediaHelpers';
|
|
9
|
+
import { CameraProps, GalleryProps, VisualMediaFile } from './visualMedia';
|
|
10
|
+
/**
|
|
11
|
+
* @hidden
|
|
12
|
+
* CameraImageProperties is for the image taken from the camera
|
|
13
|
+
*
|
|
14
|
+
* @beta
|
|
15
|
+
*/
|
|
16
|
+
export interface CameraImageProperties extends VisualMediaProps {
|
|
17
|
+
/**
|
|
18
|
+
* @hidden
|
|
19
|
+
* The source in CameraImageProperties should always be CameraProps
|
|
20
|
+
*/
|
|
21
|
+
sourceProps: CameraProps;
|
|
22
|
+
}
|
|
23
|
+
/**
|
|
24
|
+
* @hidden
|
|
25
|
+
* CameraImageProperties is for the image taken from the camera
|
|
26
|
+
*
|
|
27
|
+
* @beta
|
|
28
|
+
*/
|
|
29
|
+
export interface GalleryImageProperties extends VisualMediaProps {
|
|
30
|
+
/**
|
|
31
|
+
* @hidden
|
|
32
|
+
* The source in GalleryImageProperties should always be GalleryProps
|
|
33
|
+
*/
|
|
34
|
+
sourceProps: GalleryProps;
|
|
35
|
+
}
|
|
36
|
+
/**
|
|
37
|
+
* @hidden
|
|
38
|
+
* Capture one or multiple image(s) using camera.
|
|
39
|
+
* @param cameraImageInputs - The input params to customize the image(s) to be captured
|
|
40
|
+
* @returns Promise that will resolve with {@link VisualMediaFile[]} object or reject with an error.
|
|
41
|
+
* @throws INVALID_ARGUMENTS Error if imageInputs is null or imageInputs.maxVisualMediaCount is greater than maxVisualMediaSelectionLimit or lesser than 1.
|
|
42
|
+
*
|
|
43
|
+
* @beta
|
|
44
|
+
*/
|
|
45
|
+
export declare function captureImages(cameraImageInputs: CameraImageProperties): Promise<VisualMediaFile[]>;
|
|
46
|
+
/**
|
|
47
|
+
* @hidden
|
|
48
|
+
* Upload the existing image(s) from the gallery.
|
|
49
|
+
* @param galleryImageInputs - The input params to customize the image(s) to be captured
|
|
50
|
+
* @returns Promise that will resolve with {@link VisualMediaFile[]} object or reject with an error.
|
|
51
|
+
* @throws INVALID_ARGUMENTS Error if imageInputs is null or imageInputs.maxVisualMediaCount is greater than maxVisualMediaSelectionLimit or lesser than 1.
|
|
52
|
+
*
|
|
53
|
+
* @beta
|
|
54
|
+
*/
|
|
55
|
+
export declare function retrieveImages(galleryImageInputs: GalleryImageProperties): Promise<VisualMediaFile[]>;
|
|
56
|
+
/**
|
|
57
|
+
* @hidden
|
|
58
|
+
* Checks if visualMedia.image capability is supported by the host
|
|
59
|
+
* @returns boolean to represent whether visualMedia.image is supported
|
|
60
|
+
* @throws Error if {@linkcode app.initialize} has not successfully completed
|
|
61
|
+
*
|
|
62
|
+
* @beta
|
|
63
|
+
*/
|
|
64
|
+
export declare function isSupported(): boolean;
|
|
@@ -0,0 +1,116 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* @hidden
|
|
3
|
+
* Interact with images. Allows the app developer ask the user to get images from their camera / camera roll / file system.
|
|
4
|
+
*
|
|
5
|
+
* @beta
|
|
6
|
+
* @module
|
|
7
|
+
*/
|
|
8
|
+
import * as image from './image';
|
|
9
|
+
/**
|
|
10
|
+
* @hidden
|
|
11
|
+
* The required value of the visualMedia files from gallery
|
|
12
|
+
*
|
|
13
|
+
* @beta
|
|
14
|
+
*/
|
|
15
|
+
export interface GalleryProps {
|
|
16
|
+
/**
|
|
17
|
+
* The visualMedia source
|
|
18
|
+
*/
|
|
19
|
+
source: Source.Gallery;
|
|
20
|
+
}
|
|
21
|
+
/**
|
|
22
|
+
* @hidden
|
|
23
|
+
* The required value of the visualMedia files from camera
|
|
24
|
+
*
|
|
25
|
+
* @beta
|
|
26
|
+
*/
|
|
27
|
+
export interface CameraProps {
|
|
28
|
+
/**
|
|
29
|
+
* @hidden
|
|
30
|
+
* The visualMedia source
|
|
31
|
+
*/
|
|
32
|
+
source: Source.Camera;
|
|
33
|
+
/**
|
|
34
|
+
* @hidden
|
|
35
|
+
* Optional; Specify whether users have the option to switch between the front and rear cameras. The default setting is FrontOrRear.
|
|
36
|
+
* Default value is FrontOrRear
|
|
37
|
+
*/
|
|
38
|
+
cameraRestriction?: CameraRestriction;
|
|
39
|
+
}
|
|
40
|
+
/**
|
|
41
|
+
* @hidden
|
|
42
|
+
* Indicate if user is allowed to move between front and back camera or stay in front/back camera only
|
|
43
|
+
* If the camera option requested by the app isn't available, the SDK will silently default to the platform's standard camera.
|
|
44
|
+
*
|
|
45
|
+
* @beta
|
|
46
|
+
*/
|
|
47
|
+
export declare enum CameraRestriction {
|
|
48
|
+
/** User can move between front and back camera */
|
|
49
|
+
FrontOrRear = 1,
|
|
50
|
+
/** User can only use the front camera */
|
|
51
|
+
FrontOnly = 2,
|
|
52
|
+
/** User can only use the back camera */
|
|
53
|
+
RearOnly = 3
|
|
54
|
+
}
|
|
55
|
+
/**
|
|
56
|
+
* @hidden
|
|
57
|
+
* Specifies the image source
|
|
58
|
+
*
|
|
59
|
+
* @beta
|
|
60
|
+
*/
|
|
61
|
+
export declare enum Source {
|
|
62
|
+
/** The camera is the source of visual media. */
|
|
63
|
+
Camera = 1,
|
|
64
|
+
/** The source of visual media is the gallery. */
|
|
65
|
+
Gallery = 2
|
|
66
|
+
}
|
|
67
|
+
/**
|
|
68
|
+
* @hidden
|
|
69
|
+
* VisualMediaFile object that can be used to represent image or video from host apps.
|
|
70
|
+
*
|
|
71
|
+
* @beta
|
|
72
|
+
*/
|
|
73
|
+
export interface VisualMediaFile {
|
|
74
|
+
/**
|
|
75
|
+
* @hidden
|
|
76
|
+
* This is the base64 content of file.
|
|
77
|
+
* If app needs to use this directly in HTML tags, it should convert this to a data url.
|
|
78
|
+
*/
|
|
79
|
+
content: string;
|
|
80
|
+
/**
|
|
81
|
+
* @hidden
|
|
82
|
+
* The size of file represented in VisualMediaFile in KB
|
|
83
|
+
*/
|
|
84
|
+
sizeInKB: number;
|
|
85
|
+
/**
|
|
86
|
+
* @hidden
|
|
87
|
+
* Name of the file (does not include the extension)
|
|
88
|
+
*/
|
|
89
|
+
name: string;
|
|
90
|
+
/**
|
|
91
|
+
* @hidden
|
|
92
|
+
* File's MIME type. More information on supported `mimeTypes`(https://docs.lens.xyz/docs/metadata-standards#supported-mime-types-for-imagesaudiovideos).
|
|
93
|
+
*/
|
|
94
|
+
mimeType: string;
|
|
95
|
+
}
|
|
96
|
+
/**
|
|
97
|
+
* @hidden
|
|
98
|
+
* Checks whether or not visualMedia has user permission
|
|
99
|
+
* @returns Promise that will resolve with true if the user had granted the app permission to media information(including Camera and Gallery permission), or with false otherwise,
|
|
100
|
+
* In case of an error, promise will reject with the error.
|
|
101
|
+
* @throws NOT_SUPPORTED_ON_PLATFORM Error if the DevicePermission.Media permission has not successfully granted.
|
|
102
|
+
*
|
|
103
|
+
* @beta
|
|
104
|
+
*/
|
|
105
|
+
export declare function hasPermission(): Promise<boolean>;
|
|
106
|
+
/**
|
|
107
|
+
* @hidden
|
|
108
|
+
* Requests user permission for visualMedia
|
|
109
|
+
* @returns Promise that will resolve with true if the user consented permission for media(including Camera and Gallery permission), or with false otherwise,
|
|
110
|
+
* In case of an error, promise will reject with the error.
|
|
111
|
+
* @throws NOT_SUPPORTED_ON_PLATFORM Error if the DevicePermission.Media permission has not successfully granted.
|
|
112
|
+
*
|
|
113
|
+
* @beta
|
|
114
|
+
*/
|
|
115
|
+
export declare function requestPermission(): Promise<boolean>;
|
|
116
|
+
export { image };
|
|
@@ -2,26 +2,24 @@
|
|
|
2
2
|
* Contains functionality enabling apps to query properties about how the host manages web storage (`Window.LocalStorage`)
|
|
3
3
|
*
|
|
4
4
|
* @beta
|
|
5
|
+
* @module
|
|
5
6
|
*/
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
function isSupported(): boolean;
|
|
26
|
-
}
|
|
27
|
-
export declare function clearWebStorageCachedHostNameForTests(): void;
|
|
7
|
+
/**
|
|
8
|
+
* Checks if web storage (`Window.LocalStorage`) gets cleared when a user logs out from host
|
|
9
|
+
*
|
|
10
|
+
* @returns `true` if web storage gets cleared on logout and `false` if not
|
|
11
|
+
*
|
|
12
|
+
* @throws `Error` if {@linkcode app.initialize} has not successfully completed
|
|
13
|
+
*
|
|
14
|
+
* @beta
|
|
15
|
+
*/
|
|
16
|
+
export declare function isWebStorageClearedOnUserLogOut(): Promise<boolean>;
|
|
17
|
+
/**
|
|
18
|
+
* Checks if webStorage capability is supported by the host
|
|
19
|
+
* @returns boolean to represent whether the webStorage capability is supported
|
|
20
|
+
*
|
|
21
|
+
* @throws Error if {@linkcode app.initialize} has not successfully completed
|
|
22
|
+
*
|
|
23
|
+
* @beta
|
|
24
|
+
*/
|
|
25
|
+
export declare function isSupported(): boolean;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
export{
|
|
1
|
+
export{NotificationTypes,UserSettingTypes,ViewerActionTypes}from"./private/interfaces.js";export{openFilePreview,registerCustomHandler,registerUserSettingsChangeHandler,sendCustomEvent,sendCustomMessage,uploadCustomApp}from"./private/privateAPIs.js";import*as r from"./private/logs.js";export{r as logs};import*as e from"./private/conversations.js";export{e as conversations};import*as o from"./private/copilot/copilot.js";export{o as copilot};import*as t from"./private/externalAppAuthentication.js";export{t as externalAppAuthentication};import*as p from"./private/externalAppAuthenticationForCEA.js";export{p as externalAppAuthenticationForCEA};import*as i from"./private/externalAppCardActions.js";export{i as externalAppCardActions};import*as s from"./private/externalAppCardActionsForCEA.js";export{s as externalAppCardActionsForCEA};import*as a from"./private/externalAppCommands.js";export{a as externalAppCommands};import*as m from"./private/files.js";export{m as files};import*as n from"./private/meetingRoom.js";export{n as meetingRoom};import*as l from"./private/messageChannels/messageChannels.js";export{l as messageChannels};import*as c from"./private/notifications.js";export{c as notifications};import*as f from"./private/otherAppStateChange.js";export{f as otherAppStateChange};import*as x from"./private/remoteCamera.js";export{x as remoteCamera};import*as u from"./private/appEntity.js";export{u as appEntity};import*as j from"./private/teams/teams.js";export{j as teams};import*as b from"./private/videoEffectsEx.js";export{b as videoEffectsEx};import*as d from"./private/hostEntity/hostEntity.js";export{d as hostEntity};export{ChannelType,DialogDimension,FrameContexts,HostClientType,HostName,DialogDimension as TaskModuleDimension,TeamType,UserTeamRole}from"./public/constants.js";export{ActionObjectType,ErrorCode,FileOpenPreference,SecondaryM365ContentIdName}from"./public/interfaces.js";export{AppId}from"./public/appId.js";export{EmailAddress}from"./public/emailAddress.js";export{getAdaptiveCardSchemaVersion}from"./public/adaptiveCards.js";export{ChildAppWindow,ParentAppWindow}from"./public/appWindow.js";export{version}from"./public/version.js";export{enablePrintCapability,executeDeepLink,getContext,getMruTabInstances,getTabInstances,initialize,initializeWithFrameContext,print,registerAppButtonClickHandler,registerAppButtonHoverEnterHandler,registerAppButtonHoverLeaveHandler,registerBackButtonHandler,registerBeforeUnloadHandler,registerChangeSettingsHandler,registerFocusEnterHandler,registerFullScreenHandler,registerOnLoadHandler,registerOnThemeChangeHandler,setFrameContext,shareDeepLink}from"./public/publicAPIs.js";export{navigateBack,navigateCrossDomain,navigateToTab,returnFocus}from"./public/navigation.js";import*as g from"./public/liveShareHost.js";export{g as liveShare};export{LiveShareHost}from"./public/liveShareHost.js";import*as v from"./public/authentication.js";export{v as authentication};import*as C from"./public/app/app.js";export{C as app};import*as A from"./public/appInstallDialog.js";export{A as appInstallDialog};import*as h from"./public/barCode.js";export{h as barCode};import*as H from"./public/chat.js";export{H as chat};import*as T from"./public/clipboard.js";export{T as clipboard};import*as y from"./public/dialog/dialog.js";export{y as dialog};import*as E from"./public/nestedAppAuth.js";export{E as nestedAppAuth};import*as S from"./public/geoLocation/geoLocation.js";export{S as geoLocation};import*as F from"./public/pages/pages.js";export{F as pages};import*as I from"./public/menus.js";export{I as menus};import*as w from"./public/media.js";export{w as media};import*as D from"./public/secondaryBrowser.js";export{D as secondaryBrowser};import*as k from"./public/location.js";export{k as location};import*as B from"./public/meeting/meeting.js";export{B as meeting};import*as P from"./public/monetization.js";export{P as monetization};import*as L from"./public/calendar.js";export{L as calendar};import*as M from"./public/mail.js";export{M as mail};import*as z from"./public/teamsAPIs.js";export{z as teamsCore};import*as O from"./public/people.js";export{O as people};import*as U from"./public/profile.js";export{U as profile};import*as V from"./public/videoEffects.js";export{V as videoEffects};import*as W from"./public/search.js";export{W as search};import*as N from"./public/sharing/sharing.js";export{N as sharing};import*as R from"./public/stageView/stageView.js";export{R as stageView};import*as q from"./public/visualMedia/visualMedia.js";export{q as visualMedia};import*as G from"./public/webStorage.js";export{G as webStorage};import*as J from"./public/call.js";export{J as call};import*as K from"./public/appInitialization.js";export{K as appInitialization};import*as Q from"./public/thirdPartyCloudStorage.js";export{Q as thirdPartyCloudStorage};import*as X from"./public/settings.js";export{X as settings};import*as Y from"./public/tasks.js";export{Y as tasks};import*as Z from"./public/marketplace.js";export{Z as marketplace};
|