@microsoft/live-share-media 1.0.0-preview.3 → 1.0.0-preview.5

package/README.md

@@ -112,11 +112,12 @@ The Live Share SDK contains dependencies for [@microsoft/teams-js](https://www.n
 
 **It is critical that your app use the package dependencies listed in the table below.** Lookup the version of the `@microsoft/live-share` you're using and set any other dependencies in your package.json file to match:
 
-| @microsoft/live-share | @microsoft/teams-js  | fluid-framework | @microsoft/live-share-(media or canvas) | @fluidframework/azure-client | @microsoft/TeamsFx              | @microsoft/TeamsFx-react        |
-| --------------------- | -------------------- | --------------- | --------------------------- | ---------------------------- | ------------------------------- | ------------------------------- |
-| 1.0.0-preview.3       | 2.0.0-experimental.1 | ~1.2.3 | 1.0.0-preview.3 (optional)  | ~1.0.2 (optional)            | 2.0.0-experimental.0 (optional) | 2.0.0-experimental.0 (optional) |
-| ~0.5.1                | 2.0.0-experimental.1 | ~1.2.3          | ~0.5.1 (optional)           | ~1.0.2 (optional)            | 2.0.0-experimental.0 (optional) | 2.0.0-experimental.0 (optional) |
-| ~0.3.1                | 2.0.0-experimental.0 | ~0.59.0         | ~0.3.1 (optional)           | ~0.59.0 (optional)           | 2.0.0-experimental.0 (optional) | 2.0.0-experimental.0 (optional) |
+| @microsoft/live-share | @microsoft/teams-js  | fluid-framework | @microsoft/live-share-\*   | @fluidframework/azure-client | @microsoft/TeamsFx              | @microsoft/TeamsFx-react        |
+| --------------------- | -------------------- | --------------- | -------------------------- | ---------------------------- | ------------------------------- | ------------------------------- |
+| 1.0.0-preview.5       | ^2.5.0               | ~1.2.3          | 1.0.0-preview.5 (optional) | ~1.0.2 (optional)            | ^2.5.0 (optional)               | ^2.5.0 (optional)               |
+| 1.0.0-preview.3       | 2.0.0-experimental.1 | ~1.2.3          | 1.0.0-preview.3 (optional) | ~1.0.2 (optional)            | 2.0.0-experimental.0 (optional) | 2.0.0-experimental.0 (optional) |
+| ~0.5.1                | 2.0.0-experimental.1 | ~1.2.3          | ~0.5.1 (optional)          | ~1.0.2 (optional)            | 2.0.0-experimental.0 (optional) | 2.0.0-experimental.0 (optional) |
+| ~0.3.1                | 2.0.0-experimental.0 | ~0.59.0         | ~0.3.1 (optional)          | ~0.59.0 (optional)           | 2.0.0-experimental.0 (optional) | 2.0.0-experimental.0 (optional) |
 
 ## Contributing
 

package/bin/EphemeralMediaSession.d.ts

@@ -0,0 +1,102 @@
+/**
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the Microsoft Live Share SDK License.
+ */
+import { DataObject, DataObjectFactory } from '@fluidframework/aqueduct';
+import { EphemeralTelemetryLogger, UserMeetingRole } from '@microsoft/live-share';
+import { MediaPlayerSynchronizer } from './MediaPlayerSynchronizer';
+import { ExtendedMediaSessionAction } from './MediaSessionExtensions';
+import { EphemeralMediaSessionCoordinator, IMediaPlayerState } from './EphemeralMediaSessionCoordinator';
+import { MediaSessionActionThrottler } from './MediaSessionActionThrottler';
+import { IMediaPlayer } from './IMediaPlayer';
+/**
+ * Ephemeral fluid object that synchronizes media playback across multiple clients.
+ */
+export declare class EphemeralMediaSession extends DataObject {
+    private _actionThrottler;
+    private _logger?;
+    private _requestPlayerStateHandler?;
+    private _coordinator?;
+    private readonly _actionHandlers;
+    private _synchronizing?;
+    private _updateTimer;
+    private _lastUpdateTime;
+    /**
+     * The objects fluid type name.
+     */
+    static readonly TypeName = "@microsoft/fluid-media:SharedMediaSession";
+    /**
+     * The objects fluid type factory.
+     */
+    static readonly factory: DataObjectFactory<EphemeralMediaSession, import("@fluidframework/aqueduct").DataObjectTypes>;
+    /**
+     * Extension point that lets applications replace the default logic for throttling the sessions
+     * local sync behavior.
+     *
+     * @remarks
+     * The `EphemeralMediaCoordinator` is fairly aggressive at wanting to keep the local media player
+     * in sync with the rest of the group. This aggressiveness can result in the coordinator sending
+     * new sync actions before the local player has finished responding to the previous sync action.
+     * The `ActionThrottler` gives apps fine grain control over how aggressive they want sync to be.
+     *
+     * By default, a `RepeatedAction` throttler is used which prevents the same sync action from
+     * being sent within an adjustable time period.
+     */
+    get actionThrottler(): MediaSessionActionThrottler;
+    set actionThrottler(value: MediaSessionActionThrottler);
+    /**
+     * Returns true if the object has been initialized.
+     */
+    get isInitialized(): boolean;
+    /**
+     * @deprecated isInitialized should be used instead
+     * Returns true if the object has been initialized.
+     */
+    get isStarted(): boolean;
+    /**
+     * The group coordinator for the session.
+     */
+    get coordinator(): EphemeralMediaSessionCoordinator;
+    /**
+     * Returns the logger used by the session and coordinator.
+     *
+     * @remarks
+     * This is used by the `MediaPlayerSynchronizer` to log events.
+     */
+    get logger(): EphemeralTelemetryLogger;
+    /**
+     * initialize the object.
+     * @param acceptTransportChangesFrom Optional. List of roles allowed to group transport
+     * operations like play/pause/seek/setTrack.
+     */
+    initialize(acceptTransportChangesFrom?: UserMeetingRole[]): Promise<void>;
+    /**
+     * @deprecated initialize should be used instead
+     * initialize the object.
+     * @param acceptTransportChangesFrom Optional. List of roles allowed to group transport
+     * operations like play/pause/seek/setTrack.
+     */
+    start(acceptTransportChangesFrom?: UserMeetingRole[]): Promise<void>;
+    /**
+     * Registers an action handler with the session.
+     * @param action Name of the action to register a handler for.
+     * @param handler Function called when the action is triggered.
+     */
+    setActionHandler(action: ExtendedMediaSessionAction, handler: MediaSessionActionHandler | null): void;
+    /**
+     * Registers a handler that will be queried anytime the group coordinate needs to know the
+     * local players transport state and position.
+     */
+    setRequestPlayerStateHandler(handler: () => IMediaPlayerState): void;
+    /**
+     * Begins synchronizing the playback of a media element.
+     * @param player Something that "looks like" and HTML Media Element.
+     * @returns A new synchronizer instance. Call `synchronizer.end()` to stop synchronizing the elements playback.
+     */
+    synchronize(player: IMediaPlayer): MediaPlayerSynchronizer;
+    protected hasInitialized(): Promise<void>;
+    private checkWaitPointHit;
+    private getCurrentPlayerState;
+    private dispatchAction;
+}
+//# sourceMappingURL=EphemeralMediaSession.d.ts.map

package/bin/EphemeralMediaSession.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"EphemeralMediaSession.d.ts","sourceRoot":"","sources":["../src/EphemeralMediaSession.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,UAAU,EAAE,iBAAiB,EAAE,MAAM,0BAA0B,CAAC;AACzE,OAAO,EAAE,wBAAwB,EAAE,eAAe,EAAE,MAAM,uBAAuB,CAAC;AAClF,OAAO,EAAE,uBAAuB,EAAE,MAAM,2BAA2B,CAAC;AAEpE,OAAO,EAAiC,0BAA0B,EAAqC,MAAM,0BAA0B,CAAC;AACxI,OAAO,EAAE,gCAAgC,EAAE,iBAAiB,EAAE,MAAM,oCAAoC,CAAC;AACzG,OAAO,EAAE,2BAA2B,EAAE,MAAM,+BAA+B,CAAC;AAE5E,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAE9C;;GAEG;AACF,qBAAa,qBAAsB,SAAQ,UAAU;IAClD,OAAO,CAAC,gBAAgB,CAA8D;IACtF,OAAO,CAAC,OAAO,CAAC,CAA2B;IAC3C,OAAO,CAAC,0BAA0B,CAAC,CAA0B;IAC7D,OAAO,CAAC,YAAY,CAAC,CAAmC;IACxD,OAAO,CAAC,QAAQ,CAAC,eAAe,CAAqD;IACrF,OAAO,CAAC,cAAc,CAAC,CAA0B;IAGjD,OAAO,CAAC,YAAY,CAAM;IAC1B,OAAO,CAAC,eAAe,CAAa;IAEpC;;OAEG;IACF,gBAAuB,QAAQ,+CAA+C;IAE/E;;OAEG;IACF,gBAAuB,OAAO,+FAK7B;IAEF;;;;;;;;;;;;OAYG;IACH,IAAW,eAAe,IAAI,2BAA2B,CAExD;IAED,IAAW,eAAe,CAAC,KAAK,EAAE,2BAA2B,EAE5D;IAED;;OAEG;IACH,IAAW,aAAa,IAAI,OAAO,CAElC;IAED;;;OAGG;IACH,IAAW,SAAS,IAAI,OAAO,CAE9B;IAED;;OAEG;IACH,IAAW,WAAW,IAAI,gCAAgC,CAEzD;IAED;;;;;OAKG;IACH,IAAW,MAAM,IAAI,wBAAwB,CAE5C;IAED;;;;OAIG;IACK,UAAU,CAAC,0BAA0B,CAAC,EAAE,eAAe,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC;IAIjF;;;;;OAKG;IACI,KAAK,CAAC,0BAA0B,CAAC,EAAE,eAAe,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC;IAI3E;;;;OAIG;IACI,gBAAgB,CAAC,MAAM,EAAE,0BAA0B,EAAE,OAAO,EAAE,yBAAyB,GAAG,IAAI,GAAG,IAAI;IAW5G;;;OAGG;IACI,4BAA4B,CAAC,OAAO,EAAE,MAAM,iBAAiB;IAIpE;;;;OAIG;IACI,WAAW,CAAC,MAAM,EAAE,YAAY,GAAG,uBAAuB;cA+BjD,cAAc,IAAI,OAAO,CAAC,IAAI,CAAC;IAuC/C,OAAO,CAAC,iBAAiB;IAiBzB,OAAO,CAAC,qBAAqB;IAQ7B,OAAO,CAAC,cAAc;CAMzB"}

package/bin/EphemeralMediaSession.js

@@ -0,0 +1,226 @@
+"use strict";
+/**
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the Microsoft Live Share SDK License.
+ */
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.EphemeralMediaSession = void 0;
+const aqueduct_1 = require("@fluidframework/aqueduct");
+const live_share_1 = require("@microsoft/live-share");
+const MediaPlayerSynchronizer_1 = require("./MediaPlayerSynchronizer");
+const internals_1 = require("./internals");
+const MediaSessionExtensions_1 = require("./MediaSessionExtensions");
+const EphemeralMediaSessionCoordinator_1 = require("./EphemeralMediaSessionCoordinator");
+const RepeatedActionThrottler_1 = require("./RepeatedActionThrottler");
+/**
+ * Ephemeral fluid object that synchronizes media playback across multiple clients.
+ */
+class EphemeralMediaSession extends aqueduct_1.DataObject {
+    constructor() {
+        super(...arguments);
+        this._actionThrottler = new RepeatedActionThrottler_1.RepeatedActionThrottler();
+        this._actionHandlers = new Map();
+        this._lastUpdateTime = 0;
+    }
+    /**
+     * Extension point that lets applications replace the default logic for throttling the sessions
+     * local sync behavior.
+     *
+     * @remarks
+     * The `EphemeralMediaCoordinator` is fairly aggressive at wanting to keep the local media player
+     * in sync with the rest of the group. This aggressiveness can result in the coordinator sending
+     * new sync actions before the local player has finished responding to the previous sync action.
+     * The `ActionThrottler` gives apps fine grain control over how aggressive they want sync to be.
+     *
+     * By default, a `RepeatedAction` throttler is used which prevents the same sync action from
+     * being sent within an adjustable time period.
+     */
+    get actionThrottler() {
+        return this._actionThrottler;
+    }
+    set actionThrottler(value) {
+        this._actionThrottler = value;
+    }
+    /**
+     * Returns true if the object has been initialized.
+     */
+    get isInitialized() {
+        return this.coordinator.isInitialized;
+    }
+    /**
+     * @deprecated isInitialized should be used instead
+     * Returns true if the object has been initialized.
+     */
+    get isStarted() {
+        return this.isInitialized;
+    }
+    /**
+     * The group coordinator for the session.
+     */
+    get coordinator() {
+        return this._coordinator;
+    }
+    /**
+     * Returns the logger used by the session and coordinator.
+     *
+     * @remarks
+     * This is used by the `MediaPlayerSynchronizer` to log events.
+     */
+    get logger() {
+        return this._logger;
+    }
+    /**
+     * initialize the object.
+     * @param acceptTransportChangesFrom Optional. List of roles allowed to group transport
+     * operations like play/pause/seek/setTrack.
+     */
+    initialize(acceptTransportChangesFrom) {
+        return this.coordinator.initialize(acceptTransportChangesFrom);
+    }
+    /**
+     * @deprecated initialize should be used instead
+     * initialize the object.
+     * @param acceptTransportChangesFrom Optional. List of roles allowed to group transport
+     * operations like play/pause/seek/setTrack.
+     */
+    start(acceptTransportChangesFrom) {
+        return this.initialize(acceptTransportChangesFrom);
+    }
+    /**
+     * Registers an action handler with the session.
+     * @param action Name of the action to register a handler for.
+     * @param handler Function called when the action is triggered.
+     */
+    setActionHandler(action, handler) {
+        if (handler) {
+            // add handler
+            this._actionHandlers.set(action, handler);
+        }
+        else if (this._actionHandlers.has(action)) {
+            // remove handler
+            this._actionHandlers.delete(action);
+        }
+    }
+    /**
+     * Registers a handler that will be queried anytime the group coordinate needs to know the
+     * local players transport state and position.
+     */
+    setRequestPlayerStateHandler(handler) {
+        this._requestPlayerStateHandler = handler;
+    }
+    /**
+     * Begins synchronizing the playback of a media element.
+     * @param player Something that "looks like" and HTML Media Element.
+     * @returns A new synchronizer instance. Call `synchronizer.end()` to stop synchronizing the elements playback.
+     */
+    synchronize(player) {
+        // A session can only synchronize one player at a time
+        if (this._synchronizing) {
+            this._synchronizing.end();
+        }
+        // Start position update timer
+        if (!this._updateTimer) {
+            this.logger.sendTelemetryEvent(internals_1.TelemetryEvents.MediaSession.BeginPositionUpdateTimer);
+            this._updateTimer = setInterval(() => {
+                // Get current state
+                const state = this.getCurrentPlayerState();
+                // Check for hit wait point
+                this.checkWaitPointHit(state);
+                // Send position update if interval hit
+                const now = new Date().getTime();
+                const delta = (now - this._lastUpdateTime) / 1000;
+                if (this.coordinator.isInitialized && delta >= this.coordinator.positionUpdateInterval) {
+                    this._lastUpdateTime = now;
+                    this.coordinator.sendPositionUpdate(state);
+                }
+            }, 500);
+        }
+        return new MediaPlayerSynchronizer_1.MediaPlayerSynchronizer(player, this, () => {
+            this._synchronizing = undefined;
+        });
+    }
+    hasInitialized() {
+        return __awaiter(this, void 0, void 0, function* () {
+            this._logger = new live_share_1.EphemeralTelemetryLogger(this.runtime);
+            // Create coordinator and listen for triggered actions
+            this._coordinator = new EphemeralMediaSessionCoordinator_1.EphemeralMediaSessionCoordinator(this.runtime, () => this.getCurrentPlayerState());
+            this._coordinator.on(MediaSessionExtensions_1.MediaSessionCoordinatorEvents.triggeraction, (event) => {
+                // Pre-process actions
+                const details = event.details;
+                const seekTime = typeof details.seekTime == 'number' ? details.seekTime : -1;
+                switch (details.action) {
+                    case 'play':
+                        this.logger.sendTelemetryEvent(internals_1.TelemetryEvents.MediaSession.PlayAction, null, { position: seekTime });
+                        break;
+                    case 'pause':
+                        this.logger.sendTelemetryEvent(internals_1.TelemetryEvents.MediaSession.PauseAction, null, { position: seekTime });
+                        break;
+                    case 'seekto':
+                        this.logger.sendTelemetryEvent(internals_1.TelemetryEvents.MediaSession.SeekToAction, null, { position: seekTime });
+                        break;
+                    case 'settrack':
+                        this.logger.sendTelemetryEvent(internals_1.TelemetryEvents.MediaSession.SetTrackAction);
+                        break;
+                    case 'datachange':
+                        this.logger.sendTelemetryEvent(internals_1.TelemetryEvents.MediaSession.DataChangeAction);
+                        break;
+                    case 'catchup':
+                        // Default to seekto if catchup not implemented
+                        this.logger.sendTelemetryEvent(internals_1.TelemetryEvents.MediaSession.CatchUpAction, null, { position: seekTime });
+                        if (!this._actionHandlers.has('catchup')) {
+                            details.action = 'seekto';
+                        }
+                        break;
+                }
+                // Dispatch action
+                this.dispatchAction(details);
+            });
+        });
+    }
+    checkWaitPointHit(state) {
+        // Was a wait point hit?
+        if (state.positionState && this.coordinator.isInitialized) {
+            const waitPoint = this.coordinator.findNextWaitPoint();
+            if (waitPoint && state.positionState.position != undefined && state.positionState.position >= waitPoint.position) {
+                // Ensure handler registered
+                if (!this._actionHandlers.has('wait')) {
+                    throw new Error(`SharedMediaSession: wait point hit but no 'wait' action registered.`);
+                }
+                // Begin suspension for wait point
+                const suspension = this.coordinator.beginSuspension(waitPoint);
+                this.dispatchAction({ action: 'wait', suspension: suspension });
+            }
+        }
+    }
+    getCurrentPlayerState() {
+        if (!this._requestPlayerStateHandler) {
+            throw new Error(`SharedMediaSession: no getPlayerState callback configured.`);
+        }
+        return this._requestPlayerStateHandler();
+    }
+    dispatchAction(details) {
+        if (this._actionHandlers.has(details.action)) {
+            const handler = this._actionHandlers.get(details.action);
+            this._actionThrottler.throttled(details, handler);
+        }
+    }
+}
+exports.EphemeralMediaSession = EphemeralMediaSession;
+/**
+ * The objects fluid type name.
+ */
+EphemeralMediaSession.TypeName = `@microsoft/fluid-media:SharedMediaSession`;
+/**
+ * The objects fluid type factory.
+ */
+EphemeralMediaSession.factory = new aqueduct_1.DataObjectFactory(EphemeralMediaSession.TypeName, EphemeralMediaSession, [], {});
+//# sourceMappingURL=EphemeralMediaSession.js.map

package/bin/EphemeralMediaSession.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"EphemeralMediaSession.js","sourceRoot":"","sources":["../src/EphemeralMediaSession.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;;;;;;;;;;AAEH,uDAAyE;AACzE,sDAAkF;AAClF,uEAAoE;AACpE,2CAAmE;AACnE,qEAAwI;AACxI,yFAAyG;AAEzG,uEAAoE;AAGpE;;GAEG;AACF,MAAa,qBAAsB,SAAQ,qBAAU;IAArD;;QACW,qBAAgB,GAAgC,IAAI,iDAAuB,EAAE,CAAC;QAIrE,oBAAe,GAA2C,IAAI,GAAG,EAAE,CAAC;QAK7E,oBAAe,GAAW,CAAC,CAAC;IA2NxC,CAAC;IA1MG;;;;;;;;;;;;OAYG;IACH,IAAW,eAAe;QACtB,OAAO,IAAI,CAAC,gBAAgB,CAAC;IACjC,CAAC;IAED,IAAW,eAAe,CAAC,KAAkC;QACzD,IAAI,CAAC,gBAAgB,GAAG,KAAK,CAAC;IAClC,CAAC;IAED;;OAEG;IACH,IAAW,aAAa;QACpB,OAAO,IAAI,CAAC,WAAW,CAAC,aAAa,CAAC;IAC1C,CAAC;IAED;;;OAGG;IACH,IAAW,SAAS;QAChB,OAAO,IAAI,CAAC,aAAa,CAAA;IAC7B,CAAC;IAED;;OAEG;IACH,IAAW,WAAW;QAClB,OAAO,IAAI,CAAC,YAAa,CAAC;IAC9B,CAAC;IAED;;;;;OAKG;IACH,IAAW,MAAM;QACb,OAAO,IAAI,CAAC,OAAQ,CAAC;IACzB,CAAC;IAED;;;;OAIG;IACK,UAAU,CAAC,0BAA8C;QAC7D,OAAO,IAAI,CAAC,WAAW,CAAC,UAAU,CAAC,0BAA0B,CAAC,CAAC;IACnE,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,0BAA8C;QACvD,OAAO,IAAI,CAAC,UAAU,CAAC,0BAA0B,CAAC,CAAA;IACtD,CAAC;IAED;;;;OAIG;IACI,gBAAgB,CAAC,MAAkC,EAAE,OAAyC;QACjG,IAAI,OAAO,EAAE;YACT,cAAc;YACd,IAAI,CAAC,eAAe,CAAC,GAAG,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;SAE7C;aAAM,IAAI,IAAI,CAAC,eAAe,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE;YACzC,iBAAiB;YACjB,IAAI,CAAC,eAAe,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;SACvC;IACL,CAAC;IAED;;;OAGG;IACI,4BAA4B,CAAC,OAAgC;QAChE,IAAI,CAAC,0BAA0B,GAAG,OAAO,CAAC;IAC9C,CAAC;IAED;;;;OAIG;IACI,WAAW,CAAC,MAAoB;QACnC,sDAAsD;QACtD,IAAI,IAAI,CAAC,cAAc,EAAE;YACrB,IAAI,CAAC,cAAc,CAAC,GAAG,EAAE,CAAC;SAC7B;QAED,8BAA8B;QAC9B,IAAI,CAAC,IAAI,CAAC,YAAY,EAAE;YACpB,IAAI,CAAC,MAAM,CAAC,kBAAkB,CAAC,2BAAe,CAAC,YAAY,CAAC,wBAAwB,CAAC,CAAC;YACtF,IAAI,CAAC,YAAY,GAAG,WAAW,CAAC,GAAG,EAAE;gBACjC,oBAAoB;gBACpB,MAAM,KAAK,GAAG,IAAI,CAAC,qBAAqB,EAAE,CAAC;gBAE3C,2BAA2B;gBAC3B,IAAI,CAAC,iBAAiB,CAAC,KAAK,CAAC,CAAC;gBAE9B,uCAAuC;gBACvC,MAAM,GAAG,GAAG,IAAI,IAAI,EAAE,CAAC,OAAO,EAAE,CAAC;gBACjC,MAAM,KAAK,GAAG,CAAC,GAAG,GAAG,IAAI,CAAC,eAAe,CAAC,GAAG,IAAI,CAAC;gBAClD,IAAI,IAAI,CAAC,WAAW,CAAC,aAAa,IAAI,KAAK,IAAI,IAAI,CAAC,WAAW,CAAC,sBAAsB,EAAE;oBACpF,IAAI,CAAC,eAAe,GAAG,GAAG,CAAC;oBAC3B,IAAI,CAAC,WAAW,CAAC,kBAAkB,CAAC,KAAK,CAAC,CAAC;iBAC9C;YACL,CAAC,EAAE,GAAG,CAAC,CAAC;SACX;QAED,OAAO,IAAI,iDAAuB,CAAC,MAAM,EAAE,IAAI,EAAE,GAAG,EAAE;YAClD,IAAI,CAAC,cAAc,GAAG,SAAS,CAAC;QACpC,CAAC,CAAC,CAAC;IACP,CAAC;IAEe,cAAc;;YAC1B,IAAI,CAAE,OAAO,GAAG,IAAI,qCAAwB,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;YAE3D,sDAAsD;YACtD,IAAI,CAAC,YAAY,GAAG,IAAI,mEAAgC,CAAC,IAAI,CAAC,OAAO,EAAE,GAAG,EAAE,CAAC,IAAI,CAAC,qBAAqB,EAAE,CAAC,CAAC;YAC3G,IAAI,CAAC,YAAY,CAAC,EAAE,CAAC,sDAA6B,CAAC,aAAa,EAAE,CAAC,KAA0B,EAAE,EAAE;gBAC7F,sBAAsB;gBACtB,MAAM,OAAO,GAAG,KAAK,CAAC,OAAO,CAAC;gBAC9B,MAAM,QAAQ,GAAG,OAAO,OAAO,CAAC,QAAQ,IAAI,QAAQ,CAAC,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;gBAC7E,QAAQ,OAAO,CAAC,MAAM,EAAE;oBACpB,KAAK,MAAM;wBACP,IAAI,CAAC,MAAM,CAAC,kBAAkB,CAAC,2BAAe,CAAC,YAAY,CAAC,UAAU,EAAE,IAAI,EAAE,EAAC,QAAQ,EAAE,QAAQ,EAAC,CAAC,CAAC;wBACpG,MAAM;oBACV,KAAK,OAAO;wBACR,IAAI,CAAC,MAAM,CAAC,kBAAkB,CAAC,2BAAe,CAAC,YAAY,CAAC,WAAW,EAAE,IAAI,EAAE,EAAC,QAAQ,EAAE,QAAQ,EAAC,CAAC,CAAC;wBACrG,MAAM;oBACV,KAAK,QAAQ;wBACT,IAAI,CAAC,MAAM,CAAC,kBAAkB,CAAC,2BAAe,CAAC,YAAY,CAAC,YAAY,EAAE,IAAI,EAAE,EAAC,QAAQ,EAAE,QAAQ,EAAC,CAAC,CAAC;wBACtG,MAAM;oBACV,KAAK,UAAU;wBACX,IAAI,CAAC,MAAM,CAAC,kBAAkB,CAAC,2BAAe,CAAC,YAAY,CAAC,cAAc,CAAC,CAAC;wBAC5E,MAAM;oBACV,KAAK,YAAY;wBACb,IAAI,CAAC,MAAM,CAAC,kBAAkB,CAAC,2BAAe,CAAC,YAAY,CAAC,gBAAgB,CAAC,CAAC;wBAC9E,MAAM;oBACV,KAAK,SAAS;wBACV,+CAA+C;wBAC/C,IAAI,CAAC,MAAM,CAAC,kBAAkB,CAAC,2BAAe,CAAC,YAAY,CAAC,aAAa,EAAE,IAAI,EAAE,EAAC,QAAQ,EAAE,QAAQ,EAAC,CAAC,CAAC;wBACvG,IAAI,CAAC,IAAI,CAAC,eAAe,CAAC,GAAG,CAAC,SAAS,CAAC,EAAE;4BACtC,OAAO,CAAC,MAAM,GAAG,QAAQ,CAAC;yBAC7B;wBACD,MAAM;iBACb;gBAED,kBAAkB;gBAClB,IAAI,CAAC,cAAc,CAAC,OAAO,CAAC,CAAC;YACjC,CAAC,CAAC,CAAC;QACP,CAAC;KAAA;IAEO,iBAAiB,CAAC,KAAwB;QAC9C,wBAAwB;QACxB,IAAI,KAAK,CAAC,aAAa,IAAI,IAAI,CAAC,WAAW,CAAC,aAAa,EAAE;YACvD,MAAM,SAAS,GAAG,IAAI,CAAC,WAAW,CAAC,iBAAiB,EAAE,CAAC;YACvD,IAAI,SAAS,IAAI,KAAK,CAAC,aAAa,CAAC,QAAQ,IAAI,SAAS,IAAI,KAAK,CAAC,aAAa,CAAC,QAAQ,IAAI,SAAS,CAAC,QAAQ,EAAE;gBAC9G,4BAA4B;gBAC5B,IAAI,CAAC,IAAI,CAAC,eAAe,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE;oBACnC,MAAM,IAAI,KAAK,CAAC,qEAAqE,CAAC,CAAC;iBAC1F;gBAED,kCAAkC;gBAClC,MAAM,UAAU,GAAG,IAAI,CAAC,WAAW,CAAC,eAAe,CAAC,SAAS,CAAC,CAAC;gBAC/D,IAAI,CAAC,cAAc,CAAC,EAAC,MAAM,EAAE,MAAM,EAAE,UAAU,EAAE,UAAU,EAAC,CAAC,CAAC;aACjE;SACJ;IACL,CAAC;IAEO,qBAAqB;QACzB,IAAI,CAAC,IAAI,CAAC,0BAA0B,EAAE;YAClC,MAAM,IAAI,KAAK,CAAC,4DAA4D,CAAC,CAAC;SACjF;QAED,OAAO,IAAI,CAAC,0BAA0B,EAAE,CAAC;IAC7C,CAAC;IAEO,cAAc,CAAC,OAAoE;QACvF,IAAI,IAAI,CAAC,eAAe,CAAC,GAAG,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE;YAC1C,MAAM,OAAO,GAAG,IAAI,CAAC,eAAe,CAAC,GAAG,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;YACzD,IAAI,CAAC,gBAAgB,CAAC,SAAS,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;SACrD;IACL,CAAC;;AApOJ,sDAqOA;AAzNG;;GAEG;AACqB,8BAAQ,GAAG,2CAA2C,CAAC;AAE/E;;GAEG;AACqB,6BAAO,GAAG,IAAI,4BAAiB,CACnD,qBAAqB,CAAC,QAAQ,EAC9B,qBAAqB,EACrB,EAAE,EACF,EAAE,CACL,CAAC"}

package/bin/EphemeralMediaSessionCoordinator.d.ts

@@ -0,0 +1,228 @@
+/**
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the Microsoft Live Share SDK License.
+ */
+/// <reference types="node" />
+import { IRuntimeSignaler, UserMeetingRole } from '@microsoft/live-share';
+import { CoordinationWaitPoint, ExtendedMediaMetadata, ExtendedMediaSessionPlaybackState, MediaSessionCoordinatorSuspension } from './MediaSessionExtensions';
+import EventEmitter from "events";
+/**
+ * Most recent state of the media session.
+ */
+export interface IMediaPlayerState {
+    /**
+     * Metadata for the sessions current track.
+     */
+    metadata: ExtendedMediaMetadata | null;
+    /**
+     * Optional track data object being synchronized.
+     *
+     * @remarks
+     * This can be used to sync things like pitch, roll, and yaw when watching 360 videos together.
+     */
+    trackData: object | null;
+    /**
+     * Sessions current playback state.
+     */
+    playbackState: ExtendedMediaSessionPlaybackState;
+    /**
+     * Sessions current position state if known.
+     */
+    positionState?: MediaPositionState;
+}
+/**
+ * The `EphemeralMediaSessionCoordinator` tracks the playback & position state of all other
+ * clients being synchronized with. It is responsible for keeping the local media player
+ * in sync with the group.
+ */
+export declare class EphemeralMediaSessionCoordinator extends EventEmitter {
+    private readonly _runtime;
+    private readonly _logger;
+    private readonly _getPlayerState;
+    private _positionUpdateInterval;
+    private _maxPlaybackDrift;
+    private _lastWaitPoint?;
+    private _hasInitialized;
+    private _playEvent?;
+    private _pauseEvent?;
+    private _seekToEvent?;
+    private _setTrackEvent?;
+    private _setTrackDataEvent?;
+    private _positionUpdateEvent?;
+    private _joinedEvent?;
+    private _groupState?;
+    /**
+     * @hidden
+     * Applications shouldn't directly create new coordinator instances.
+     */
+    constructor(runtime: IRuntimeSignaler, getPlayerState: () => IMediaPlayerState);
+    /**
+     * Controls whether or not the local client is allowed to instruct the group to play or pause.
+     *
+     * @remarks
+     * This flag largely meant to influence decisions made by the coordinator and can be used by
+     * the UI to determine what controls should be shown to the user. It does not provide any
+     * security in itself.
+     *
+     * If your app is running in a semi-trusted environment where only some clients are allowed
+     * to play/pause media, you should use "role based verification" to enforce those policies.
+     */
+    canPlayPause: boolean;
+    /**
+     * Controls whether or not the local client is allowed to seek the group to a new playback
+     * position.
+     *
+     * @remarks
+     * This flag largely meant to influence decisions made by the coordinator and can be used by
+     * the UI to determine what controls should be shown to the user. It does not provide any
+     * security in itself.
+     *
+     * If your app is running in a semi-trusted environment where only some clients are allowed
+     * to change the playback position, you should use "role based verification" to enforce those policies.
+     */
+    canSeek: boolean;
+    /**
+     * Controls whether or not the local client is allowed to change tracks.
+     *
+     * @remarks
+     * This flag largely meant to influence decisions made by the coordinator and can be used by
+     * the UI to determine what controls should be shown to the user. It does not provide any
+     * security in itself.
+     *
+     * If your app is running in a semi-trusted environment where only some clients are allowed
+     * to change tracks, you should use "role based verification" to enforce those policies.
+     */
+    canSetTrack: boolean;
+    /**
+     * Controls whether or not the local client is allowed to change the tracks custom data object.
+     *
+     * @remarks
+     * This flag largely meant to influence decisions made by the coordinator and can be used by
+     * the UI to determine what controls should be shown to the user. It does not provide any
+     * security in itself.
+     *
+     * If your app is running in a semi-trusted environment where only some clients are allowed
+     * to change the tracks data object, you should use "role based verification" to enforce those
+     * policies.
+     */
+    canSetTrackData: boolean;
+    /**
+     * Returns true if the local client is in a suspended state.
+     */
+    get isSuspended(): boolean;
+    /**
+     * Max amount of playback drift allowed in seconds.
+     *
+     * @remarks
+     * Should the local clients playback position lag by more than the specified value, the
+     * coordinator will trigger a `catchup` action.
+     *
+     * Defaults to a value of `1` second.
+     */
+    get maxPlaybackDrift(): number;
+    set maxPlaybackDrift(value: number);
+    /**
+     * Frequency with which position updates are broadcast to the rest of the group in
+     * seconds.
+     *
+     * @remarks
+     * Defaults to a value of `2` seconds.
+     */
+    get positionUpdateInterval(): number;
+    set positionUpdateInterval(value: number);
+    /**
+     * Instructs the group to play the current track.
+     *
+     * @remarks
+     * Throws an exception if the session/coordinator hasn't been initialized, no track has been
+     * loaded, or `canPlayPause` is false.
+     */
+    play(): void;
+    /**
+     * Instructs the group to pause the current track.
+     *
+     * @remarks
+     * Throws an exception if the session/coordinator hasn't been initialized, no track has been
+     * loaded, or `canPlayPause` is false.
+     */
+    pause(): void;
+    /**
+     * Instructs the group to seek to a new position within the current track.
+     *
+     * @remarks
+     * Throws an exception if the session/coordinator hasn't been initialized, no track has been
+     * loaded, or `canSeek` is false.
+     * @param time Playback position in seconds to seek to.
+     */
+    seekTo(time: number): void;
+    /**
+     * Instructs the group to load a new track.
+     *
+     * @remarks
+     * Throws an exception if the session/coordinator hasn't been initialized or `canSetTrack` is
+     * false.
+     * @param metadata The track to load or `null` to indicate that the end of the track is reached.
+     * @param waitPoints Optional. List of static wait points to configure for the track.  Dynamic wait points can be added via the `beginSuspension()` call.
+     */
+    setTrack(metadata: ExtendedMediaMetadata | null, waitPoints?: CoordinationWaitPoint[]): void;
+    /**
+     * Updates the track data object for the current track.
+     *
+     * @remarks
+     * The track data object can be used by applications to synchronize things like pitch, roll,
+     * and yaw of a 360 video. This data object will be reset to null anytime the track changes.
+     *
+     * Throws an exception if the session/coordinator hasn't been initialized or `canSetTrackData` is
+     * false.
+     * @param data New data object to sync with the group. This value will be synchronized using a last writer wins strategy.
+     */
+    setTrackData(data: object | null): void;
+    /**
+     * Begins a new local suspension.
+     *
+     * @remarks
+     * Suspension temporarily suspend the clients local synchronization with the group. This can
+     * be useful for displaying ads to users or temporarily disconnecting from the session while
+     * the user seeks the video using a timeline scrubber.
+     *
+     * Multiple simultaneous suspensions are allowed and when the last suspension ends the local
+     * client will be immediately re-synchronized with the group.
+     *
+     * A "Dynamic Wait Point" can be specified when `beginSuspension()` is called and the wait
+     * point will be broadcast to all other clients in the group.  Those clients will then
+     * automatically enter a suspension state once they reach the positions specified by the
+     * wait point. Clients that are passed the wait point will immediately suspend.
+     *
+     * Any wait point based suspension (dynamic or static) will result in all clients remaining
+     * in a suspension state until the list client ends their suspension. This behavior can be
+     * conditionally bypassed by settings the wait points `maxClients` value.
+     *
+     * Throws an exception if the session/coordinator hasn't been initialized.
+     * @param waitPoint Optional. Dynamic wait point to broadcast to all of the clients.
+     * @returns The suspension object. Call `end()` on the returned suspension to end the suspension.
+     */
+    beginSuspension(waitPoint?: CoordinationWaitPoint): MediaSessionCoordinatorSuspension;
+    /**
+     * @hidden
+     * Called by MediaSession to verify the coordinator has been initialized.
+     */
+    get isInitialized(): boolean;
+    /**
+     * @hidden
+     * Called by MediaSession to start coordinator.
+     */
+    initialize(acceptTransportChangesFrom?: UserMeetingRole[]): Promise<void>;
+    /**
+     * @hidden
+     * Called by the MediaSession to detect if a wait point has been hit.
+     */
+    findNextWaitPoint(): CoordinationWaitPoint | null;
+    /**
+     * @hidden
+     * Called by MediaSession to trigger the sending of a position update.
+     */
+    sendPositionUpdate(state: IMediaPlayerState): void;
+    protected createChildren(acceptTransportChangesFrom?: UserMeetingRole[]): Promise<void>;
+    private getPlayerPosition;
+}
+//# sourceMappingURL=EphemeralMediaSessionCoordinator.d.ts.map

package/bin/EphemeralMediaSessionCoordinator.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"EphemeralMediaSessionCoordinator.d.ts","sourceRoot":"","sources":["../src/EphemeralMediaSessionCoordinator.ts"],"names":[],"mappings":"AAAA;;;GAGG;;AAEH,OAAO,EAAwF,gBAAgB,EAAgB,eAAe,EAAE,MAAM,uBAAuB,CAAC;AAC9K,OAAO,EAAE,qBAAqB,EAAqC,qBAAqB,EAAE,iCAAiC,EAA+D,iCAAiC,EAAE,MAAM,0BAA0B,CAAC;AAG9P,OAAO,YAAY,MAAM,QAAQ,CAAC;AAElC;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAC9B;;OAEG;IACH,QAAQ,EAAE,qBAAqB,GAAC,IAAI,CAAC;IAErC;;;;;OAKG;IACH,SAAS,EAAE,MAAM,GAAC,IAAI,CAAC;IAEvB;;OAEG;IACH,aAAa,EAAE,iCAAiC,CAAC;IAEjD;;OAEG;IACH,aAAa,CAAC,EAAE,kBAAkB,CAAC;CACtC;AAED;;;;GAIG;AACH,qBAAa,gCAAiC,SAAQ,YAAY;IAC9D,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAmB;IAC5C,OAAO,CAAC,QAAQ,CAAC,OAAO,CAA2B;IACnD,OAAO,CAAC,QAAQ,CAAC,eAAe,CAA0B;IAC1D,OAAO,CAAC,uBAAuB,CAA0B;IACzD,OAAO,CAAC,iBAAiB,CAA0B;IACnD,OAAO,CAAC,cAAc,CAAC,CAAwB;IAC/C,OAAO,CAAC,eAAe,CAAS;IAGhC,OAAO,CAAC,UAAU,CAAC,CAA+C;IAClE,OAAO,CAAC,WAAW,CAAC,CAA+C;IACnE,OAAO,CAAC,YAAY,CAAC,CAA+C;IACpE,OAAO,CAAC,cAAc,CAAC,CAAuC;IAC9D,OAAO,CAAC,kBAAkB,CAAC,CAA2C;IACtE,OAAO,CAAC,oBAAoB,CAAC,CAA6C;IAC1E,OAAO,CAAC,YAAY,CAAC,CAAwC;IAG7D,OAAO,CAAC,WAAW,CAAC,CAAwB;IAE5C;;;OAGG;gBACS,OAAO,EAAE,gBAAgB,EAAE,cAAc,EAAE,MAAM,iBAAiB;IAQ9E;;;;;;;;;;OAUG;IACI,YAAY,EAAE,OAAO,CAAQ;IAEpC;;;;;;;;;;;OAWG;IACI,OAAO,EAAE,OAAO,CAAQ;IAE/B;;;;;;;;;;OAUG;IACI,WAAW,EAAE,OAAO,CAAQ;IAEnC;;;;;;;;;;;OAWG;IACI,eAAe,EAAE,OAAO,CAAQ;IAEvC;;OAEG;IACH,IAAW,WAAW,IAAI,OAAO,CAEhC;IAED;;;;;;;;OAQG;IACH,IAAW,gBAAgB,IAAI,MAAM,CAEpC;IAED,IAAW,gBAAgB,CAAC,KAAK,EAAE,MAAM,EAExC;IAED;;;;;;OAMG;IACH,IAAW,sBAAsB,IAAI,MAAM,CAE1C;IAED,IAAW,sBAAsB,CAAC,KAAK,EAAE,MAAM,EAE9C;IAED;;;;;;OAMG;IACI,IAAI,IAAI,IAAI;IAwBnB;;;;;;OAMG;IACI,KAAK,IAAI,IAAI;IAwBpB;;;;;;;OAOG;IACI,MAAM,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI;IAqBjC;;;;;;;;OAQG;IACI,QAAQ,CAAC,QAAQ,EAAE,qBAAqB,GAAC,IAAI,EAAE,UAAU,CAAC,EAAE,qBAAqB,EAAE,GAAG,IAAI;IAiBjG;;;;;;;;;;OAUG;IACK,YAAY,CAAC,IAAI,EAAE,MAAM,GAAC,IAAI,GAAG,IAAI;IAgB7C;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACI,eAAe,CAAC,SAAS,CAAC,EAAE,qBAAqB,GAAG,iCAAiC;IAkC5F;;;OAGG;IACF,IAAW,aAAa,IAAI,OAAO,CAEnC;IAED;;;OAGG;IACU,UAAU,CAAC,0BAA0B,CAAC,EAAE,eAAe,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC;IAUtF;;;OAGG;IACI,iBAAiB,IAAI,qBAAqB,GAAC,IAAI;IAItD;;;OAGG;IACI,kBAAkB,CAAC,KAAK,EAAE,iBAAiB,GAAG,IAAI;cAUzC,cAAc,CAAC,0BAA0B,CAAC,EAAE,eAAe,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC;IAkC7F,OAAO,CAAC,iBAAiB;CAU5B"}