@microsoft/live-share-media 1.4.0 → 1.4.2

package/bin/esm/LiveMediaSession.d.ts

@@ -0,0 +1,97 @@
+/**
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the Microsoft Live Share SDK License.
+ */
+import { DataObjectFactory } from "@fluidframework/aqueduct/legacy";
+import { LiveTelemetryLogger, UserMeetingRole } from "@microsoft/live-share";
+import { LiveDataObject } from "@microsoft/live-share/internal";
+import { MediaPlayerSynchronizer } from "./MediaPlayerSynchronizer.js";
+import { ExtendedMediaSessionAction, ExtendedMediaSessionActionHandler } from "./MediaSessionExtensions.js";
+import { LiveMediaSessionCoordinator, IMediaPlayerState } from "./LiveMediaSessionCoordinator.js";
+import { MediaSessionActionThrottler } from "./MediaSessionActionThrottler.js";
+import { IMediaPlayer } from "./IMediaPlayer.js";
+import { SharedObjectKind } from "fluid-framework";
+/**
+ * Live fluid object that synchronizes media playback across multiple clients.
+ */
+export declare class LiveMediaSessionClass extends LiveDataObject {
+    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<LiveMediaSessionClass, import("@fluidframework/aqueduct/legacy").DataObjectTypes>;
+    /**
+     * Extension point that lets applications replace the default logic for throttling the sessions
+     * local sync behavior.
+     *
+     * @remarks
+     * The `LiveMediaCoordinator` 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);
+    /**
+     * The group coordinator for the session.
+     */
+    get coordinator(): LiveMediaSessionCoordinator;
+    /**
+     * Returns the logger used by the session and coordinator.
+     *
+     * @remarks
+     * This is used by the `MediaPlayerSynchronizer` to log events.
+     */
+    get logger(): LiveTelemetryLogger;
+    /**
+     * Initialize the object to begin sending/receiving group playback updates through this DDS.
+     *
+     * @param allowedRoles Optional. List of roles allowed to group transport operations like play/pause/seek/setTrack.
+     *
+     * @returns a void promise that resolves once complete.
+     *
+     * @throws error when `.initialize()` has already been called for this class instance.
+     */
+    initialize(allowedRoles?: 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: ExtendedMediaSessionActionHandler | 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;
+}
+/**
+ * Live fluid object that synchronizes media playback across multiple clients.
+ */
+export type LiveMediaSession = LiveMediaSessionClass;
+export declare const LiveMediaSession: typeof LiveMediaSessionClass & SharedObjectKind<LiveMediaSessionClass>;
+//# sourceMappingURL=LiveMediaSession.d.ts.map

package/bin/esm/LiveMediaSession.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"LiveMediaSession.d.ts","sourceRoot":"","sources":["../../src/LiveMediaSession.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,iBAAiB,EAAE,MAAM,iCAAiC,CAAC;AACpE,OAAO,EAGH,mBAAmB,EACnB,eAAe,EAClB,MAAM,uBAAuB,CAAC;AAC/B,OAAO,EAEH,cAAc,EACjB,MAAM,gCAAgC,CAAC;AACxC,OAAO,EAAE,uBAAuB,EAAE,MAAM,8BAA8B,CAAC;AAEvE,OAAO,EAEH,0BAA0B,EAE1B,iCAAiC,EACpC,MAAM,6BAA6B,CAAC;AACrC,OAAO,EACH,2BAA2B,EAC3B,iBAAiB,EACpB,MAAM,kCAAkC,CAAC;AAC1C,OAAO,EAAE,2BAA2B,EAAE,MAAM,kCAAkC,CAAC;AAE/E,OAAO,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AACjD,OAAO,EAAE,gBAAgB,EAAE,MAAM,iBAAiB,CAAC;AAGnD;;GAEG;AACH,qBAAa,qBAAsB,SAAQ,cAAc;IACrD,OAAO,CAAC,gBAAgB,CACU;IAClC,OAAO,CAAC,OAAO,CAAC,CAAsB;IACtC,OAAO,CAAC,0BAA0B,CAAC,CAA0B;IAC7D,OAAO,CAAC,YAAY,CAAC,CAA8B;IACnD,OAAO,CAAC,QAAQ,CAAC,eAAe,CAGlB;IACd,OAAO,CAAC,cAAc,CAAC,CAA0B;IAGjD,OAAO,CAAC,YAAY,CAAM;IAC1B,OAAO,CAAC,eAAe,CAAa;IAEpC;;OAEG;IACH,gBAAuB,QAAQ,+CAA+C;IAE9E;;OAEG;IACH,gBAAuB,OAAO,sGAK5B;IAEF;;;;;;;;;;;;OAYG;IACH,IAAW,eAAe,IAAI,2BAA2B,CAExD;IAED,IAAW,eAAe,CAAC,KAAK,EAAE,2BAA2B,EAE5D;IAED;;OAEG;IACH,IAAW,WAAW,IAAI,2BAA2B,CAEpD;IAED;;;;;OAKG;IACH,IAAW,MAAM,IAAI,mBAAmB,CAEvC;IAED;;;;;;;;OAQG;IACU,UAAU,CAAC,YAAY,CAAC,EAAE,eAAe,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC;IAqBxE;;;;OAIG;IACI,gBAAgB,CACnB,MAAM,EAAE,0BAA0B,EAClC,OAAO,EACD,iCAAiC,GACjC,yBAAyB,GACzB,IAAI,GACX,IAAI;IAUP;;;OAGG;IACI,4BAA4B,CAAC,OAAO,EAAE,MAAM,iBAAiB;IAIpE;;;;OAIG;IACI,WAAW,CAAC,MAAM,EAAE,YAAY,GAAG,uBAAuB;cAoCjD,cAAc,IAAI,OAAO,CAAC,IAAI,CAAC;IAwF/C,OAAO,CAAC,iBAAiB;IAgCzB,OAAO,CAAC,qBAAqB;IAU7B,OAAO,CAAC,cAAc;CAQzB;AAED;;GAEG;AACH,MAAM,MAAM,gBAAgB,GAAG,qBAAqB,CAAC;AAGrD,eAAO,MAAM,gBAAgB,wEAGzB,CAAC"}

package/bin/esm/LiveMediaSession.js

@@ -0,0 +1,257 @@
+/**
+ * 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());
+    });
+};
+import { DataObjectFactory } from "@fluidframework/aqueduct/legacy";
+import { LiveDataObjectInitializeNotNeededError, LiveDataObjectInitializeState, LiveTelemetryLogger, } from "@microsoft/live-share";
+import { DynamicObjectRegistry, LiveDataObject, } from "@microsoft/live-share/internal";
+import { MediaPlayerSynchronizer } from "./MediaPlayerSynchronizer.js";
+import { MediaSessionCoordinatorEvents, } from "./MediaSessionExtensions.js";
+import { LiveMediaSessionCoordinator, } from "./LiveMediaSessionCoordinator.js";
+import { RepeatedActionThrottler } from "./RepeatedActionThrottler.js";
+import { TelemetryEvents } from "./internals/consts.js";
+/**
+ * Live fluid object that synchronizes media playback across multiple clients.
+ */
+export class LiveMediaSessionClass extends LiveDataObject {
+    constructor() {
+        super(...arguments);
+        this._actionThrottler = new 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 `LiveMediaCoordinator` 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;
+    }
+    /**
+     * 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 to begin sending/receiving group playback updates through this DDS.
+     *
+     * @param allowedRoles Optional. List of roles allowed to group transport operations like play/pause/seek/setTrack.
+     *
+     * @returns a void promise that resolves once complete.
+     *
+     * @throws error when `.initialize()` has already been called for this class instance.
+     */
+    initialize(allowedRoles) {
+        return __awaiter(this, void 0, void 0, function* () {
+            LiveDataObjectInitializeNotNeededError.assert("LiveMediaSession:initialize", this.initializeState);
+            // Update initialize state as pending
+            this.initializeState = LiveDataObjectInitializeState.pending;
+            if (allowedRoles) {
+                this._allowedRoles = allowedRoles;
+            }
+            try {
+                yield this.coordinator.initialize(allowedRoles);
+            }
+            catch (error) {
+                this.initializeState = LiveDataObjectInitializeState.needed;
+                throw error;
+            }
+            // Update initialize state as succeeded
+            this.initializeState = LiveDataObjectInitializeState.succeeded;
+        });
+    }
+    /**
+     * 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(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(player, this, this.runtime, () => {
+            this._synchronizing = undefined;
+        });
+    }
+    hasInitialized() {
+        return __awaiter(this, void 0, void 0, function* () {
+            this._logger = new LiveTelemetryLogger(this.runtime, this.liveRuntime);
+            // Create coordinator and listen for triggered actions
+            this._coordinator = new LiveMediaSessionCoordinator(this.id, this.runtime, this.liveRuntime, () => this.getCurrentPlayerState());
+            this._coordinator.on(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(TelemetryEvents.MediaSession.PlayAction, null, {
+                            position: seekTime,
+                        });
+                        break;
+                    case "pause":
+                        this.logger.sendTelemetryEvent(TelemetryEvents.MediaSession.PauseAction, null, {
+                            position: seekTime,
+                        });
+                        break;
+                    case "ratechange":
+                        if (!details.playbackRate) {
+                            break;
+                        }
+                        this.logger.sendTelemetryEvent(TelemetryEvents.MediaSession.RateChangeAction, null, {
+                            playbackRate: details.playbackRate,
+                        });
+                        break;
+                    case "seekto":
+                        this.logger.sendTelemetryEvent(TelemetryEvents.MediaSession.SeekToAction, null, {
+                            position: seekTime,
+                        });
+                        break;
+                    case "settrack":
+                        this.logger.sendTelemetryEvent(TelemetryEvents.MediaSession.SetTrackAction);
+                        break;
+                    case "datachange":
+                        this.logger.sendTelemetryEvent(TelemetryEvents.MediaSession.DataChangeAction);
+                        break;
+                    case "catchup":
+                        // Default to seekto if catchup not implemented
+                        this.logger.sendTelemetryEvent(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(`LiveMediaSession:checkWaitPointHit - wait point hit but no 'wait' action registered.\nTo fix this error, set a \`wait\` action using the \`setActionHandler()\` function.`);
+                }
+                // Begin suspension for wait point
+                this.waitUntilConnected().then((clientId) => {
+                    const suspension = this.coordinator.beginSuspension(waitPoint);
+                    this.dispatchAction({
+                        action: "wait",
+                        source: "system",
+                        clientId,
+                        local: true,
+                        suspension,
+                    });
+                });
+            }
+        }
+    }
+    getCurrentPlayerState() {
+        if (!this._requestPlayerStateHandler) {
+            throw new Error("LiveMediaSession:getCurrentPlayerState - no `requestPlayerStateHandler` callback configured.\nTo fix this error, ensure `setRequestPlayerStateHandler()` has been set with a delegate to retrieve your player's state, or use the `synchronize()` function to create a new `MediaPlayerSynchronizer` instance tied to your `IMediaPlayer` instance.");
+        }
+        return this._requestPlayerStateHandler();
+    }
+    dispatchAction(details) {
+        if (this._actionHandlers.has(details.action)) {
+            const handler = this._actionHandlers.get(details.action);
+            this._actionThrottler.throttled(details, handler);
+        }
+    }
+}
+/**
+ * The objects fluid type name.
+ */
+LiveMediaSessionClass.TypeName = `@microsoft/fluid-media:SharedMediaSession`;
+/**
+ * The objects fluid type factory.
+ */
+LiveMediaSessionClass.factory = new DataObjectFactory(LiveMediaSessionClass.TypeName, LiveMediaSessionClass, [], {});
+// eslint-disable-next-line no-redeclare
+export const LiveMediaSession = (() => {
+    const kind = LiveMediaSessionClass;
+    return kind;
+})();
+/**
+ * Register `LiveMediaSession` as an available `SharedObjectKind` for use in dynamic object loading.
+ */
+DynamicObjectRegistry.registerObjectClass(LiveMediaSession, LiveMediaSession.TypeName);
+//# sourceMappingURL=LiveMediaSession.js.map

package/bin/esm/LiveMediaSession.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"LiveMediaSession.js","sourceRoot":"","sources":["../../src/LiveMediaSession.ts"],"names":[],"mappings":"AAAA;;;GAGG;;;;;;;;;;AAEH,OAAO,EAAE,iBAAiB,EAAE,MAAM,iCAAiC,CAAC;AACpE,OAAO,EACH,sCAAsC,EACtC,6BAA6B,EAC7B,mBAAmB,GAEtB,MAAM,uBAAuB,CAAC;AAC/B,OAAO,EACH,qBAAqB,EACrB,cAAc,GACjB,MAAM,gCAAgC,CAAC;AACxC,OAAO,EAAE,uBAAuB,EAAE,MAAM,8BAA8B,CAAC;AAEvE,OAAO,EACH,6BAA6B,GAIhC,MAAM,6BAA6B,CAAC;AACrC,OAAO,EACH,2BAA2B,GAE9B,MAAM,kCAAkC,CAAC;AAE1C,OAAO,EAAE,uBAAuB,EAAE,MAAM,8BAA8B,CAAC;AAGvE,OAAO,EAAE,eAAe,EAAE,MAAM,uBAAuB,CAAC;AAExD;;GAEG;AACH,MAAM,OAAO,qBAAsB,SAAQ,cAAc;IAAzD;;QACY,qBAAgB,GACpB,IAAI,uBAAuB,EAAE,CAAC;QAIjB,oBAAe,GAG5B,IAAI,GAAG,EAAE,CAAC;QAKN,oBAAe,GAAW,CAAC,CAAC;IAqSxC,CAAC;IApRG;;;;;;;;;;;;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,WAAW;QAClB,OAAO,IAAI,CAAC,YAAa,CAAC;IAC9B,CAAC;IAED;;;;;OAKG;IACH,IAAW,MAAM;QACb,OAAO,IAAI,CAAC,OAAQ,CAAC;IACzB,CAAC;IAED;;;;;;;;OAQG;IACU,UAAU,CAAC,YAAgC;;YACpD,sCAAsC,CAAC,MAAM,CACzC,6BAA6B,EAC7B,IAAI,CAAC,eAAe,CACvB,CAAC;YACF,qCAAqC;YACrC,IAAI,CAAC,eAAe,GAAG,6BAA6B,CAAC,OAAO,CAAC;YAC7D,IAAI,YAAY,EAAE,CAAC;gBACf,IAAI,CAAC,aAAa,GAAG,YAAY,CAAC;YACtC,CAAC;YACD,IAAI,CAAC;gBACD,MAAM,IAAI,CAAC,WAAW,CAAC,UAAU,CAAC,YAAY,CAAC,CAAC;YACpD,CAAC;YAAC,OAAO,KAAc,EAAE,CAAC;gBACtB,IAAI,CAAC,eAAe,GAAG,6BAA6B,CAAC,MAAM,CAAC;gBAC5D,MAAM,KAAK,CAAC;YAChB,CAAC;YAED,uCAAuC;YACvC,IAAI,CAAC,eAAe,GAAG,6BAA6B,CAAC,SAAS,CAAC;QACnE,CAAC;KAAA;IAED;;;;OAIG;IACI,gBAAgB,CACnB,MAAkC,EAClC,OAGU;QAEV,IAAI,OAAO,EAAE,CAAC;YACV,cAAc;YACd,IAAI,CAAC,eAAe,CAAC,GAAG,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;QAC9C,CAAC;aAAM,IAAI,IAAI,CAAC,eAAe,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,CAAC;YAC1C,iBAAiB;YACjB,IAAI,CAAC,eAAe,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;QACxC,CAAC;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,CAAC;YACtB,IAAI,CAAC,cAAc,CAAC,GAAG,EAAE,CAAC;QAC9B,CAAC;QAED,8BAA8B;QAC9B,IAAI,CAAC,IAAI,CAAC,YAAY,EAAE,CAAC;YACrB,IAAI,CAAC,MAAM,CAAC,kBAAkB,CAC1B,eAAe,CAAC,YAAY,CAAC,wBAAwB,CACxD,CAAC;YACF,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,IACI,IAAI,CAAC,WAAW,CAAC,aAAa;oBAC9B,KAAK,IAAI,IAAI,CAAC,WAAW,CAAC,sBAAsB,EAClD,CAAC;oBACC,IAAI,CAAC,eAAe,GAAG,GAAG,CAAC;oBAC3B,IAAI,CAAC,WAAW,CAAC,kBAAkB,CAAC,KAAK,CAAC,CAAC;gBAC/C,CAAC;YACL,CAAC,EAAE,GAAG,CAAC,CAAC;QACZ,CAAC;QAED,OAAO,IAAI,uBAAuB,CAAC,MAAM,EAAE,IAAI,EAAE,IAAI,CAAC,OAAO,EAAE,GAAG,EAAE;YAChE,IAAI,CAAC,cAAc,GAAG,SAAS,CAAC;QACpC,CAAC,CAAC,CAAC;IACP,CAAC;IAEe,cAAc;;YAC1B,IAAI,CAAC,OAAO,GAAG,IAAI,mBAAmB,CAAC,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC;YAEvE,sDAAsD;YACtD,IAAI,CAAC,YAAY,GAAG,IAAI,2BAA2B,CAC/C,IAAI,CAAC,EAAE,EACP,IAAI,CAAC,OAAO,EACZ,IAAI,CAAC,WAAW,EAChB,GAAG,EAAE,CAAC,IAAI,CAAC,qBAAqB,EAAE,CACrC,CAAC;YACF,IAAI,CAAC,YAAY,CAAC,EAAE,CAChB,6BAA6B,CAAC,aAAa,EAC3C,CAAC,KAA0B,EAAE,EAAE;gBAC3B,sBAAsB;gBACtB,MAAM,OAAO,GAAG,KAAK,CAAC,OAAO,CAAC;gBAC9B,MAAM,QAAQ,GACV,OAAO,OAAO,CAAC,QAAQ,IAAI,QAAQ,CAAC,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;gBAChE,QAAQ,OAAO,CAAC,MAAM,EAAE,CAAC;oBACrB,KAAK,MAAM;wBACP,IAAI,CAAC,MAAM,CAAC,kBAAkB,CAC1B,eAAe,CAAC,YAAY,CAAC,UAAU,EACvC,IAAI,EACJ;4BACI,QAAQ,EAAE,QAAQ;yBACrB,CACJ,CAAC;wBACF,MAAM;oBACV,KAAK,OAAO;wBACR,IAAI,CAAC,MAAM,CAAC,kBAAkB,CAC1B,eAAe,CAAC,YAAY,CAAC,WAAW,EACxC,IAAI,EACJ;4BACI,QAAQ,EAAE,QAAQ;yBACrB,CACJ,CAAC;wBACF,MAAM;oBACV,KAAK,YAAY;wBACb,IAAI,CAAC,OAAO,CAAC,YAAY,EAAE,CAAC;4BACxB,MAAM;wBACV,CAAC;wBACD,IAAI,CAAC,MAAM,CAAC,kBAAkB,CAC1B,eAAe,CAAC,YAAY,CAAC,gBAAgB,EAC7C,IAAI,EACJ;4BACI,YAAY,EAAE,OAAO,CAAC,YAAY;yBACrC,CACJ,CAAC;wBACF,MAAM;oBACV,KAAK,QAAQ;wBACT,IAAI,CAAC,MAAM,CAAC,kBAAkB,CAC1B,eAAe,CAAC,YAAY,CAAC,YAAY,EACzC,IAAI,EACJ;4BACI,QAAQ,EAAE,QAAQ;yBACrB,CACJ,CAAC;wBACF,MAAM;oBACV,KAAK,UAAU;wBACX,IAAI,CAAC,MAAM,CAAC,kBAAkB,CAC1B,eAAe,CAAC,YAAY,CAAC,cAAc,CAC9C,CAAC;wBACF,MAAM;oBACV,KAAK,YAAY;wBACb,IAAI,CAAC,MAAM,CAAC,kBAAkB,CAC1B,eAAe,CAAC,YAAY,CAAC,gBAAgB,CAChD,CAAC;wBACF,MAAM;oBACV,KAAK,SAAS;wBACV,+CAA+C;wBAC/C,IAAI,CAAC,MAAM,CAAC,kBAAkB,CAC1B,eAAe,CAAC,YAAY,CAAC,aAAa,EAC1C,IAAI,EACJ;4BACI,QAAQ,EAAE,QAAQ;yBACrB,CACJ,CAAC;wBACF,IAAI,CAAC,IAAI,CAAC,eAAe,CAAC,GAAG,CAAC,SAAS,CAAC,EAAE,CAAC;4BACvC,OAAO,CAAC,MAAM,GAAG,QAAQ,CAAC;wBAC9B,CAAC;wBACD,MAAM;gBACd,CAAC;gBAED,kBAAkB;gBAClB,IAAI,CAAC,cAAc,CAAC,OAAO,CAAC,CAAC;YACjC,CAAC,CACJ,CAAC;QACN,CAAC;KAAA;IAEO,iBAAiB,CAAC,KAAwB;QAC9C,wBAAwB;QACxB,IAAI,KAAK,CAAC,aAAa,IAAI,IAAI,CAAC,WAAW,CAAC,aAAa,EAAE,CAAC;YACxD,MAAM,SAAS,GAAG,IAAI,CAAC,WAAW,CAAC,iBAAiB,EAAE,CAAC;YACvD,IACI,SAAS;gBACT,KAAK,CAAC,aAAa,CAAC,QAAQ,IAAI,SAAS;gBACzC,KAAK,CAAC,aAAa,CAAC,QAAQ,IAAI,SAAS,CAAC,QAAQ,EACpD,CAAC;gBACC,4BAA4B;gBAC5B,IAAI,CAAC,IAAI,CAAC,eAAe,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,CAAC;oBACpC,MAAM,IAAI,KAAK,CACX,2KAA2K,CAC9K,CAAC;gBACN,CAAC;gBAED,kCAAkC;gBAClC,IAAI,CAAC,kBAAkB,EAAE,CAAC,IAAI,CAAC,CAAC,QAAgB,EAAE,EAAE;oBAChD,MAAM,UAAU,GACZ,IAAI,CAAC,WAAW,CAAC,eAAe,CAAC,SAAS,CAAC,CAAC;oBAChD,IAAI,CAAC,cAAc,CAAC;wBAChB,MAAM,EAAE,MAAM;wBACd,MAAM,EAAE,QAAQ;wBAChB,QAAQ;wBACR,KAAK,EAAE,IAAI;wBACX,UAAU;qBACb,CAAC,CAAC;gBACP,CAAC,CAAC,CAAC;YACP,CAAC;QACL,CAAC;IACL,CAAC;IAEO,qBAAqB;QACzB,IAAI,CAAC,IAAI,CAAC,0BAA0B,EAAE,CAAC;YACnC,MAAM,IAAI,KAAK,CACX,qVAAqV,CACxV,CAAC;QACN,CAAC;QAED,OAAO,IAAI,CAAC,0BAA0B,EAAE,CAAC;IAC7C,CAAC;IAEO,cAAc,CAClB,OAAsE;QAEtE,IAAI,IAAI,CAAC,eAAe,CAAC,GAAG,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC;YAC3C,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;QACtD,CAAC;IACL,CAAC;;AAlSD;;GAEG;AACoB,8BAAQ,GAAG,2CAA2C,AAA9C,CAA+C;AAE9E;;GAEG;AACoB,6BAAO,GAAG,IAAI,iBAAiB,CAClD,qBAAqB,CAAC,QAAQ,EAC9B,qBAAqB,EACrB,EAAE,EACF,EAAE,CACL,AAL6B,CAK5B;AA6RN,wCAAwC;AACxC,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAAC,GAAG,EAAE;IAClC,MAAM,IAAI,GAAG,qBAAqB,CAAC;IACnC,OAAO,IAA6D,CAAC;AACzE,CAAC,CAAC,EAAE,CAAC;AAEL;;GAEG;AACH,qBAAqB,CAAC,mBAAmB,CACrC,gBAAgB,EAChB,gBAAgB,CAAC,QAAQ,CAC5B,CAAC"}

package/bin/esm/LiveMediaSessionCoordinator.d.ts

@@ -0,0 +1,304 @@
+/**
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the Microsoft Live Share SDK License.
+ */
+import { UserMeetingRole } from "@microsoft/live-share";
+import { IRuntimeSignaler, LiveShareRuntime } from "@microsoft/live-share/internal";
+import { CoordinationWaitPoint, ExtendedMediaMetadata, ExtendedMediaSessionPlaybackState, MediaSessionCoordinatorSuspension } from "./MediaSessionExtensions.js";
+import { TypedEventEmitter } from "@fluid-internal/client-utils";
+import { IEvent } from "@fluidframework/core-interfaces";
+/**
+ * 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;
+}
+/**
+ * @hidden
+ */
+export interface ILiveMediaSessionCoordinatorEvents extends IEvent {
+    /**
+     * Event listener for events emitted
+     * @param event update
+     * @param listener listener function
+     * @param listener.event the event instance
+     */
+    (event: string, listener: (event: any) => void): void;
+}
+/**
+ * The `LiveMediaSessionCoordinator` 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 LiveMediaSessionCoordinator extends TypedEventEmitter<ILiveMediaSessionCoordinatorEvents> {
+    private readonly _id;
+    private readonly _runtime;
+    private readonly _liveRuntime;
+    private readonly _logger;
+    private readonly _getPlayerState;
+    private _positionUpdateInterval;
+    private _maxPlaybackDrift;
+    private _lastWaitPoint?;
+    private initializeState;
+    private _playEvent?;
+    private _pauseEvent?;
+    private _seekToEvent?;
+    private _rateChangeEvent?;
+    private _setTrackEvent?;
+    private _setTrackDataEvent?;
+    private _positionUpdateEvent?;
+    private _synchronizer?;
+    private _groupState?;
+    /**
+     * @hidden
+     * Applications shouldn't directly create new coordinator instances.
+     */
+    constructor(id: string, runtime: IRuntimeSignaler, liveRuntime: LiveShareRuntime, 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;
+    /**
+     * Controls whether or not the local client is allowed to change the playback rate.
+     *
+     * @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.
+     */
+    canSetPlaybackRate: boolean;
+    /**
+     * Controls whether or not the local client is allowed to send position updates to the group.
+     *
+     * @remarks
+     * This flag largely meant to limit the number of signals sent to the group for performance reasons.
+     * It does not provide any security in itself.
+     */
+    canSendPositionUpdates: boolean;
+    /**
+     * Returns true if the local client is in a suspended state.
+     */
+    get isSuspended(): boolean;
+    /**
+     * Controls whether or not to scale {@link maxPlaybackDrift} by the number of users in the session.
+     *
+     * @remarks
+     * As more clients join a session, it is more likely that some users will fall behind the presenter.
+     * It is also less likely that users will notice drift as more clients are added.
+     * It is usually helpful to be more lenient as more clients are added so everyone can watch all the content.
+     * Default value is true.
+     */
+    get shouldScaleMaxPlaybackDrift(): boolean;
+    set shouldScaleMaxPlaybackDrift(value: boolean);
+    /**
+     * Max amount of playback drift allowed in seconds.
+     * This will scale automatically according to the number of participants in the session when {@link shouldScaleMaxPlaybackDrift} is true.
+     *
+     * @remarks
+     * Should the local clients playback position lag by more than the specified value, the coordinator will trigger a `catchup` action.
+     * Default value is `1.5` seconds.
+     */
+    get maxPlaybackDrift(): number;
+    set maxPlaybackDrift(value: number);
+    /**
+     * Controls whether or not to compute {@link positionUpdateInterval} based on whether user has initiated a playback command.
+     * Default value is true.
+     *
+     * @remarks
+     * When true, users that are simply watching but not controlling playback will report their positions less frequently.
+     * When a user has sent a transport command, they will begin sending position updates more frequently.
+     * Most Live Share apps have a concept of a primary presenter, and don't allow anyone to pause/play for the group.
+     * By ensuring only one/few users broadcast updates frequently, the server load is reduced considerably.
+     */
+    get shouldScalePositionUpdateInterval(): boolean;
+    set shouldScalePositionUpdateInterval(value: boolean);
+    /**
+     * Frequency with which position updates are broadcast to the rest of the group in seconds.
+     * When {@link shouldScalePositionUpdateInterval} is set to `true`, the value set is the minimum value.
+     * The value returned is the actual value used to send updates by the local user, which may be larger than the value set.
+     *
+     * @remarks
+     * Defaults to a minimum 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.
+     *
+     * @returns a void promise that resolves once complete, throws if user does not have proper roles
+     */
+    play(): Promise<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.
+     *
+     * @returns a void promise that resolves once complete, throws if user does not have proper roles
+     */
+    pause(): Promise<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.
+     * @returns a void promise that resolves once complete, throws if user does not have proper roles
+     */
+    seekTo(time: number): Promise<void>;
+    /**
+     * Sets the playback rate for everyone in the session.
+     *
+     * @param playbackRate the playback rate to set.
+     *
+     * @throws
+     * Throws an exception if the session/coordinator hasn't been initialized or {@link canSetPlaybackRate} is false.
+     */
+    setPlaybackRate(playbackRate: number): Promise<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.
+     * @returns a void promise that resolves once complete, throws if user does not have proper roles
+     */
+    setTrack(metadata: ExtendedMediaMetadata | null, waitPoints?: CoordinationWaitPoint[]): Promise<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.
+     * @returns a void promise that resolves once complete, throws if user does not have proper roles
+     */
+    setTrackData(data: object | null): Promise<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, targetClientId?: string): void;
+    protected createChildren(acceptTransportChangesFrom?: UserMeetingRole[]): Promise<void>;
+    private getPlayerPosition;
+}
+//# sourceMappingURL=LiveMediaSessionCoordinator.d.ts.map