@microsoft/live-share-react 2.0.0-internal.18 → 2.0.0-internal.19
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/README.md +6 -0
- package/bin/esm/live-hooks/useLiveCanvas.js +29 -30
- package/bin/esm/live-hooks/useLiveCanvas.js.map +1 -1
- package/bin/esm/live-hooks/useLiveEvent.js +6 -15
- package/bin/esm/live-hooks/useLiveEvent.js.map +1 -1
- package/bin/esm/live-hooks/useLiveFollowMode.js +25 -34
- package/bin/esm/live-hooks/useLiveFollowMode.js.map +1 -1
- package/bin/esm/live-hooks/useLivePresence.js +5 -14
- package/bin/esm/live-hooks/useLivePresence.js.map +1 -1
- package/bin/esm/live-hooks/useLiveState.js +4 -13
- package/bin/esm/live-hooks/useLiveState.js.map +1 -1
- package/bin/esm/live-hooks/useLiveTimer.js +22 -31
- package/bin/esm/live-hooks/useLiveTimer.js.map +1 -1
- package/bin/esm/live-hooks/useMediaSynchronizer.js +24 -33
- package/bin/esm/live-hooks/useMediaSynchronizer.js.map +1 -1
- package/bin/esm/providers/AzureProvider.js +22 -27
- package/bin/esm/providers/AzureProvider.js.map +1 -1
- package/bin/esm/providers/LiveShareProvider.js +20 -21
- package/bin/esm/providers/LiveShareProvider.js.map +1 -1
- package/bin/esm/shared-hooks/internals/tree-node-types.js +1 -1
- package/bin/esm/shared-hooks/internals/tree-node-types.js.map +1 -1
- package/bin/esm/shared-hooks/internals/tree-node-utils.js +2 -4
- package/bin/esm/shared-hooks/internals/tree-node-utils.js.map +1 -1
- package/bin/esm/shared-hooks/useDynamicDDS.js +3 -12
- package/bin/esm/shared-hooks/useDynamicDDS.js.map +1 -1
- package/bin/esm/shared-hooks/useSharedMap.js +1 -1
- package/bin/esm/shared-hooks/useSharedMap.js.map +1 -1
- package/bin/esm/shared-hooks/useSharedStateRegistry.js +13 -10
- package/bin/esm/shared-hooks/useSharedStateRegistry.js.map +1 -1
- package/bin/esm/shared-hooks/useSharedTree.js +4 -4
- package/bin/esm/shared-hooks/useSharedTree.js.map +1 -1
- package/bin/esm/types/FluidMap.d.ts +151 -0
- package/bin/esm/types/FluidMap.d.ts.map +1 -0
- package/bin/esm/types/FluidMap.js +24 -0
- package/bin/esm/types/FluidMap.js.map +1 -0
- package/bin/esm/types/ResultTypes.d.ts +15 -1
- package/bin/esm/types/ResultTypes.d.ts.map +1 -1
- package/bin/esm/utils/type-check.js +1 -1
- package/bin/esm/utils/type-check.js.map +1 -1
- package/package.json +11 -21
- package/src/types/FluidMap.ts +169 -0
- package/src/types/ResultTypes.ts +18 -1
- package/tsconfig.json +3 -4
- package/bin/cjs/index.d.ts +0 -7
- package/bin/cjs/index.d.ts.map +0 -1
- package/bin/cjs/index.js +0 -23
- package/bin/cjs/index.js.map +0 -1
- package/bin/cjs/interfaces/LiveInterfaceExtensions.d.ts +0 -26
- package/bin/cjs/interfaces/LiveInterfaceExtensions.d.ts.map +0 -1
- package/bin/cjs/interfaces/LiveInterfaceExtensions.js +0 -7
- package/bin/cjs/interfaces/LiveInterfaceExtensions.js.map +0 -1
- package/bin/cjs/interfaces/index.d.ts +0 -2
- package/bin/cjs/interfaces/index.d.ts.map +0 -1
- package/bin/cjs/interfaces/index.js +0 -18
- package/bin/cjs/interfaces/index.js.map +0 -1
- package/bin/cjs/internal/errors.d.ts +0 -41
- package/bin/cjs/internal/errors.d.ts.map +0 -1
- package/bin/cjs/internal/errors.js +0 -48
- package/bin/cjs/internal/errors.js.map +0 -1
- package/bin/cjs/internal/index.d.ts +0 -3
- package/bin/cjs/internal/index.d.ts.map +0 -1
- package/bin/cjs/internal/index.js +0 -19
- package/bin/cjs/internal/index.js.map +0 -1
- package/bin/cjs/internal/type-guards.d.ts +0 -11
- package/bin/cjs/internal/type-guards.d.ts.map +0 -1
- package/bin/cjs/internal/type-guards.js +0 -24
- package/bin/cjs/internal/type-guards.js.map +0 -1
- package/bin/cjs/live-hooks/index.d.ts +0 -8
- package/bin/cjs/live-hooks/index.d.ts.map +0 -1
- package/bin/cjs/live-hooks/index.js +0 -24
- package/bin/cjs/live-hooks/index.js.map +0 -1
- package/bin/cjs/live-hooks/useLiveCanvas.d.ts +0 -80
- package/bin/cjs/live-hooks/useLiveCanvas.d.ts.map +0 -1
- package/bin/cjs/live-hooks/useLiveCanvas.js +0 -244
- package/bin/cjs/live-hooks/useLiveCanvas.js.map +0 -1
- package/bin/cjs/live-hooks/useLiveEvent.d.ts +0 -59
- package/bin/cjs/live-hooks/useLiveEvent.d.ts.map +0 -1
- package/bin/cjs/live-hooks/useLiveEvent.js +0 -150
- package/bin/cjs/live-hooks/useLiveEvent.js.map +0 -1
- package/bin/cjs/live-hooks/useLiveFollowMode.d.ts +0 -163
- package/bin/cjs/live-hooks/useLiveFollowMode.d.ts.map +0 -1
- package/bin/cjs/live-hooks/useLiveFollowMode.js +0 -360
- package/bin/cjs/live-hooks/useLiveFollowMode.js.map +0 -1
- package/bin/cjs/live-hooks/useLivePresence.d.ts +0 -76
- package/bin/cjs/live-hooks/useLivePresence.d.ts.map +0 -1
- package/bin/cjs/live-hooks/useLivePresence.js +0 -170
- package/bin/cjs/live-hooks/useLivePresence.js.map +0 -1
- package/bin/cjs/live-hooks/useLiveState.d.ts +0 -66
- package/bin/cjs/live-hooks/useLiveState.d.ts.map +0 -1
- package/bin/cjs/live-hooks/useLiveState.js +0 -134
- package/bin/cjs/live-hooks/useLiveState.js.map +0 -1
- package/bin/cjs/live-hooks/useLiveTimer.d.ts +0 -80
- package/bin/cjs/live-hooks/useLiveTimer.d.ts.map +0 -1
- package/bin/cjs/live-hooks/useLiveTimer.js +0 -233
- package/bin/cjs/live-hooks/useLiveTimer.js.map +0 -1
- package/bin/cjs/live-hooks/useMediaSynchronizer.d.ts +0 -86
- package/bin/cjs/live-hooks/useMediaSynchronizer.d.ts.map +0 -1
- package/bin/cjs/live-hooks/useMediaSynchronizer.js +0 -301
- package/bin/cjs/live-hooks/useMediaSynchronizer.js.map +0 -1
- package/bin/cjs/package.json +0 -1
- package/bin/cjs/providers/AzureProvider.d.ts +0 -113
- package/bin/cjs/providers/AzureProvider.d.ts.map +0 -1
- package/bin/cjs/providers/AzureProvider.js +0 -127
- package/bin/cjs/providers/AzureProvider.js.map +0 -1
- package/bin/cjs/providers/LiveShareProvider.d.ts +0 -193
- package/bin/cjs/providers/LiveShareProvider.d.ts.map +0 -1
- package/bin/cjs/providers/LiveShareProvider.js +0 -205
- package/bin/cjs/providers/LiveShareProvider.js.map +0 -1
- package/bin/cjs/providers/index.d.ts +0 -3
- package/bin/cjs/providers/index.d.ts.map +0 -1
- package/bin/cjs/providers/index.js +0 -19
- package/bin/cjs/providers/index.js.map +0 -1
- package/bin/cjs/shared-hooks/index.d.ts +0 -7
- package/bin/cjs/shared-hooks/index.d.ts.map +0 -1
- package/bin/cjs/shared-hooks/index.js +0 -23
- package/bin/cjs/shared-hooks/index.js.map +0 -1
- package/bin/cjs/shared-hooks/internals/tree-node-constants.d.ts +0 -3
- package/bin/cjs/shared-hooks/internals/tree-node-constants.d.ts.map +0 -1
- package/bin/cjs/shared-hooks/internals/tree-node-constants.js +0 -6
- package/bin/cjs/shared-hooks/internals/tree-node-constants.js.map +0 -1
- package/bin/cjs/shared-hooks/internals/tree-node-types.d.ts +0 -10
- package/bin/cjs/shared-hooks/internals/tree-node-types.d.ts.map +0 -1
- package/bin/cjs/shared-hooks/internals/tree-node-types.js +0 -23
- package/bin/cjs/shared-hooks/internals/tree-node-types.js.map +0 -1
- package/bin/cjs/shared-hooks/internals/tree-node-utils.d.ts +0 -33
- package/bin/cjs/shared-hooks/internals/tree-node-utils.d.ts.map +0 -1
- package/bin/cjs/shared-hooks/internals/tree-node-utils.js +0 -193
- package/bin/cjs/shared-hooks/internals/tree-node-utils.js.map +0 -1
- package/bin/cjs/shared-hooks/useDynamicDDS.d.ts +0 -23
- package/bin/cjs/shared-hooks/useDynamicDDS.d.ts.map +0 -1
- package/bin/cjs/shared-hooks/useDynamicDDS.js +0 -87
- package/bin/cjs/shared-hooks/useDynamicDDS.js.map +0 -1
- package/bin/cjs/shared-hooks/useSharedMap.d.ts +0 -25
- package/bin/cjs/shared-hooks/useSharedMap.d.ts.map +0 -1
- package/bin/cjs/shared-hooks/useSharedMap.js +0 -134
- package/bin/cjs/shared-hooks/useSharedMap.js.map +0 -1
- package/bin/cjs/shared-hooks/useSharedState.d.ts +0 -22
- package/bin/cjs/shared-hooks/useSharedState.d.ts.map +0 -1
- package/bin/cjs/shared-hooks/useSharedState.js +0 -80
- package/bin/cjs/shared-hooks/useSharedState.js.map +0 -1
- package/bin/cjs/shared-hooks/useSharedStateRegistry.d.ts +0 -37
- package/bin/cjs/shared-hooks/useSharedStateRegistry.d.ts.map +0 -1
- package/bin/cjs/shared-hooks/useSharedStateRegistry.js +0 -120
- package/bin/cjs/shared-hooks/useSharedStateRegistry.js.map +0 -1
- package/bin/cjs/shared-hooks/useSharedTree.d.ts +0 -57
- package/bin/cjs/shared-hooks/useSharedTree.d.ts.map +0 -1
- package/bin/cjs/shared-hooks/useSharedTree.js +0 -123
- package/bin/cjs/shared-hooks/useSharedTree.js.map +0 -1
- package/bin/cjs/shared-hooks/useTreeNode.d.ts +0 -96
- package/bin/cjs/shared-hooks/useTreeNode.d.ts.map +0 -1
- package/bin/cjs/shared-hooks/useTreeNode.js +0 -135
- package/bin/cjs/shared-hooks/useTreeNode.js.map +0 -1
- package/bin/cjs/types/ActionTypes.d.ts +0 -112
- package/bin/cjs/types/ActionTypes.d.ts.map +0 -1
- package/bin/cjs/types/ActionTypes.js +0 -7
- package/bin/cjs/types/ActionTypes.js.map +0 -1
- package/bin/cjs/types/PropTypes.d.ts +0 -56
- package/bin/cjs/types/PropTypes.d.ts.map +0 -1
- package/bin/cjs/types/PropTypes.js +0 -7
- package/bin/cjs/types/PropTypes.js.map +0 -1
- package/bin/cjs/types/ResultTypes.d.ts +0 -334
- package/bin/cjs/types/ResultTypes.d.ts.map +0 -1
- package/bin/cjs/types/ResultTypes.js +0 -7
- package/bin/cjs/types/ResultTypes.js.map +0 -1
- package/bin/cjs/types/index.d.ts +0 -4
- package/bin/cjs/types/index.d.ts.map +0 -1
- package/bin/cjs/types/index.js +0 -20
- package/bin/cjs/types/index.js.map +0 -1
- package/bin/cjs/utils/index.d.ts +0 -2
- package/bin/cjs/utils/index.d.ts.map +0 -1
- package/bin/cjs/utils/index.js +0 -18
- package/bin/cjs/utils/index.js.map +0 -1
- package/bin/cjs/utils/type-check.d.ts +0 -15
- package/bin/cjs/utils/type-check.d.ts.map +0 -1
- package/bin/cjs/utils/type-check.js +0 -62
- package/bin/cjs/utils/type-check.js.map +0 -1
- package/bin/index.d.ts +0 -7
- package/bin/index.d.ts.map +0 -1
- package/bin/index.js +0 -7
- package/bin/index.js.map +0 -1
- package/bin/interfaces/LiveInterfaceExtensions.d.ts +0 -26
- package/bin/interfaces/LiveInterfaceExtensions.d.ts.map +0 -1
- package/bin/interfaces/LiveInterfaceExtensions.js +0 -6
- package/bin/interfaces/LiveInterfaceExtensions.js.map +0 -1
- package/bin/interfaces/index.d.ts +0 -2
- package/bin/interfaces/index.d.ts.map +0 -1
- package/bin/interfaces/index.js +0 -2
- package/bin/interfaces/index.js.map +0 -1
- package/bin/internal/errors.d.ts +0 -41
- package/bin/internal/errors.d.ts.map +0 -1
- package/bin/internal/errors.js +0 -42
- package/bin/internal/errors.js.map +0 -1
- package/bin/internal/index.d.ts +0 -3
- package/bin/internal/index.d.ts.map +0 -1
- package/bin/internal/index.js +0 -3
- package/bin/internal/index.js.map +0 -1
- package/bin/internal/type-guards.d.ts +0 -11
- package/bin/internal/type-guards.d.ts.map +0 -1
- package/bin/internal/type-guards.js +0 -20
- package/bin/internal/type-guards.js.map +0 -1
- package/bin/live-hooks/index.d.ts +0 -8
- package/bin/live-hooks/index.d.ts.map +0 -1
- package/bin/live-hooks/index.js +0 -8
- package/bin/live-hooks/index.js.map +0 -1
- package/bin/live-hooks/useLiveCanvas.d.ts +0 -29
- package/bin/live-hooks/useLiveCanvas.d.ts.map +0 -1
- package/bin/live-hooks/useLiveCanvas.js +0 -160
- package/bin/live-hooks/useLiveCanvas.js.map +0 -1
- package/bin/live-hooks/useLiveEvent.d.ts +0 -23
- package/bin/live-hooks/useLiveEvent.d.ts.map +0 -1
- package/bin/live-hooks/useLiveEvent.js +0 -108
- package/bin/live-hooks/useLiveEvent.js.map +0 -1
- package/bin/live-hooks/useLiveFollowMode.d.ts +0 -24
- package/bin/live-hooks/useLiveFollowMode.d.ts.map +0 -1
- package/bin/live-hooks/useLiveFollowMode.js +0 -211
- package/bin/live-hooks/useLiveFollowMode.js.map +0 -1
- package/bin/live-hooks/useLivePresence.d.ts +0 -26
- package/bin/live-hooks/useLivePresence.d.ts.map +0 -1
- package/bin/live-hooks/useLivePresence.js +0 -106
- package/bin/live-hooks/useLivePresence.js.map +0 -1
- package/bin/live-hooks/useLiveState.d.ts +0 -21
- package/bin/live-hooks/useLiveState.d.ts.map +0 -1
- package/bin/live-hooks/useLiveState.js +0 -83
- package/bin/live-hooks/useLiveState.js.map +0 -1
- package/bin/live-hooks/useLiveTimer.d.ts +0 -25
- package/bin/live-hooks/useLiveTimer.d.ts.map +0 -1
- package/bin/live-hooks/useLiveTimer.js +0 -172
- package/bin/live-hooks/useLiveTimer.js.map +0 -1
- package/bin/live-hooks/useMediaSynchronizer.d.ts +0 -25
- package/bin/live-hooks/useMediaSynchronizer.d.ts.map +0 -1
- package/bin/live-hooks/useMediaSynchronizer.js +0 -234
- package/bin/live-hooks/useMediaSynchronizer.js.map +0 -1
- package/bin/providers/AzureProvider.d.ts +0 -113
- package/bin/providers/AzureProvider.d.ts.map +0 -1
- package/bin/providers/AzureProvider.js +0 -119
- package/bin/providers/AzureProvider.js.map +0 -1
- package/bin/providers/LiveShareProvider.d.ts +0 -91
- package/bin/providers/LiveShareProvider.d.ts.map +0 -1
- package/bin/providers/LiveShareProvider.js +0 -95
- package/bin/providers/LiveShareProvider.js.map +0 -1
- package/bin/providers/index.d.ts +0 -3
- package/bin/providers/index.d.ts.map +0 -1
- package/bin/providers/index.js +0 -3
- package/bin/providers/index.js.map +0 -1
- package/bin/shared-hooks/index.d.ts +0 -5
- package/bin/shared-hooks/index.d.ts.map +0 -1
- package/bin/shared-hooks/index.js +0 -5
- package/bin/shared-hooks/index.js.map +0 -1
- package/bin/shared-hooks/useDynamicDDS.d.ts +0 -23
- package/bin/shared-hooks/useDynamicDDS.d.ts.map +0 -1
- package/bin/shared-hooks/useDynamicDDS.js +0 -72
- package/bin/shared-hooks/useDynamicDDS.js.map +0 -1
- package/bin/shared-hooks/useSharedMap.d.ts +0 -23
- package/bin/shared-hooks/useSharedMap.d.ts.map +0 -1
- package/bin/shared-hooks/useSharedMap.js +0 -114
- package/bin/shared-hooks/useSharedMap.js.map +0 -1
- package/bin/shared-hooks/useSharedState.d.ts +0 -22
- package/bin/shared-hooks/useSharedState.d.ts.map +0 -1
- package/bin/shared-hooks/useSharedState.js +0 -74
- package/bin/shared-hooks/useSharedState.js.map +0 -1
- package/bin/shared-hooks/useSharedStateRegistry.d.ts +0 -37
- package/bin/shared-hooks/useSharedStateRegistry.d.ts.map +0 -1
- package/bin/shared-hooks/useSharedStateRegistry.js +0 -105
- package/bin/shared-hooks/useSharedStateRegistry.js.map +0 -1
- package/bin/types/ActionTypes.d.ts +0 -112
- package/bin/types/ActionTypes.d.ts.map +0 -1
- package/bin/types/ActionTypes.js +0 -6
- package/bin/types/ActionTypes.js.map +0 -1
- package/bin/types/PropTypes.d.ts +0 -8
- package/bin/types/PropTypes.d.ts.map +0 -1
- package/bin/types/PropTypes.js +0 -6
- package/bin/types/PropTypes.js.map +0 -1
- package/bin/types/ResultTypes.d.ts +0 -302
- package/bin/types/ResultTypes.d.ts.map +0 -1
- package/bin/types/ResultTypes.js +0 -6
- package/bin/types/ResultTypes.js.map +0 -1
- package/bin/types/index.d.ts +0 -4
- package/bin/types/index.d.ts.map +0 -1
- package/bin/types/index.js +0 -4
- package/bin/types/index.js.map +0 -1
- package/bin/utils/index.d.ts +0 -2
- package/bin/utils/index.d.ts.map +0 -1
- package/bin/utils/index.js +0 -2
- package/bin/utils/index.js.map +0 -1
- package/bin/utils/type-check.d.ts +0 -15
- package/bin/utils/type-check.d.ts.map +0 -1
- package/bin/utils/type-check.js +0 -54
- package/bin/utils/type-check.js.map +0 -1
- package/tsconfig.cjs.json +0 -14
|
@@ -1,25 +0,0 @@
|
|
|
1
|
-
/*!
|
|
2
|
-
* Copyright (c) Microsoft Corporation. All rights reserved.
|
|
3
|
-
* Licensed under the Microsoft Live Share SDK License.
|
|
4
|
-
*/
|
|
5
|
-
import { UserMeetingRole } from "@microsoft/live-share";
|
|
6
|
-
import { IUseLiveTimerResults, OnTimerDidFinishAction, OnTimerDidPauseAction, OnTimerDidPlayAction, OnTimerDidStartAction, OnTimerTickAction } from "../types";
|
|
7
|
-
/**
|
|
8
|
-
* React hook for using Live Share's `LiveTimer` DDS.
|
|
9
|
-
*
|
|
10
|
-
* @remarks
|
|
11
|
-
* Use this hook to create a synchronized countdown timer in your app or to schedule synchronized tasks.
|
|
12
|
-
* This hook can only be used in a child component of `<LiveShareProvider>` or `<AzureProvider>`.
|
|
13
|
-
*
|
|
14
|
-
* @param uniqueKey the unique key for the `LiveTimer`. If one does not yet exist, a new one will be created, otherwise it will use the existing one.
|
|
15
|
-
* @param allowedRoles Optional. the user roles that are allowed to start/stop/pause the timer.
|
|
16
|
-
* @param tickRate Optional. the interval in which the `milliRemaining` state should be updated and the `onTick` callback will trigger.
|
|
17
|
-
* @param onTick Optional. event handler callback for when an active timer ticks.
|
|
18
|
-
* @param onStart Optional. event handler callback for when the timer is started.
|
|
19
|
-
* @param onPause Optional. event handler callback for when the timer is paused.
|
|
20
|
-
* @param onPlay Optional. event handler callback for when the timer is resumed.
|
|
21
|
-
* @param onFinish Optional. event handler callback for when the timer finishes.
|
|
22
|
-
* @returns results and callbacks exposed via the hook.
|
|
23
|
-
*/
|
|
24
|
-
export declare function useLiveTimer(uniqueKey: string, allowedRoles?: UserMeetingRole[], tickRate?: number, onTick?: OnTimerTickAction, onStart?: OnTimerDidStartAction, onPause?: OnTimerDidPauseAction, onPlay?: OnTimerDidPlayAction, onFinish?: OnTimerDidFinishAction): IUseLiveTimerResults;
|
|
25
|
-
//# sourceMappingURL=useLiveTimer.d.ts.map
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"useLiveTimer.d.ts","sourceRoot":"","sources":["../../src/live-hooks/useLiveTimer.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAGH,eAAe,EAGlB,MAAM,uBAAuB,CAAC;AAE/B,OAAO,EACH,oBAAoB,EAIpB,sBAAsB,EACtB,qBAAqB,EACrB,oBAAoB,EACpB,qBAAqB,EACrB,iBAAiB,EACpB,MAAM,UAAU,CAAC;AASlB;;;;;;;;;;;;;;;;GAgBG;AACH,wBAAgB,YAAY,CACxB,SAAS,EAAE,MAAM,EACjB,YAAY,CAAC,EAAE,eAAe,EAAE,EAChC,QAAQ,CAAC,EAAE,MAAM,EACjB,MAAM,CAAC,EAAE,iBAAiB,EAC1B,OAAO,CAAC,EAAE,qBAAqB,EAC/B,OAAO,CAAC,EAAE,qBAAqB,EAC/B,MAAM,CAAC,EAAE,oBAAoB,EAC7B,QAAQ,CAAC,EAAE,sBAAsB,GAClC,oBAAoB,CA8JtB"}
|
|
@@ -1,172 +0,0 @@
|
|
|
1
|
-
/*!
|
|
2
|
-
* Copyright (c) Microsoft Corporation. All rights reserved.
|
|
3
|
-
* Licensed under the Microsoft Live Share SDK License.
|
|
4
|
-
*/
|
|
5
|
-
var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
|
|
6
|
-
function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
|
|
7
|
-
return new (P || (P = Promise))(function (resolve, reject) {
|
|
8
|
-
function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
|
|
9
|
-
function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
|
|
10
|
-
function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
|
|
11
|
-
step((generator = generator.apply(thisArg, _arguments || [])).next());
|
|
12
|
-
});
|
|
13
|
-
};
|
|
14
|
-
import { LiveTimerEvents, LiveTimer, LiveDataObjectInitializeState, } from "@microsoft/live-share";
|
|
15
|
-
import React from "react";
|
|
16
|
-
import { useDynamicDDS } from "../shared-hooks";
|
|
17
|
-
import { useFluidObjectsContext } from "../providers";
|
|
18
|
-
import { ActionContainerNotJoinedError, ActionLiveDataObjectInitializedError, ActionLiveDataObjectUndefinedError, } from "../internal";
|
|
19
|
-
/**
|
|
20
|
-
* React hook for using Live Share's `LiveTimer` DDS.
|
|
21
|
-
*
|
|
22
|
-
* @remarks
|
|
23
|
-
* Use this hook to create a synchronized countdown timer in your app or to schedule synchronized tasks.
|
|
24
|
-
* This hook can only be used in a child component of `<LiveShareProvider>` or `<AzureProvider>`.
|
|
25
|
-
*
|
|
26
|
-
* @param uniqueKey the unique key for the `LiveTimer`. If one does not yet exist, a new one will be created, otherwise it will use the existing one.
|
|
27
|
-
* @param allowedRoles Optional. the user roles that are allowed to start/stop/pause the timer.
|
|
28
|
-
* @param tickRate Optional. the interval in which the `milliRemaining` state should be updated and the `onTick` callback will trigger.
|
|
29
|
-
* @param onTick Optional. event handler callback for when an active timer ticks.
|
|
30
|
-
* @param onStart Optional. event handler callback for when the timer is started.
|
|
31
|
-
* @param onPause Optional. event handler callback for when the timer is paused.
|
|
32
|
-
* @param onPlay Optional. event handler callback for when the timer is resumed.
|
|
33
|
-
* @param onFinish Optional. event handler callback for when the timer finishes.
|
|
34
|
-
* @returns results and callbacks exposed via the hook.
|
|
35
|
-
*/
|
|
36
|
-
export function useLiveTimer(uniqueKey, allowedRoles, tickRate, onTick, onStart, onPause, onPlay, onFinish) {
|
|
37
|
-
/**
|
|
38
|
-
* User facing: Stateful timer config.
|
|
39
|
-
*/
|
|
40
|
-
const [timerConfig, setTimerConfig] = React.useState();
|
|
41
|
-
/**
|
|
42
|
-
* User facing: Stateful time remaining.
|
|
43
|
-
*/
|
|
44
|
-
const [milliRemaining, setMilliRemaining] = React.useState();
|
|
45
|
-
/**
|
|
46
|
-
* User facing: dynamically load the DDS for the given unique key.
|
|
47
|
-
*/
|
|
48
|
-
const { dds: liveTimer } = useDynamicDDS(uniqueKey, LiveTimer);
|
|
49
|
-
const { container } = useFluidObjectsContext();
|
|
50
|
-
/**
|
|
51
|
-
* Callback to send event through `LiveTimer`
|
|
52
|
-
* @param duration the duration for the timer in milliseconds
|
|
53
|
-
* @returns void promise that will throw when user does not have required roles
|
|
54
|
-
*/
|
|
55
|
-
const start = React.useCallback((duration) => __awaiter(this, void 0, void 0, function* () {
|
|
56
|
-
if (!container) {
|
|
57
|
-
throw new ActionContainerNotJoinedError("liveTimer", "start");
|
|
58
|
-
}
|
|
59
|
-
if (liveTimer === undefined) {
|
|
60
|
-
throw new ActionLiveDataObjectUndefinedError("liveTimer", "start");
|
|
61
|
-
}
|
|
62
|
-
if (!liveTimer.isInitialized) {
|
|
63
|
-
throw new ActionLiveDataObjectInitializedError("liveTimer", "start");
|
|
64
|
-
}
|
|
65
|
-
return yield liveTimer.start(duration);
|
|
66
|
-
}), [container, liveTimer]);
|
|
67
|
-
/**
|
|
68
|
-
* Callback to send event through `LiveTimer`
|
|
69
|
-
* @returns void promise that will throw when user does not have required roles
|
|
70
|
-
*/
|
|
71
|
-
const play = React.useCallback(() => __awaiter(this, void 0, void 0, function* () {
|
|
72
|
-
if (!container) {
|
|
73
|
-
throw new ActionContainerNotJoinedError("liveTimer", "play");
|
|
74
|
-
}
|
|
75
|
-
if (liveTimer === undefined) {
|
|
76
|
-
throw new ActionLiveDataObjectUndefinedError("liveTimer", "play");
|
|
77
|
-
}
|
|
78
|
-
if (!liveTimer.isInitialized) {
|
|
79
|
-
throw new ActionLiveDataObjectInitializedError("liveTimer", "play");
|
|
80
|
-
}
|
|
81
|
-
return yield liveTimer.play();
|
|
82
|
-
}), [container, liveTimer]);
|
|
83
|
-
/**
|
|
84
|
-
* Callback to send event through `LiveTimer`
|
|
85
|
-
* @returns void promise that will throw when user does not have required roles
|
|
86
|
-
*/
|
|
87
|
-
const pause = React.useCallback(() => __awaiter(this, void 0, void 0, function* () {
|
|
88
|
-
if (!container) {
|
|
89
|
-
throw new ActionContainerNotJoinedError("liveTimer", "pause");
|
|
90
|
-
}
|
|
91
|
-
if (liveTimer === undefined) {
|
|
92
|
-
throw new ActionLiveDataObjectUndefinedError("liveTimer", "pause");
|
|
93
|
-
}
|
|
94
|
-
if (!liveTimer.isInitialized) {
|
|
95
|
-
throw new ActionLiveDataObjectInitializedError("liveTimer", "pause");
|
|
96
|
-
}
|
|
97
|
-
return yield liveTimer.pause();
|
|
98
|
-
}), [container, liveTimer]);
|
|
99
|
-
/**
|
|
100
|
-
* Setup change listeners and start `LiveTimer` if needed
|
|
101
|
-
*/
|
|
102
|
-
React.useEffect(() => {
|
|
103
|
-
if (liveTimer === undefined)
|
|
104
|
-
return;
|
|
105
|
-
// Reset default values, which is needed for when the `id` changes and a new DDS is loaded.
|
|
106
|
-
// React does not re-render if the values are already set to defaults (e.g., initial DDS).
|
|
107
|
-
setTimerConfig(undefined);
|
|
108
|
-
setMilliRemaining(undefined);
|
|
109
|
-
// Register event listeners
|
|
110
|
-
const onTimerConfigChange = (config) => {
|
|
111
|
-
setTimerConfig(config);
|
|
112
|
-
};
|
|
113
|
-
const onDidStart = (config) => {
|
|
114
|
-
onTimerConfigChange(config);
|
|
115
|
-
onStart === null || onStart === void 0 ? void 0 : onStart(config);
|
|
116
|
-
setMilliRemaining(config.duration);
|
|
117
|
-
};
|
|
118
|
-
const onDidFinish = (config) => {
|
|
119
|
-
onTimerConfigChange(config);
|
|
120
|
-
onFinish === null || onFinish === void 0 ? void 0 : onFinish(config);
|
|
121
|
-
setMilliRemaining(0);
|
|
122
|
-
};
|
|
123
|
-
const onDidPlay = (config) => {
|
|
124
|
-
onTimerConfigChange(config);
|
|
125
|
-
onPlay === null || onPlay === void 0 ? void 0 : onPlay(config);
|
|
126
|
-
};
|
|
127
|
-
const onDidPause = (config) => {
|
|
128
|
-
onTimerConfigChange(config);
|
|
129
|
-
onPause === null || onPause === void 0 ? void 0 : onPause(config);
|
|
130
|
-
};
|
|
131
|
-
const onDidTick = (milliseconds) => {
|
|
132
|
-
setMilliRemaining(milliseconds);
|
|
133
|
-
onTick === null || onTick === void 0 ? void 0 : onTick(milliseconds);
|
|
134
|
-
};
|
|
135
|
-
liveTimer.on(LiveTimerEvents.started, onDidStart);
|
|
136
|
-
liveTimer.on(LiveTimerEvents.finished, onDidFinish);
|
|
137
|
-
liveTimer.on(LiveTimerEvents.played, onDidPlay);
|
|
138
|
-
liveTimer.on(LiveTimerEvents.paused, onDidPause);
|
|
139
|
-
liveTimer.on(LiveTimerEvents.onTick, onDidTick);
|
|
140
|
-
if (liveTimer.initializeState === LiveDataObjectInitializeState.needed) {
|
|
141
|
-
// Start live event
|
|
142
|
-
liveTimer.initialize(allowedRoles);
|
|
143
|
-
}
|
|
144
|
-
return () => {
|
|
145
|
-
// on unmount, remove event listeners
|
|
146
|
-
liveTimer === null || liveTimer === void 0 ? void 0 : liveTimer.off(LiveTimerEvents.started, onDidStart);
|
|
147
|
-
liveTimer === null || liveTimer === void 0 ? void 0 : liveTimer.off(LiveTimerEvents.finished, onDidFinish);
|
|
148
|
-
liveTimer === null || liveTimer === void 0 ? void 0 : liveTimer.off(LiveTimerEvents.played, onDidPlay);
|
|
149
|
-
liveTimer === null || liveTimer === void 0 ? void 0 : liveTimer.off(LiveTimerEvents.paused, onDidPause);
|
|
150
|
-
liveTimer === null || liveTimer === void 0 ? void 0 : liveTimer.off(LiveTimerEvents.onTick, onDidTick);
|
|
151
|
-
};
|
|
152
|
-
}, [liveTimer, onTick, onStart, onFinish, onPlay, onPause]);
|
|
153
|
-
/**
|
|
154
|
-
* Change tick rate if changes in props
|
|
155
|
-
*/
|
|
156
|
-
React.useEffect(() => {
|
|
157
|
-
if (tickRate !== undefined &&
|
|
158
|
-
(liveTimer === null || liveTimer === void 0 ? void 0 : liveTimer.tickRate) !== undefined &&
|
|
159
|
-
tickRate !== (liveTimer === null || liveTimer === void 0 ? void 0 : liveTimer.tickRate)) {
|
|
160
|
-
liveTimer.tickRate = tickRate;
|
|
161
|
-
}
|
|
162
|
-
}, [tickRate, liveTimer === null || liveTimer === void 0 ? void 0 : liveTimer.tickRate]);
|
|
163
|
-
return {
|
|
164
|
-
liveTimer,
|
|
165
|
-
milliRemaining,
|
|
166
|
-
pause,
|
|
167
|
-
play,
|
|
168
|
-
start,
|
|
169
|
-
timerConfig,
|
|
170
|
-
};
|
|
171
|
-
}
|
|
172
|
-
//# sourceMappingURL=useLiveTimer.js.map
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"useLiveTimer.js","sourceRoot":"","sources":["../../src/live-hooks/useLiveTimer.ts"],"names":[],"mappings":"AAAA;;;GAGG;;;;;;;;;;AAEH,OAAO,EAEH,eAAe,EAEf,SAAS,EACT,6BAA6B,GAChC,MAAM,uBAAuB,CAAC;AAC/B,OAAO,KAAK,MAAM,OAAO,CAAC;AAY1B,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAChD,OAAO,EAAE,sBAAsB,EAAE,MAAM,cAAc,CAAC;AACtD,OAAO,EACH,6BAA6B,EAC7B,oCAAoC,EACpC,kCAAkC,GACrC,MAAM,aAAa,CAAC;AAErB;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,UAAU,YAAY,CACxB,SAAiB,EACjB,YAAgC,EAChC,QAAiB,EACjB,MAA0B,EAC1B,OAA+B,EAC/B,OAA+B,EAC/B,MAA6B,EAC7B,QAAiC;IAEjC;;OAEG;IACH,MAAM,CAAC,WAAW,EAAE,cAAc,CAAC,GAAG,KAAK,CAAC,QAAQ,EAAgB,CAAC;IACrE;;OAEG;IACH,MAAM,CAAC,cAAc,EAAE,iBAAiB,CAAC,GAAG,KAAK,CAAC,QAAQ,EAAU,CAAC;IACrE;;OAEG;IACH,MAAM,EAAE,GAAG,EAAE,SAAS,EAAE,GAAG,aAAa,CAAY,SAAS,EAAE,SAAS,CAAC,CAAC;IAE1E,MAAM,EAAE,SAAS,EAAE,GAAG,sBAAsB,EAAE,CAAC;IAE/C;;;;OAIG;IACH,MAAM,KAAK,GAAuB,KAAK,CAAC,WAAW,CAC/C,CAAO,QAAgB,EAAE,EAAE;QACvB,IAAI,CAAC,SAAS,EAAE;YACZ,MAAM,IAAI,6BAA6B,CAAC,WAAW,EAAE,OAAO,CAAC,CAAC;SACjE;QACD,IAAI,SAAS,KAAK,SAAS,EAAE;YACzB,MAAM,IAAI,kCAAkC,CACxC,WAAW,EACX,OAAO,CACV,CAAC;SACL;QACD,IAAI,CAAC,SAAS,CAAC,aAAa,EAAE;YAC1B,MAAM,IAAI,oCAAoC,CAC1C,WAAW,EACX,OAAO,CACV,CAAC;SACL;QACD,OAAO,MAAM,SAAS,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;IAC3C,CAAC,CAAA,EACD,CAAC,SAAS,EAAE,SAAS,CAAC,CACzB,CAAC;IAEF;;;OAGG;IACH,MAAM,IAAI,GAAsB,KAAK,CAAC,WAAW,CAAC,GAAS,EAAE;QACzD,IAAI,CAAC,SAAS,EAAE;YACZ,MAAM,IAAI,6BAA6B,CAAC,WAAW,EAAE,MAAM,CAAC,CAAC;SAChE;QACD,IAAI,SAAS,KAAK,SAAS,EAAE;YACzB,MAAM,IAAI,kCAAkC,CAAC,WAAW,EAAE,MAAM,CAAC,CAAC;SACrE;QACD,IAAI,CAAC,SAAS,CAAC,aAAa,EAAE;YAC1B,MAAM,IAAI,oCAAoC,CAAC,WAAW,EAAE,MAAM,CAAC,CAAC;SACvE;QACD,OAAO,MAAM,SAAS,CAAC,IAAI,EAAE,CAAC;IAClC,CAAC,CAAA,EAAE,CAAC,SAAS,EAAE,SAAS,CAAC,CAAC,CAAC;IAE3B;;;OAGG;IACH,MAAM,KAAK,GAAuB,KAAK,CAAC,WAAW,CAAC,GAAS,EAAE;QAC3D,IAAI,CAAC,SAAS,EAAE;YACZ,MAAM,IAAI,6BAA6B,CAAC,WAAW,EAAE,OAAO,CAAC,CAAC;SACjE;QACD,IAAI,SAAS,KAAK,SAAS,EAAE;YACzB,MAAM,IAAI,kCAAkC,CAAC,WAAW,EAAE,OAAO,CAAC,CAAC;SACtE;QACD,IAAI,CAAC,SAAS,CAAC,aAAa,EAAE;YAC1B,MAAM,IAAI,oCAAoC,CAC1C,WAAW,EACX,OAAO,CACV,CAAC;SACL;QACD,OAAO,MAAM,SAAS,CAAC,KAAK,EAAE,CAAC;IACnC,CAAC,CAAA,EAAE,CAAC,SAAS,EAAE,SAAS,CAAC,CAAC,CAAC;IAE3B;;OAEG;IACH,KAAK,CAAC,SAAS,CAAC,GAAG,EAAE;QACjB,IAAI,SAAS,KAAK,SAAS;YAAE,OAAO;QACpC,2FAA2F;QAC3F,0FAA0F;QAC1F,cAAc,CAAC,SAAS,CAAC,CAAC;QAC1B,iBAAiB,CAAC,SAAS,CAAC,CAAC;QAC7B,2BAA2B;QAC3B,MAAM,mBAAmB,GAAG,CAAC,MAAoB,EAAE,EAAE;YACjD,cAAc,CAAC,MAAM,CAAC,CAAC;QAC3B,CAAC,CAAC;QACF,MAAM,UAAU,GAAG,CAAC,MAAoB,EAAE,EAAE;YACxC,mBAAmB,CAAC,MAAM,CAAC,CAAC;YAC5B,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAG,MAAM,CAAC,CAAC;YAClB,iBAAiB,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;QACvC,CAAC,CAAC;QACF,MAAM,WAAW,GAAG,CAAC,MAAoB,EAAE,EAAE;YACzC,mBAAmB,CAAC,MAAM,CAAC,CAAC;YAC5B,QAAQ,aAAR,QAAQ,uBAAR,QAAQ,CAAG,MAAM,CAAC,CAAC;YACnB,iBAAiB,CAAC,CAAC,CAAC,CAAC;QACzB,CAAC,CAAC;QACF,MAAM,SAAS,GAAG,CAAC,MAAoB,EAAE,EAAE;YACvC,mBAAmB,CAAC,MAAM,CAAC,CAAC;YAC5B,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAG,MAAM,CAAC,CAAC;QACrB,CAAC,CAAC;QACF,MAAM,UAAU,GAAG,CAAC,MAAoB,EAAE,EAAE;YACxC,mBAAmB,CAAC,MAAM,CAAC,CAAC;YAC5B,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAG,MAAM,CAAC,CAAC;QACtB,CAAC,CAAC;QACF,MAAM,SAAS,GAAG,CAAC,YAAoB,EAAE,EAAE;YACvC,iBAAiB,CAAC,YAAY,CAAC,CAAC;YAChC,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAG,YAAY,CAAC,CAAC;QAC3B,CAAC,CAAC;QACF,SAAS,CAAC,EAAE,CAAC,eAAe,CAAC,OAAO,EAAE,UAAU,CAAC,CAAC;QAClD,SAAS,CAAC,EAAE,CAAC,eAAe,CAAC,QAAQ,EAAE,WAAW,CAAC,CAAC;QACpD,SAAS,CAAC,EAAE,CAAC,eAAe,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC;QAChD,SAAS,CAAC,EAAE,CAAC,eAAe,CAAC,MAAM,EAAE,UAAU,CAAC,CAAC;QACjD,SAAS,CAAC,EAAE,CAAC,eAAe,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC;QAChD,IACI,SAAS,CAAC,eAAe,KAAK,6BAA6B,CAAC,MAAM,EACpE;YACE,mBAAmB;YACnB,SAAS,CAAC,UAAU,CAAC,YAAY,CAAC,CAAC;SACtC;QAED,OAAO,GAAG,EAAE;YACR,qCAAqC;YACrC,SAAS,aAAT,SAAS,uBAAT,SAAS,CAAE,GAAG,CAAC,eAAe,CAAC,OAAO,EAAE,UAAU,CAAC,CAAC;YACpD,SAAS,aAAT,SAAS,uBAAT,SAAS,CAAE,GAAG,CAAC,eAAe,CAAC,QAAQ,EAAE,WAAW,CAAC,CAAC;YACtD,SAAS,aAAT,SAAS,uBAAT,SAAS,CAAE,GAAG,CAAC,eAAe,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC;YAClD,SAAS,aAAT,SAAS,uBAAT,SAAS,CAAE,GAAG,CAAC,eAAe,CAAC,MAAM,EAAE,UAAU,CAAC,CAAC;YACnD,SAAS,aAAT,SAAS,uBAAT,SAAS,CAAE,GAAG,CAAC,eAAe,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC;QACtD,CAAC,CAAC;IACN,CAAC,EAAE,CAAC,SAAS,EAAE,MAAM,EAAE,OAAO,EAAE,QAAQ,EAAE,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC;IAE5D;;OAEG;IACH,KAAK,CAAC,SAAS,CAAC,GAAG,EAAE;QACjB,IACI,QAAQ,KAAK,SAAS;YACtB,CAAA,SAAS,aAAT,SAAS,uBAAT,SAAS,CAAE,QAAQ,MAAK,SAAS;YACjC,QAAQ,MAAK,SAAS,aAAT,SAAS,uBAAT,SAAS,CAAE,QAAQ,CAAA,EAClC;YACE,SAAS,CAAC,QAAQ,GAAG,QAAQ,CAAC;SACjC;IACL,CAAC,EAAE,CAAC,QAAQ,EAAE,SAAS,aAAT,SAAS,uBAAT,SAAS,CAAE,QAAQ,CAAC,CAAC,CAAC;IAEpC,OAAO;QACH,SAAS;QACT,cAAc;QACd,KAAK;QACL,IAAI;QACJ,KAAK;QACL,WAAW;KACd,CAAC;AACN,CAAC"}
|
|
@@ -1,25 +0,0 @@
|
|
|
1
|
-
/*!
|
|
2
|
-
* Copyright (c) Microsoft Corporation. All rights reserved.
|
|
3
|
-
* Licensed under the Microsoft Live Share SDK License.
|
|
4
|
-
*/
|
|
5
|
-
import { UserMeetingRole } from "@microsoft/live-share";
|
|
6
|
-
import React from "react";
|
|
7
|
-
import { ExtendedMediaMetadata, IMediaPlayer } from "@microsoft/live-share-media";
|
|
8
|
-
import { IUseMediaSynchronizerResults } from "../types";
|
|
9
|
-
/**
|
|
10
|
-
* React hook for using a Live Share media `MediaPlayerSynchronizer`.
|
|
11
|
-
*
|
|
12
|
-
* @remarks
|
|
13
|
-
* Use this hook if you want to synchronize the playback position of a video or audio element during a Live Share session.
|
|
14
|
-
* This hook can only be used in a child component of `<LiveShareProvider>` or `<AzureProvider>`.
|
|
15
|
-
*
|
|
16
|
-
* @param uniqueKey uniqueKey value for the `LiveMediaSession` DDS object used by `MediaPlayerSynchronizer`.
|
|
17
|
-
* @param mediaPlayerElement React RefObject containing object/element conforming to IMediaPlayer interface, `IMediaPlayer` object, or string id for <video> / <audio> element.
|
|
18
|
-
* @param initialTrack initial track to load. Either ExtendedMediaMetadata, trackId string, or null.
|
|
19
|
-
* @param allowedRoles Optional. Array of user roles that are eligible to modify group playback state.
|
|
20
|
-
* @param viewOnly Optional. Flag for whether or not the media synchronizer should be in viewOnly mode.
|
|
21
|
-
* @param canSendPositionUpdates Optional. Controls whether or not the local client is allowed to send position updates to the group.
|
|
22
|
-
* @returns IUseMediaSynchronizerResults object.
|
|
23
|
-
*/
|
|
24
|
-
export declare function useMediaSynchronizer(uniqueKey: string, mediaPlayerElement: React.RefObject<IMediaPlayer> | IMediaPlayer | string | null, initialTrack: Partial<ExtendedMediaMetadata> | string | null, allowedRoles?: UserMeetingRole[], viewOnly?: boolean, canSendPositionUpdates?: boolean): IUseMediaSynchronizerResults;
|
|
25
|
-
//# sourceMappingURL=useMediaSynchronizer.d.ts.map
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"useMediaSynchronizer.d.ts","sourceRoot":"","sources":["../../src/live-hooks/useMediaSynchronizer.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAEH,eAAe,EAClB,MAAM,uBAAuB,CAAC;AAC/B,OAAO,KAAK,MAAM,OAAO,CAAC;AAC1B,OAAO,EAEH,qBAAqB,EACrB,YAAY,EAIf,MAAM,6BAA6B,CAAC;AAGrC,OAAO,EAAE,4BAA4B,EAAE,MAAM,UAAU,CAAC;AAOxD;;;;;;;;;;;;;;GAcG;AACH,wBAAgB,oBAAoB,CAChC,SAAS,EAAE,MAAM,EACjB,kBAAkB,EACZ,KAAK,CAAC,SAAS,CAAC,YAAY,CAAC,GAC7B,YAAY,GACZ,MAAM,GACN,IAAI,EACV,YAAY,EAAE,OAAO,CAAC,qBAAqB,CAAC,GAAG,MAAM,GAAG,IAAI,EAC5D,YAAY,CAAC,EAAE,eAAe,EAAE,EAChC,QAAQ,CAAC,EAAE,OAAO,EAClB,sBAAsB,CAAC,EAAE,OAAO,GACjC,4BAA4B,CAiP9B"}
|
|
@@ -1,234 +0,0 @@
|
|
|
1
|
-
/*!
|
|
2
|
-
* Copyright (c) Microsoft Corporation. All rights reserved.
|
|
3
|
-
* Licensed under the Microsoft Live Share SDK License.
|
|
4
|
-
*/
|
|
5
|
-
var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
|
|
6
|
-
function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
|
|
7
|
-
return new (P || (P = Promise))(function (resolve, reject) {
|
|
8
|
-
function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
|
|
9
|
-
function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
|
|
10
|
-
function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
|
|
11
|
-
step((generator = generator.apply(thisArg, _arguments || [])).next());
|
|
12
|
-
});
|
|
13
|
-
};
|
|
14
|
-
import { LiveDataObjectInitializeState, } from "@microsoft/live-share";
|
|
15
|
-
import React from "react";
|
|
16
|
-
import { LiveMediaSession, } from "@microsoft/live-share-media";
|
|
17
|
-
import { isExtendedMediaMetadata, isMediaElement, isRefObject } from "../utils";
|
|
18
|
-
import { useDynamicDDS } from "../shared-hooks";
|
|
19
|
-
import { useFluidObjectsContext } from "../providers";
|
|
20
|
-
import { ActionContainerNotJoinedError, ActionLiveDataObjectUndefinedError, } from "../internal";
|
|
21
|
-
/**
|
|
22
|
-
* React hook for using a Live Share media `MediaPlayerSynchronizer`.
|
|
23
|
-
*
|
|
24
|
-
* @remarks
|
|
25
|
-
* Use this hook if you want to synchronize the playback position of a video or audio element during a Live Share session.
|
|
26
|
-
* This hook can only be used in a child component of `<LiveShareProvider>` or `<AzureProvider>`.
|
|
27
|
-
*
|
|
28
|
-
* @param uniqueKey uniqueKey value for the `LiveMediaSession` DDS object used by `MediaPlayerSynchronizer`.
|
|
29
|
-
* @param mediaPlayerElement React RefObject containing object/element conforming to IMediaPlayer interface, `IMediaPlayer` object, or string id for <video> / <audio> element.
|
|
30
|
-
* @param initialTrack initial track to load. Either ExtendedMediaMetadata, trackId string, or null.
|
|
31
|
-
* @param allowedRoles Optional. Array of user roles that are eligible to modify group playback state.
|
|
32
|
-
* @param viewOnly Optional. Flag for whether or not the media synchronizer should be in viewOnly mode.
|
|
33
|
-
* @param canSendPositionUpdates Optional. Controls whether or not the local client is allowed to send position updates to the group.
|
|
34
|
-
* @returns IUseMediaSynchronizerResults object.
|
|
35
|
-
*/
|
|
36
|
-
export function useMediaSynchronizer(uniqueKey, mediaPlayerElement, initialTrack, allowedRoles, viewOnly, canSendPositionUpdates) {
|
|
37
|
-
/**
|
|
38
|
-
* User facing media synchronizer and non-user facing setter
|
|
39
|
-
*/
|
|
40
|
-
const [mediaSynchronizer, setMediaSynchronizer] = React.useState();
|
|
41
|
-
/**
|
|
42
|
-
* Suspension object and setter
|
|
43
|
-
*/
|
|
44
|
-
const [suspension, setSuspension] = React.useState();
|
|
45
|
-
/**
|
|
46
|
-
* User facing: dynamically load the LiveMediaSession DDS for the given unique key.
|
|
47
|
-
*/
|
|
48
|
-
const { dds: mediaSession } = useDynamicDDS(uniqueKey, LiveMediaSession);
|
|
49
|
-
const { container } = useFluidObjectsContext();
|
|
50
|
-
/**
|
|
51
|
-
* Play callback
|
|
52
|
-
*/
|
|
53
|
-
const play = React.useCallback(() => __awaiter(this, void 0, void 0, function* () {
|
|
54
|
-
if (!container) {
|
|
55
|
-
throw new ActionContainerNotJoinedError("mediaSynchronizer", "play");
|
|
56
|
-
}
|
|
57
|
-
if (mediaSynchronizer === undefined) {
|
|
58
|
-
throw new ActionLiveDataObjectUndefinedError("mediaSynchronizer", "play");
|
|
59
|
-
}
|
|
60
|
-
return yield mediaSynchronizer.play();
|
|
61
|
-
}), [container, mediaSynchronizer]);
|
|
62
|
-
/**
|
|
63
|
-
* Pause callback
|
|
64
|
-
*/
|
|
65
|
-
const pause = React.useCallback(() => __awaiter(this, void 0, void 0, function* () {
|
|
66
|
-
if (!container) {
|
|
67
|
-
throw new ActionContainerNotJoinedError("mediaSynchronizer", "pause");
|
|
68
|
-
}
|
|
69
|
-
if (mediaSynchronizer === undefined) {
|
|
70
|
-
throw new ActionLiveDataObjectUndefinedError("mediaSynchronizer", "pause");
|
|
71
|
-
}
|
|
72
|
-
return yield mediaSynchronizer.pause();
|
|
73
|
-
}), [container, mediaSynchronizer]);
|
|
74
|
-
/**
|
|
75
|
-
* User facing: seek callback
|
|
76
|
-
*/
|
|
77
|
-
const seekTo = React.useCallback((time) => __awaiter(this, void 0, void 0, function* () {
|
|
78
|
-
if (!container) {
|
|
79
|
-
throw new ActionContainerNotJoinedError("mediaSynchronizer", "seekTo");
|
|
80
|
-
}
|
|
81
|
-
if (mediaSynchronizer === undefined) {
|
|
82
|
-
throw new ActionLiveDataObjectUndefinedError("mediaSynchronizer", "seekTo");
|
|
83
|
-
}
|
|
84
|
-
return yield mediaSynchronizer.seekTo(time);
|
|
85
|
-
}), [container, mediaSynchronizer]);
|
|
86
|
-
/**
|
|
87
|
-
* User facing: set track callback
|
|
88
|
-
*/
|
|
89
|
-
const setTrack = React.useCallback((track) => __awaiter(this, void 0, void 0, function* () {
|
|
90
|
-
if (!container) {
|
|
91
|
-
throw new ActionContainerNotJoinedError("mediaSynchronizer", "setTrack");
|
|
92
|
-
}
|
|
93
|
-
if (mediaSynchronizer === undefined) {
|
|
94
|
-
throw new ActionLiveDataObjectUndefinedError("mediaSynchronizer", "setTrack");
|
|
95
|
-
}
|
|
96
|
-
if (isExtendedMediaMetadata(track)) {
|
|
97
|
-
return yield mediaSynchronizer.setTrack(track);
|
|
98
|
-
}
|
|
99
|
-
else if (typeof track === "string") {
|
|
100
|
-
return yield mediaSynchronizer.setTrack({
|
|
101
|
-
trackIdentifier: track,
|
|
102
|
-
});
|
|
103
|
-
}
|
|
104
|
-
}), [container, mediaSynchronizer]);
|
|
105
|
-
/**
|
|
106
|
-
* User facing: create a new suspension and set it locally to state
|
|
107
|
-
*/
|
|
108
|
-
const beginSuspension = React.useCallback((waitPoint) => {
|
|
109
|
-
const suspension = mediaSession === null || mediaSession === void 0 ? void 0 : mediaSession.coordinator.beginSuspension(waitPoint);
|
|
110
|
-
setSuspension(suspension);
|
|
111
|
-
}, [mediaSession]);
|
|
112
|
-
/**
|
|
113
|
-
* User facing: if a suspension is active, end it. Called when "Follow presenter" button is clicked.
|
|
114
|
-
*/
|
|
115
|
-
const endSuspension = React.useCallback(() => {
|
|
116
|
-
suspension === null || suspension === void 0 ? void 0 : suspension.end();
|
|
117
|
-
setSuspension(undefined);
|
|
118
|
-
}, [suspension]);
|
|
119
|
-
/**
|
|
120
|
-
* Setup change listeners and start `LiveMediaSession` if needed
|
|
121
|
-
*/
|
|
122
|
-
React.useEffect(() => {
|
|
123
|
-
if (mediaSession === undefined || !mediaPlayerElement)
|
|
124
|
-
return;
|
|
125
|
-
let mounted = true;
|
|
126
|
-
// Query the HTML5 media element from the document and set reference
|
|
127
|
-
let mediaPlayer;
|
|
128
|
-
if (isRefObject(mediaPlayerElement)) {
|
|
129
|
-
if (!mediaPlayerElement.current)
|
|
130
|
-
return;
|
|
131
|
-
mediaPlayer = mediaPlayerElement.current;
|
|
132
|
-
}
|
|
133
|
-
else if (typeof mediaPlayerElement === "string") {
|
|
134
|
-
const mediaElement = document.getElementById(mediaPlayerElement);
|
|
135
|
-
if (!isMediaElement(mediaElement))
|
|
136
|
-
return;
|
|
137
|
-
mediaPlayer = mediaElement;
|
|
138
|
-
}
|
|
139
|
-
else {
|
|
140
|
-
mediaPlayer = mediaPlayerElement;
|
|
141
|
-
}
|
|
142
|
-
if (initialTrack) {
|
|
143
|
-
// If supported type and not null, set the initial src
|
|
144
|
-
if (isExtendedMediaMetadata(initialTrack)) {
|
|
145
|
-
mediaPlayer.src = initialTrack.trackIdentifier;
|
|
146
|
-
}
|
|
147
|
-
else if (typeof initialTrack === "string") {
|
|
148
|
-
mediaPlayer.src = initialTrack;
|
|
149
|
-
}
|
|
150
|
-
}
|
|
151
|
-
// Begin synchronizing a MediaSynchronizer for the player
|
|
152
|
-
const synchronizer = mediaSession.synchronize(mediaPlayer);
|
|
153
|
-
if (viewOnly !== undefined) {
|
|
154
|
-
// Set synchronizer to view only mode provided by developer
|
|
155
|
-
synchronizer.viewOnly = viewOnly;
|
|
156
|
-
}
|
|
157
|
-
if (canSendPositionUpdates !== undefined) {
|
|
158
|
-
synchronizer.mediaSession.coordinator.canSendPositionUpdates =
|
|
159
|
-
canSendPositionUpdates;
|
|
160
|
-
}
|
|
161
|
-
if (mediaSession.initializeState ===
|
|
162
|
-
LiveDataObjectInitializeState.needed) {
|
|
163
|
-
// Start synchronizing the media session
|
|
164
|
-
mediaSession.initialize(allowedRoles !== null && allowedRoles !== void 0 ? allowedRoles : []);
|
|
165
|
-
}
|
|
166
|
-
else if (initialTrack) {
|
|
167
|
-
mediaSession.onLocalUserAllowed(() => __awaiter(this, void 0, void 0, function* () {
|
|
168
|
-
if (!mounted)
|
|
169
|
-
return;
|
|
170
|
-
try {
|
|
171
|
-
if (isExtendedMediaMetadata(initialTrack)) {
|
|
172
|
-
yield synchronizer.setTrack(initialTrack);
|
|
173
|
-
}
|
|
174
|
-
else if (typeof initialTrack === "string") {
|
|
175
|
-
yield synchronizer.setTrack({
|
|
176
|
-
trackIdentifier: initialTrack,
|
|
177
|
-
});
|
|
178
|
-
}
|
|
179
|
-
}
|
|
180
|
-
catch (err) {
|
|
181
|
-
console.error(err);
|
|
182
|
-
}
|
|
183
|
-
}));
|
|
184
|
-
}
|
|
185
|
-
setMediaSynchronizer(synchronizer);
|
|
186
|
-
return () => {
|
|
187
|
-
mounted = false;
|
|
188
|
-
synchronizer.removeAllListeners();
|
|
189
|
-
mediaSession.removeAllListeners();
|
|
190
|
-
synchronizer === null || synchronizer === void 0 ? void 0 : synchronizer.end();
|
|
191
|
-
mediaSession === null || mediaSession === void 0 ? void 0 : mediaSession.dispose();
|
|
192
|
-
};
|
|
193
|
-
}, [mediaSession, mediaPlayerElement]);
|
|
194
|
-
/**
|
|
195
|
-
* Change view in media synchronizer only if prop changes
|
|
196
|
-
*/
|
|
197
|
-
React.useEffect(() => {
|
|
198
|
-
if (!mediaSynchronizer)
|
|
199
|
-
return;
|
|
200
|
-
if (viewOnly === undefined)
|
|
201
|
-
return;
|
|
202
|
-
if (mediaSynchronizer.viewOnly === viewOnly)
|
|
203
|
-
return;
|
|
204
|
-
mediaSynchronizer.viewOnly = viewOnly;
|
|
205
|
-
}, [viewOnly, mediaSynchronizer === null || mediaSynchronizer === void 0 ? void 0 : mediaSynchronizer.viewOnly]);
|
|
206
|
-
/**
|
|
207
|
-
* Change canSendPositionUpdates when prop changes
|
|
208
|
-
*/
|
|
209
|
-
React.useEffect(() => {
|
|
210
|
-
if (!mediaSynchronizer)
|
|
211
|
-
return;
|
|
212
|
-
if (canSendPositionUpdates === undefined)
|
|
213
|
-
return;
|
|
214
|
-
if (mediaSynchronizer.mediaSession.coordinator
|
|
215
|
-
.canSendPositionUpdates === canSendPositionUpdates)
|
|
216
|
-
return;
|
|
217
|
-
mediaSynchronizer.mediaSession.coordinator.canSendPositionUpdates =
|
|
218
|
-
canSendPositionUpdates;
|
|
219
|
-
}, [
|
|
220
|
-
canSendPositionUpdates,
|
|
221
|
-
mediaSynchronizer === null || mediaSynchronizer === void 0 ? void 0 : mediaSynchronizer.mediaSession.coordinator.canSendPositionUpdates,
|
|
222
|
-
]);
|
|
223
|
-
return {
|
|
224
|
-
suspended: !!suspension,
|
|
225
|
-
mediaSynchronizer,
|
|
226
|
-
play,
|
|
227
|
-
pause,
|
|
228
|
-
seekTo,
|
|
229
|
-
setTrack,
|
|
230
|
-
beginSuspension,
|
|
231
|
-
endSuspension,
|
|
232
|
-
};
|
|
233
|
-
}
|
|
234
|
-
//# sourceMappingURL=useMediaSynchronizer.js.map
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"useMediaSynchronizer.js","sourceRoot":"","sources":["../../src/live-hooks/useMediaSynchronizer.ts"],"names":[],"mappings":"AAAA;;;GAGG;;;;;;;;;;AAEH,OAAO,EACH,6BAA6B,GAEhC,MAAM,uBAAuB,CAAC;AAC/B,OAAO,KAAK,MAAM,OAAO,CAAC;AAC1B,OAAO,EAIH,gBAAgB,GAGnB,MAAM,6BAA6B,CAAC;AACrC,OAAO,EAAE,uBAAuB,EAAE,cAAc,EAAE,WAAW,EAAE,MAAM,UAAU,CAAC;AAChF,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAEhD,OAAO,EAAE,sBAAsB,EAAE,MAAM,cAAc,CAAC;AACtD,OAAO,EACH,6BAA6B,EAC7B,kCAAkC,GACrC,MAAM,aAAa,CAAC;AAErB;;;;;;;;;;;;;;GAcG;AACH,MAAM,UAAU,oBAAoB,CAChC,SAAiB,EACjB,kBAIU,EACV,YAA4D,EAC5D,YAAgC,EAChC,QAAkB,EAClB,sBAAgC;IAEhC;;OAEG;IACH,MAAM,CAAC,iBAAiB,EAAE,oBAAoB,CAAC,GAAG,KAAK,CAAC,QAAQ,EAE7D,CAAC;IACJ;;OAEG;IACH,MAAM,CAAC,UAAU,EAAE,aAAa,CAAC,GAAG,KAAK,CAAC,QAAQ,EAE/C,CAAC;IACJ;;OAEG;IACH,MAAM,EAAE,GAAG,EAAE,YAAY,EAAE,GAAG,aAAa,CACvC,SAAS,EACT,gBAAgB,CACnB,CAAC;IAEF,MAAM,EAAE,SAAS,EAAE,GAAG,sBAAsB,EAAE,CAAC;IAE/C;;OAEG;IACH,MAAM,IAAI,GAAG,KAAK,CAAC,WAAW,CAAC,GAAS,EAAE;QACtC,IAAI,CAAC,SAAS,EAAE;YACZ,MAAM,IAAI,6BAA6B,CACnC,mBAAmB,EACnB,MAAM,CACT,CAAC;SACL;QACD,IAAI,iBAAiB,KAAK,SAAS,EAAE;YACjC,MAAM,IAAI,kCAAkC,CACxC,mBAAmB,EACnB,MAAM,CACT,CAAC;SACL;QACD,OAAO,MAAM,iBAAiB,CAAC,IAAI,EAAE,CAAC;IAC1C,CAAC,CAAA,EAAE,CAAC,SAAS,EAAE,iBAAiB,CAAC,CAAC,CAAC;IAEnC;;OAEG;IACH,MAAM,KAAK,GAAG,KAAK,CAAC,WAAW,CAAC,GAAS,EAAE;QACvC,IAAI,CAAC,SAAS,EAAE;YACZ,MAAM,IAAI,6BAA6B,CACnC,mBAAmB,EACnB,OAAO,CACV,CAAC;SACL;QACD,IAAI,iBAAiB,KAAK,SAAS,EAAE;YACjC,MAAM,IAAI,kCAAkC,CACxC,mBAAmB,EACnB,OAAO,CACV,CAAC;SACL;QACD,OAAO,MAAM,iBAAiB,CAAC,KAAK,EAAE,CAAC;IAC3C,CAAC,CAAA,EAAE,CAAC,SAAS,EAAE,iBAAiB,CAAC,CAAC,CAAC;IAEnC;;OAEG;IACH,MAAM,MAAM,GAAG,KAAK,CAAC,WAAW,CAC5B,CAAO,IAAY,EAAE,EAAE;QACnB,IAAI,CAAC,SAAS,EAAE;YACZ,MAAM,IAAI,6BAA6B,CACnC,mBAAmB,EACnB,QAAQ,CACX,CAAC;SACL;QACD,IAAI,iBAAiB,KAAK,SAAS,EAAE;YACjC,MAAM,IAAI,kCAAkC,CACxC,mBAAmB,EACnB,QAAQ,CACX,CAAC;SACL;QACD,OAAO,MAAM,iBAAiB,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;IAChD,CAAC,CAAA,EACD,CAAC,SAAS,EAAE,iBAAiB,CAAC,CACjC,CAAC;IAEF;;OAEG;IACH,MAAM,QAAQ,GAAG,KAAK,CAAC,WAAW,CAC9B,CAAO,KAAqD,EAAE,EAAE;QAC5D,IAAI,CAAC,SAAS,EAAE;YACZ,MAAM,IAAI,6BAA6B,CACnC,mBAAmB,EACnB,UAAU,CACb,CAAC;SACL;QACD,IAAI,iBAAiB,KAAK,SAAS,EAAE;YACjC,MAAM,IAAI,kCAAkC,CACxC,mBAAmB,EACnB,UAAU,CACb,CAAC;SACL;QACD,IAAI,uBAAuB,CAAC,KAAK,CAAC,EAAE;YAChC,OAAO,MAAM,iBAAiB,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;SAClD;aAAM,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE;YAClC,OAAO,MAAM,iBAAiB,CAAC,QAAQ,CAAC;gBACpC,eAAe,EAAE,KAAK;aACA,CAAC,CAAC;SAC/B;IACL,CAAC,CAAA,EACD,CAAC,SAAS,EAAE,iBAAiB,CAAC,CACjC,CAAC;IAEF;;OAEG;IACH,MAAM,eAAe,GAAG,KAAK,CAAC,WAAW,CACrC,CAAC,SAAiC,EAAE,EAAE;QAClC,MAAM,UAAU,GACZ,YAAY,aAAZ,YAAY,uBAAZ,YAAY,CAAE,WAAW,CAAC,eAAe,CAAC,SAAS,CAAC,CAAC;QACzD,aAAa,CAAC,UAAU,CAAC,CAAC;IAC9B,CAAC,EACD,CAAC,YAAY,CAAC,CACjB,CAAC;IAEF;;OAEG;IACH,MAAM,aAAa,GAAG,KAAK,CAAC,WAAW,CAAC,GAAG,EAAE;QACzC,UAAU,aAAV,UAAU,uBAAV,UAAU,CAAE,GAAG,EAAE,CAAC;QAClB,aAAa,CAAC,SAAS,CAAC,CAAC;IAC7B,CAAC,EAAE,CAAC,UAAU,CAAC,CAAC,CAAC;IAEjB;;OAEG;IACH,KAAK,CAAC,SAAS,CAAC,GAAG,EAAE;QACjB,IAAI,YAAY,KAAK,SAAS,IAAI,CAAC,kBAAkB;YAAE,OAAO;QAC9D,IAAI,OAAO,GAAG,IAAI,CAAC;QACnB,oEAAoE;QACpE,IAAI,WAAqC,CAAC;QAC1C,IAAI,WAAW,CAAe,kBAAkB,CAAC,EAAE;YAC/C,IAAI,CAAC,kBAAkB,CAAC,OAAO;gBAAE,OAAO;YACxC,WAAW,GAAG,kBAAkB,CAAC,OAAO,CAAC;SAC5C;aAAM,IAAI,OAAO,kBAAkB,KAAK,QAAQ,EAAE;YAC/C,MAAM,YAAY,GAAG,QAAQ,CAAC,cAAc,CACxC,kBAAkB,CACd,CAAC;YACT,IAAI,CAAC,cAAc,CAAC,YAAY,CAAC;gBAAE,OAAO;YAC1C,WAAW,GAAG,YAAY,CAAC;SAC9B;aAAM;YACH,WAAW,GAAG,kBAAkB,CAAC;SACpC;QACD,IAAI,YAAY,EAAE;YACd,sDAAsD;YACtD,IAAI,uBAAuB,CAAC,YAAY,CAAC,EAAE;gBACvC,WAAW,CAAC,GAAG,GAAG,YAAY,CAAC,eAAe,CAAC;aAClD;iBAAM,IAAI,OAAO,YAAY,KAAK,QAAQ,EAAE;gBACzC,WAAW,CAAC,GAAG,GAAG,YAAY,CAAC;aAClC;SACJ;QACD,yDAAyD;QACzD,MAAM,YAAY,GAAG,YAAY,CAAC,WAAW,CAAC,WAAW,CAAC,CAAC;QAC3D,IAAI,QAAQ,KAAK,SAAS,EAAE;YACxB,2DAA2D;YAC3D,YAAY,CAAC,QAAQ,GAAG,QAAQ,CAAC;SACpC;QACD,IAAI,sBAAsB,KAAK,SAAS,EAAE;YACtC,YAAY,CAAC,YAAY,CAAC,WAAW,CAAC,sBAAsB;gBACxD,sBAAsB,CAAC;SAC9B;QAED,IACI,YAAY,CAAC,eAAe;YAC5B,6BAA6B,CAAC,MAAM,EACtC;YACE,wCAAwC;YACxC,YAAY,CAAC,UAAU,CAAC,YAAY,aAAZ,YAAY,cAAZ,YAAY,GAAI,EAAE,CAAC,CAAC;SAC/C;aAAM,IAAI,YAAY,EAAE;YACrB,YAAY,CAAC,kBAAkB,CAAC,GAAS,EAAE;gBACvC,IAAI,CAAC,OAAO;oBAAE,OAAO;gBACrB,IAAI;oBACA,IAAI,uBAAuB,CAAC,YAAY,CAAC,EAAE;wBACvC,MAAM,YAAY,CAAC,QAAQ,CAAC,YAAY,CAAC,CAAC;qBAC7C;yBAAM,IAAI,OAAO,YAAY,KAAK,QAAQ,EAAE;wBACzC,MAAM,YAAY,CAAC,QAAQ,CAAC;4BACxB,eAAe,EAAE,YAAY;yBACP,CAAC,CAAC;qBAC/B;iBACJ;gBAAC,OAAO,GAAG,EAAE;oBACV,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;iBACtB;YACL,CAAC,CAAA,CAAC,CAAC;SACN;QACD,oBAAoB,CAAC,YAAY,CAAC,CAAC;QAEnC,OAAO,GAAG,EAAE;YACR,OAAO,GAAG,KAAK,CAAC;YAChB,YAAY,CAAC,kBAAkB,EAAE,CAAC;YAClC,YAAY,CAAC,kBAAkB,EAAE,CAAC;YAClC,YAAY,aAAZ,YAAY,uBAAZ,YAAY,CAAE,GAAG,EAAE,CAAC;YACpB,YAAY,aAAZ,YAAY,uBAAZ,YAAY,CAAE,OAAO,EAAE,CAAC;QAC5B,CAAC,CAAC;IACN,CAAC,EAAE,CAAC,YAAY,EAAE,kBAAkB,CAAC,CAAC,CAAC;IAEvC;;OAEG;IACH,KAAK,CAAC,SAAS,CAAC,GAAG,EAAE;QACjB,IAAI,CAAC,iBAAiB;YAAE,OAAO;QAC/B,IAAI,QAAQ,KAAK,SAAS;YAAE,OAAO;QACnC,IAAI,iBAAiB,CAAC,QAAQ,KAAK,QAAQ;YAAE,OAAO;QACpD,iBAAiB,CAAC,QAAQ,GAAG,QAAQ,CAAC;IAC1C,CAAC,EAAE,CAAC,QAAQ,EAAE,iBAAiB,aAAjB,iBAAiB,uBAAjB,iBAAiB,CAAE,QAAQ,CAAC,CAAC,CAAC;IAE5C;;OAEG;IACH,KAAK,CAAC,SAAS,CAAC,GAAG,EAAE;QACjB,IAAI,CAAC,iBAAiB;YAAE,OAAO;QAC/B,IAAI,sBAAsB,KAAK,SAAS;YAAE,OAAO;QACjD,IACI,iBAAiB,CAAC,YAAY,CAAC,WAAW;aACrC,sBAAsB,KAAK,sBAAsB;YAEtD,OAAO;QACX,iBAAiB,CAAC,YAAY,CAAC,WAAW,CAAC,sBAAsB;YAC7D,sBAAsB,CAAC;IAC/B,CAAC,EAAE;QACC,sBAAsB;QACtB,iBAAiB,aAAjB,iBAAiB,uBAAjB,iBAAiB,CAAE,YAAY,CAAC,WAAW,CAAC,sBAAsB;KACrE,CAAC,CAAC;IAEH,OAAO;QACH,SAAS,EAAE,CAAC,CAAC,UAAU;QACvB,iBAAiB;QACjB,IAAI;QACJ,KAAK;QACL,MAAM;QACN,QAAQ;QACR,eAAe;QACf,aAAa;KAChB,CAAC;AACN,CAAC"}
|
|
@@ -1,113 +0,0 @@
|
|
|
1
|
-
/*!
|
|
2
|
-
* Copyright (c) Microsoft Corporation. All rights reserved.
|
|
3
|
-
* Licensed under the Microsoft Live Share SDK License.
|
|
4
|
-
*/
|
|
5
|
-
import { IFluidContainer, LoadableObjectClassRecord } from "fluid-framework";
|
|
6
|
-
import React from "react";
|
|
7
|
-
import { AzureClientProps, AzureContainerServices } from "@fluidframework/azure-client";
|
|
8
|
-
import { IAzureContainerResults } from "../types";
|
|
9
|
-
import { ISharedStateRegistryResponse } from "../shared-hooks";
|
|
10
|
-
import { IFluidTurboClient } from "@microsoft/live-share-turbo";
|
|
11
|
-
/**
|
|
12
|
-
* React Context provider values for `<AzureProvider>` and `<LiveShareProvider>`.
|
|
13
|
-
*
|
|
14
|
-
* @remarks
|
|
15
|
-
* To get the latest values, use the {@link useFluidObjectsContext} hook.
|
|
16
|
-
*/
|
|
17
|
-
export interface IFluidContext extends ISharedStateRegistryResponse {
|
|
18
|
-
/**
|
|
19
|
-
* The Fluid Turbo client used for connecting to the Fluid container.
|
|
20
|
-
*/
|
|
21
|
-
clientRef: React.MutableRefObject<IFluidTurboClient>;
|
|
22
|
-
/**
|
|
23
|
-
* Stateful Fluid container.
|
|
24
|
-
*/
|
|
25
|
-
container: IFluidContainer | undefined;
|
|
26
|
-
/**
|
|
27
|
-
* The Azure container services (e.g., audience).
|
|
28
|
-
*/
|
|
29
|
-
services: AzureContainerServices | undefined;
|
|
30
|
-
/**
|
|
31
|
-
* A stateful error object that is set if there was an error connecting to the Fluid container.
|
|
32
|
-
*/
|
|
33
|
-
joinError: Error | undefined;
|
|
34
|
-
/**
|
|
35
|
-
* React callback function to connect to an existing Fluid container.
|
|
36
|
-
*
|
|
37
|
-
* @remarks
|
|
38
|
-
* The results will also be set to their stateful counterparts for `container` and `services`.
|
|
39
|
-
*
|
|
40
|
-
* @param containerId the containerId to connect to.
|
|
41
|
-
* @param initialObjects Optional. initial object schema, which should match that passed to `createContainer()`.
|
|
42
|
-
* @returns promise that returns a results object once complete (e.g., container, services, etc.)
|
|
43
|
-
*/
|
|
44
|
-
getContainer: (containerId: string, initialObjects?: LoadableObjectClassRecord) => Promise<IAzureContainerResults>;
|
|
45
|
-
/**
|
|
46
|
-
* React callback function to create and connect to a new Fluid container.
|
|
47
|
-
*
|
|
48
|
-
* @remarks
|
|
49
|
-
* The results will also be set to their stateful counterparts for `container` and `services`.
|
|
50
|
-
*
|
|
51
|
-
* @param initialObjects Optional. The initial object schema to apply to the container.
|
|
52
|
-
* @param onInitializeContainer Optional. A callback for when the container is first initialized, which is useful for setting default values to objects in `initialObjects`.
|
|
53
|
-
* @returns promise that returns a results object once complete (e.g., container, services, etc.)
|
|
54
|
-
*/
|
|
55
|
-
createContainer: (initialObjects?: LoadableObjectClassRecord, onInitializeContainer?: (container: IFluidContainer) => void) => Promise<IAzureContainerResults>;
|
|
56
|
-
}
|
|
57
|
-
/**
|
|
58
|
-
* @hidden
|
|
59
|
-
*/
|
|
60
|
-
export declare const FluidContext: React.Context<IFluidContext>;
|
|
61
|
-
/**
|
|
62
|
-
* Hook to get the latest React context state for `FluidContext`.
|
|
63
|
-
*
|
|
64
|
-
* @remarks
|
|
65
|
-
* This hook can only be used in a child component of `<LiveShareProvider>` or `<AzureProvider>`.
|
|
66
|
-
*
|
|
67
|
-
* @returns current state of `LiveShareContext`
|
|
68
|
-
*/
|
|
69
|
-
export declare const useFluidObjectsContext: () => IFluidContext;
|
|
70
|
-
/**
|
|
71
|
-
* Prop types for {@link AzureProvider} component.
|
|
72
|
-
*/
|
|
73
|
-
export interface IAzureProviderProps {
|
|
74
|
-
/**
|
|
75
|
-
* Optional. React children node for the React Context Provider.
|
|
76
|
-
*/
|
|
77
|
-
children?: React.ReactNode;
|
|
78
|
-
/**
|
|
79
|
-
* Props for initializing a new `AzureClient` instance.
|
|
80
|
-
*/
|
|
81
|
-
clientOptions: AzureClientProps;
|
|
82
|
-
/**
|
|
83
|
-
* The `containerId` to connect to when {@link joinOnLoad} is true.
|
|
84
|
-
*
|
|
85
|
-
* @remarks
|
|
86
|
-
* If you pass in an `undefined` value when {@link createOnLoad} is true, a new container will be created.
|
|
87
|
-
*/
|
|
88
|
-
containerId?: string;
|
|
89
|
-
/**
|
|
90
|
-
* Flag to control whether or not a new container should be created on first mount.
|
|
91
|
-
*
|
|
92
|
-
* @remarks
|
|
93
|
-
* If no {@link containerId} is set when the component first mounts, setting this to `true` will automatically create a new container.
|
|
94
|
-
* This prop does not do anything if you are using `<LiveShareProvider>` instead of `<AzureProvider>`.
|
|
95
|
-
*/
|
|
96
|
-
createOnLoad?: boolean;
|
|
97
|
-
/**
|
|
98
|
-
* The initial object schema to use when {@link joinOnLoad} or {@link createOnLoad} is true.
|
|
99
|
-
*/
|
|
100
|
-
initialObjects?: LoadableObjectClassRecord;
|
|
101
|
-
/**
|
|
102
|
-
* Flag to control whether or not to connect to an existing container on first mount.
|
|
103
|
-
*
|
|
104
|
-
* @remarks
|
|
105
|
-
* Setting this to true will connect to the container if {@link containerId} is provided as a prop.
|
|
106
|
-
*/
|
|
107
|
-
joinOnLoad?: boolean;
|
|
108
|
-
}
|
|
109
|
-
/**
|
|
110
|
-
* React Context provider component for using Fluid data objects & joining/creating a Fluid document `AzureClient`.
|
|
111
|
-
*/
|
|
112
|
-
export declare const AzureProvider: React.FC<IAzureProviderProps>;
|
|
113
|
-
//# sourceMappingURL=AzureProvider.d.ts.map
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"AzureProvider.d.ts","sourceRoot":"","sources":["../../src/providers/AzureProvider.tsx"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,eAAe,EAAE,yBAAyB,EAAE,MAAM,iBAAiB,CAAC;AAC7E,OAAO,KAAK,MAAM,OAAO,CAAC;AAC1B,OAAO,EACH,gBAAgB,EAChB,sBAAsB,EACzB,MAAM,8BAA8B,CAAC;AACtC,OAAO,EAAE,sBAAsB,EAAE,MAAM,UAAU,CAAC;AAClD,OAAO,EACH,4BAA4B,EAE/B,MAAM,iBAAiB,CAAC;AACzB,OAAO,EAEH,iBAAiB,EACpB,MAAM,6BAA6B,CAAC;AAErC;;;;;GAKG;AACH,MAAM,WAAW,aAAc,SAAQ,4BAA4B;IAC/D;;OAEG;IACH,SAAS,EAAE,KAAK,CAAC,gBAAgB,CAAC,iBAAiB,CAAC,CAAC;IACrD;;OAEG;IACH,SAAS,EAAE,eAAe,GAAG,SAAS,CAAC;IACvC;;OAEG;IACH,QAAQ,EAAE,sBAAsB,GAAG,SAAS,CAAC;IAC7C;;OAEG;IACH,SAAS,EAAE,KAAK,GAAG,SAAS,CAAC;IAC7B;;;;;;;;;OASG;IACH,YAAY,EAAE,CACV,WAAW,EAAE,MAAM,EACnB,cAAc,CAAC,EAAE,yBAAyB,KACzC,OAAO,CAAC,sBAAsB,CAAC,CAAC;IACrC;;;;;;;;;OASG;IACH,eAAe,EAAE,CACb,cAAc,CAAC,EAAE,yBAAyB,EAC1C,qBAAqB,CAAC,EAAE,CAAC,SAAS,EAAE,eAAe,KAAK,IAAI,KAC3D,OAAO,CAAC,sBAAsB,CAAC,CAAC;CACxC;AAED;;GAEG;AACH,eAAO,MAAM,YAAY,8BAExB,CAAC;AAEF;;;;;;;GAOG;AACH,eAAO,MAAM,sBAAsB,QAAO,aAQzC,CAAC;AAEF;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAChC;;OAEG;IACH,QAAQ,CAAC,EAAE,KAAK,CAAC,SAAS,CAAC;IAC3B;;OAEG;IACH,aAAa,EAAE,gBAAgB,CAAC;IAChC;;;;;OAKG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;;;;;OAMG;IACH,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB;;OAEG;IACH,cAAc,CAAC,EAAE,yBAAyB,CAAC;IAC3C;;;;;OAKG;IACH,UAAU,CAAC,EAAE,OAAO,CAAC;CACxB;AAED;;GAEG;AACH,eAAO,MAAM,aAAa,EAAE,KAAK,CAAC,EAAE,CAAC,mBAAmB,CAkHvD,CAAC"}
|