@microsoft/live-share-media 1.4.0 → 2.0.0-internal.10

package/README.md

@@ -35,15 +35,15 @@ This will use npm workspaces to hoist and build all dependencies.
 
 ```html
 <body>
-  <video id="player">
-    <source src="YOUR_VIDEO_SRC" type="video/mp4" />
-  </video>
-  <div class="player-controls">
-    <button id="play-button">Play</button>
-    <button id="pause-button">Pause</button>
-    <button id="restart-button">Restart</button>
-    <button id="change-track-button">Change track</button>
-  </div>
+    <video id="player">
+        <source src="YOUR_VIDEO_SRC" type="video/mp4" />
+    </video>
+    <div class="player-controls">
+        <button id="play-button">Play</button>
+        <button id="pause-button">Pause</button>
+        <button id="restart-button">Restart</button>
+        <button id="change-track-button">Change track</button>
+    </div>
 </body>
 ```
 
@@ -58,14 +58,12 @@ await microsoftTeams.app.initialize();
 // Setup the Fluid container
 const host = LiveShareHost.create();
 const client = new LiveShareClient(host);
-const schema = {
-  initialObjects: {
-    mediaSession: LiveMediaSession,
-    ...,
-  },
-};
-const { container } = await client.joinContainer(schema);
-const { mediaSession } = container.initialObjects;
+await client.join();
+
+const mediaSession =
+    (await client.getDDS) <
+    LiveMediaSession >
+    ("media-session-id", LiveMediaSession);
 
 // Get the player from your document and create synchronizer
 const player = document.getElementById("player");
@@ -78,21 +76,21 @@ await mediaSession.initialize(allowedRoles);
 // Intercept user play, pause, seek, and set track actions through synchronizer
 
 document.getElementById("play-button").onclick = () => {
-  synchronizer.play();
+    synchronizer.play();
 };
 
 document.getElementById("pause-button").onclick = () => {
-  synchronizer.pause();
+    synchronizer.pause();
 };
 
 document.getElementById("restart-button").onclick = () => {
-  synchronizer.seekTo(0);
+    synchronizer.seekTo(0);
 };
 
 document.getElementById("change-track-button").onclick = () => {
-  synchronizer.setTrack({
-    trackIdentifier: "SOME_OTHER_VIDEO_SRC",
-  });
+    synchronizer.setTrack({
+        trackIdentifier: "SOME_OTHER_VIDEO_SRC",
+    });
 };
 ```
 
@@ -102,7 +100,7 @@ There are several code samples that are hosted in a separate GitHub repository.
 
 | Sample name          | Description                                                                                                                               | Javascript                                     |
 | -------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------- |
-| React Video          | Basic example showing how the LiveMediaSession object works with HTML5 video.                                                        | [View](https://aka.ms/liveshare-reactvideo)    |
+| React Video          | Basic example showing how the LiveMediaSession object works with HTML5 video.                                                             | [View](https://aka.ms/liveshare-reactvideo)    |
 | React Media Template | Enable all connected clients to watch videos together, build a shared playlist, transfer whom is in control, and annotate over the video. | [View](https://aka.ms/liveshare-mediatemplate) |
 
 ## Package Compatibility
@@ -111,18 +109,19 @@ 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-\*   | @fluidframework/azure-client | @microsoft/TeamsFx              | @microsoft/TeamsFx-react        |
-| --------------------- | -------------------- | --------------- | -------------------------- | ---------------------------- | ------------------------------- | ------------------------------- |
-| ^1.0.0                  | ^2.11.0             | ^1.2.3          | ^1.0.0                      | ^1.0.0                       | ^2.5.0                        | ^2.5.0                          |
+| @microsoft/live-share | @microsoft/teams-js | fluid-framework | @microsoft/live-share-\* | @fluidframework/azure-client | @microsoft/TeamsFx | @microsoft/TeamsFx-react |
+| --------------------- | ------------------- | --------------- | ------------------------ | ---------------------------- | ------------------ | ------------------------ |
+| ^2.0.0                | ^2.11.0             | ^2.0.0          | ^2.0.0                   | ^2.0.0                       | ^2.5.0             | ^2.5.0                   |
+| ^1.0.0                | ^2.11.0             | ^1.2.3          | ^1.0.0                   | ^1.0.0                       | ^2.5.0             | ^2.5.0                   |
 
 ## Contributing
 
 There are several ways you can [contribute](../../CONTRIBUTING.md) to this project:
 
-- [Submit bugs](https://github.com/microsoft/live-share-sdk/issues) and help us verify fixes as they are checked in.
-- Review the source code changes.
-- Engage with other Live Share developers on [StackOverflow](https://stackoverflow.com/questions/tagged/live-share).
-- [Contribute bug fixes](../../CONTRIBUTING.md).
+-   [Submit bugs](https://github.com/microsoft/live-share-sdk/issues) and help us verify fixes as they are checked in.
+-   Review the source code changes.
+-   Engage with other Live Share developers on [StackOverflow](https://stackoverflow.com/questions/tagged/live-share).
+-   [Contribute bug fixes](../../CONTRIBUTING.md).
 
 This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/). For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or contact <opencode@microsoft.com> with any additional questions or comments.
 

package/bin/cjs/IMediaPlayer.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"IMediaPlayer.d.ts","sourceRoot":"","sources":["../../src/IMediaPlayer.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,MAAM,WAAW,YAAY;IACzB,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAC;IAC5B,WAAW,EAAE,MAAM,CAAC;IACpB,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;IAC1B,QAAQ,CAAC,KAAK,EAAE,OAAO,CAAC;IACxB,KAAK,EAAE,OAAO,CAAC;IACf,QAAQ,CAAC,MAAM,EAAE,OAAO,CAAC;IACzB,YAAY,EAAE,MAAM,CAAC;IACrB,GAAG,EAAE,MAAM,CAAC;IACZ,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,IAAI,IAAI,CAAC;IACb,KAAK,IAAI,IAAI,CAAC;IACd,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IACtB,gBAAgB,CACZ,IAAI,EAAE,MAAM,EACZ,QAAQ,EAAE,kCAAkC,EAC5C,OAAO,CAAC,EAAE,OAAO,GAAG,uBAAuB,GAC5C,IAAI,CAAC;IACR,mBAAmB,CACf,IAAI,EAAE,MAAM,EACZ,QAAQ,EAAE,kCAAkC,EAC5C,OAAO,CAAC,EAAE,OAAO,GAAG,oBAAoB,GACzC,IAAI,CAAC;CACX"}

package/bin/cjs/IMediaPlayer.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IMediaPlayer.js","sourceRoot":"","sources":["../../src/IMediaPlayer.ts"],"names":[],"mappings":";AAAA;;;GAGG"}

package/bin/{LiveMediaSession.d.ts → cjs/LiveMediaSession.d.ts}

@@ -2,17 +2,19 @@
  * Copyright (c) Microsoft Corporation. All rights reserved.
  * Licensed under the Microsoft Live Share SDK License.
  */
-import { DataObjectFactory } from "@fluidframework/aqueduct";
-import { LiveDataObject, LiveTelemetryLogger, UserMeetingRole } from "@microsoft/live-share";
-import { MediaPlayerSynchronizer } from "./MediaPlayerSynchronizer";
-import { ExtendedMediaSessionAction, ExtendedMediaSessionActionHandler } from "./MediaSessionExtensions";
-import { LiveMediaSessionCoordinator, IMediaPlayerState } from "./LiveMediaSessionCoordinator";
-import { MediaSessionActionThrottler } from "./MediaSessionActionThrottler";
-import { IMediaPlayer } from "./IMediaPlayer";
+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 LiveMediaSession extends LiveDataObject {
+export declare class LiveMediaSessionClass extends LiveDataObject {
     private _actionThrottler;
     private _logger?;
     private _requestPlayerStateHandler?;
@@ -28,7 +30,7 @@ export declare class LiveMediaSession extends LiveDataObject {
     /**
      * The objects fluid type factory.
      */
-    static readonly factory: DataObjectFactory<LiveMediaSession, import("@fluidframework/aqueduct").DataObjectTypes>;
+    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.
@@ -87,4 +89,9 @@ export declare class LiveMediaSession extends LiveDataObject {
     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/cjs/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/{LiveMediaSession.js → cjs/LiveMediaSession.js}

@@ -13,21 +13,22 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.LiveMediaSession = void 0;
-const aqueduct_1 = require("@fluidframework/aqueduct");
+exports.LiveMediaSession = exports.LiveMediaSessionClass = void 0;
+const legacy_1 = require("@fluidframework/aqueduct/legacy");
 const live_share_1 = require("@microsoft/live-share");
-const MediaPlayerSynchronizer_1 = require("./MediaPlayerSynchronizer");
-const internals_1 = require("./internals");
-const MediaSessionExtensions_1 = require("./MediaSessionExtensions");
-const LiveMediaSessionCoordinator_1 = require("./LiveMediaSessionCoordinator");
-const RepeatedActionThrottler_1 = require("./RepeatedActionThrottler");
+const internal_1 = require("@microsoft/live-share/internal");
+const MediaPlayerSynchronizer_js_1 = require("./MediaPlayerSynchronizer.js");
+const MediaSessionExtensions_js_1 = require("./MediaSessionExtensions.js");
+const LiveMediaSessionCoordinator_js_1 = require("./LiveMediaSessionCoordinator.js");
+const RepeatedActionThrottler_js_1 = require("./RepeatedActionThrottler.js");
+const consts_js_1 = require("./internals/consts.js");
 /**
  * Live fluid object that synchronizes media playback across multiple clients.
  */
-class LiveMediaSession extends live_share_1.LiveDataObject {
+class LiveMediaSessionClass extends internal_1.LiveDataObject {
     constructor() {
         super(...arguments);
-        this._actionThrottler = new RepeatedActionThrottler_1.RepeatedActionThrottler();
+        this._actionThrottler = new RepeatedActionThrottler_js_1.RepeatedActionThrottler();
         this._actionHandlers = new Map();
         this._lastUpdateTime = 0;
     }
@@ -127,7 +128,7 @@ class LiveMediaSession extends live_share_1.LiveDataObject {
         }
         // Start position update timer
         if (!this._updateTimer) {
-            this.logger.sendTelemetryEvent(internals_1.TelemetryEvents.MediaSession.BeginPositionUpdateTimer);
+            this.logger.sendTelemetryEvent(consts_js_1.TelemetryEvents.MediaSession.BeginPositionUpdateTimer);
             this._updateTimer = setInterval(() => {
                 // Get current state
                 const state = this.getCurrentPlayerState();
@@ -143,7 +144,7 @@ class LiveMediaSession extends live_share_1.LiveDataObject {
                 }
             }, 500);
         }
-        return new MediaPlayerSynchronizer_1.MediaPlayerSynchronizer(player, this, this.runtime, () => {
+        return new MediaPlayerSynchronizer_js_1.MediaPlayerSynchronizer(player, this, this.runtime, () => {
             this._synchronizing = undefined;
         });
     }
@@ -151,19 +152,19 @@ class LiveMediaSession extends live_share_1.LiveDataObject {
         return __awaiter(this, void 0, void 0, function* () {
             this._logger = new live_share_1.LiveTelemetryLogger(this.runtime, this.liveRuntime);
             // Create coordinator and listen for triggered actions
-            this._coordinator = new LiveMediaSessionCoordinator_1.LiveMediaSessionCoordinator(this.id, this.runtime, this.liveRuntime, () => this.getCurrentPlayerState());
-            this._coordinator.on(MediaSessionExtensions_1.MediaSessionCoordinatorEvents.triggeraction, (event) => {
+            this._coordinator = new LiveMediaSessionCoordinator_js_1.LiveMediaSessionCoordinator(this.id, this.runtime, this.liveRuntime, () => this.getCurrentPlayerState());
+            this._coordinator.on(MediaSessionExtensions_js_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, {
+                        this.logger.sendTelemetryEvent(consts_js_1.TelemetryEvents.MediaSession.PlayAction, null, {
                             position: seekTime,
                         });
                         break;
                     case "pause":
-                        this.logger.sendTelemetryEvent(internals_1.TelemetryEvents.MediaSession.PauseAction, null, {
+                        this.logger.sendTelemetryEvent(consts_js_1.TelemetryEvents.MediaSession.PauseAction, null, {
                             position: seekTime,
                         });
                         break;
@@ -171,24 +172,24 @@ class LiveMediaSession extends live_share_1.LiveDataObject {
                         if (!details.playbackRate) {
                             break;
                         }
-                        this.logger.sendTelemetryEvent(internals_1.TelemetryEvents.MediaSession.RateChangeAction, null, {
+                        this.logger.sendTelemetryEvent(consts_js_1.TelemetryEvents.MediaSession.RateChangeAction, null, {
                             playbackRate: details.playbackRate,
                         });
                         break;
                     case "seekto":
-                        this.logger.sendTelemetryEvent(internals_1.TelemetryEvents.MediaSession.SeekToAction, null, {
+                        this.logger.sendTelemetryEvent(consts_js_1.TelemetryEvents.MediaSession.SeekToAction, null, {
                             position: seekTime,
                         });
                         break;
                     case "settrack":
-                        this.logger.sendTelemetryEvent(internals_1.TelemetryEvents.MediaSession.SetTrackAction);
+                        this.logger.sendTelemetryEvent(consts_js_1.TelemetryEvents.MediaSession.SetTrackAction);
                         break;
                     case "datachange":
-                        this.logger.sendTelemetryEvent(internals_1.TelemetryEvents.MediaSession.DataChangeAction);
+                        this.logger.sendTelemetryEvent(consts_js_1.TelemetryEvents.MediaSession.DataChangeAction);
                         break;
                     case "catchup":
                         // Default to seekto if catchup not implemented
-                        this.logger.sendTelemetryEvent(internals_1.TelemetryEvents.MediaSession.CatchUpAction, null, {
+                        this.logger.sendTelemetryEvent(consts_js_1.TelemetryEvents.MediaSession.CatchUpAction, null, {
                             position: seekTime,
                         });
                         if (!this._actionHandlers.has("catchup")) {
@@ -239,17 +240,22 @@ class LiveMediaSession extends live_share_1.LiveDataObject {
         }
     }
 }
+exports.LiveMediaSessionClass = LiveMediaSessionClass;
 /**
  * The objects fluid type name.
  */
-LiveMediaSession.TypeName = `@microsoft/fluid-media:SharedMediaSession`;
+LiveMediaSessionClass.TypeName = `@microsoft/fluid-media:SharedMediaSession`;
 /**
  * The objects fluid type factory.
  */
-LiveMediaSession.factory = new aqueduct_1.DataObjectFactory(LiveMediaSession.TypeName, LiveMediaSession, [], {});
-exports.LiveMediaSession = LiveMediaSession;
+LiveMediaSessionClass.factory = new legacy_1.DataObjectFactory(LiveMediaSessionClass.TypeName, LiveMediaSessionClass, [], {});
+// eslint-disable-next-line no-redeclare
+exports.LiveMediaSession = (() => {
+    const kind = LiveMediaSessionClass;
+    return kind;
+})();
 /**
- * Register `LiveMediaSession` as an available `LoadableObjectClass` for use in packages that support dynamic object loading, such as `@microsoft/live-share-turbo`.
+ * Register `LiveMediaSession` as an available `SharedObjectKind` for use in dynamic object loading.
  */
-live_share_1.DynamicObjectRegistry.registerObjectClass(LiveMediaSession, LiveMediaSession.TypeName);
+internal_1.DynamicObjectRegistry.registerObjectClass(exports.LiveMediaSession, exports.LiveMediaSession.TypeName);
 //# sourceMappingURL=LiveMediaSession.js.map

package/bin/cjs/LiveMediaSession.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"LiveMediaSession.js","sourceRoot":"","sources":["../../src/LiveMediaSession.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;;;;;;;;;;AAEH,4DAAoE;AACpE,sDAK+B;AAC/B,6DAGwC;AACxC,6EAAuE;AAEvE,2EAKqC;AACrC,qFAG0C;AAE1C,6EAAuE;AAGvE,qDAAwD;AAExD;;GAEG;AACH,MAAa,qBAAsB,SAAQ,yBAAc;IAAzD;;QACY,qBAAgB,GACpB,IAAI,oDAAuB,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,mDAAsC,CAAC,MAAM,CACzC,6BAA6B,EAC7B,IAAI,CAAC,eAAe,CACvB,CAAC;YACF,qCAAqC;YACrC,IAAI,CAAC,eAAe,GAAG,0CAA6B,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,0CAA6B,CAAC,MAAM,CAAC;gBAC5D,MAAM,KAAK,CAAC;YAChB,CAAC;YAED,uCAAuC;YACvC,IAAI,CAAC,eAAe,GAAG,0CAA6B,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,2BAAe,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,oDAAuB,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,gCAAmB,CAAC,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC;YAEvE,sDAAsD;YACtD,IAAI,CAAC,YAAY,GAAG,IAAI,4DAA2B,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,yDAA6B,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,2BAAe,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,2BAAe,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,2BAAe,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,2BAAe,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,2BAAe,CAAC,YAAY,CAAC,cAAc,CAC9C,CAAC;wBACF,MAAM;oBACV,KAAK,YAAY;wBACb,IAAI,CAAC,MAAM,CAAC,kBAAkB,CAC1B,2BAAe,CAAC,YAAY,CAAC,gBAAgB,CAChD,CAAC;wBACF,MAAM;oBACV,KAAK,SAAS;wBACV,+CAA+C;wBAC/C,IAAI,CAAC,MAAM,CAAC,kBAAkB,CAC1B,2BAAe,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;;AAlTL,sDAmTC;AAnSG;;GAEG;AACoB,8BAAQ,GAAG,2CAA2C,AAA9C,CAA+C;AAE9E;;GAEG;AACoB,6BAAO,GAAG,IAAI,0BAAiB,CAClD,qBAAqB,CAAC,QAAQ,EAC9B,qBAAqB,EACrB,EAAE,EACF,EAAE,CACL,AAL6B,CAK5B;AA6RN,wCAAwC;AAC3B,QAAA,gBAAgB,GAAG,CAAC,GAAG,EAAE;IAClC,MAAM,IAAI,GAAG,qBAAqB,CAAC;IACnC,OAAO,IAA6D,CAAC;AACzE,CAAC,CAAC,EAAE,CAAC;AAEL;;GAEG;AACH,gCAAqB,CAAC,mBAAmB,CACrC,wBAAgB,EAChB,wBAAgB,CAAC,QAAQ,CAC5B,CAAC"}

package/bin/{LiveMediaSessionCoordinator.d.ts → cjs/LiveMediaSessionCoordinator.d.ts}

@@ -2,10 +2,11 @@
  * Copyright (c) Microsoft Corporation. All rights reserved.
  * Licensed under the Microsoft Live Share SDK License.
  */
-/// <reference types="node" />
-import { IRuntimeSignaler, UserMeetingRole, LiveShareRuntime } from "@microsoft/live-share";
-import { CoordinationWaitPoint, ExtendedMediaMetadata, ExtendedMediaSessionPlaybackState, MediaSessionCoordinatorSuspension } from "./MediaSessionExtensions";
-import EventEmitter from "events";
+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.
  */
@@ -30,12 +31,24 @@ export interface IMediaPlayerState {
      */
     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 EventEmitter {
+export declare class LiveMediaSessionCoordinator extends TypedEventEmitter<ILiveMediaSessionCoordinatorEvents> {
     private readonly _id;
     private readonly _runtime;
     private readonly _liveRuntime;
@@ -135,22 +148,45 @@ export declare class LiveMediaSessionCoordinator extends EventEmitter {
      */
     get isSuspended(): boolean;
     /**
-     * Max amount of playback drift allowed in seconds.
+     * Controls whether or not to scale {@link maxPlaybackDrift} by the number of users in the session.
      *
      * @remarks
-     * Should the local clients playback position lag by more than the specified value, the
-     * coordinator will trigger a `catchup` action.
+     * 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.
      *
-     * Defaults to a value of `1` second.
+     * @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);
     /**
-     * Frequency with which position updates are broadcast to the rest of the group in
-     * seconds.
+     * 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 value of `2` seconds.
+     * Defaults to a minimum value of `2` seconds.
      */
     get positionUpdateInterval(): number;
     set positionUpdateInterval(value: number);
@@ -184,6 +220,14 @@ export declare class LiveMediaSessionCoordinator extends EventEmitter {
      * @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.
@@ -253,7 +297,7 @@ export declare class LiveMediaSessionCoordinator extends EventEmitter {
      * @hidden
      * Called by MediaSession to trigger the sending of a position update.
      */
-    sendPositionUpdate(state: IMediaPlayerState): void;
+    sendPositionUpdate(state: IMediaPlayerState, targetClientId?: string): void;
     protected createChildren(acceptTransportChangesFrom?: UserMeetingRole[]): Promise<void>;
     private getPlayerPosition;
 }

package/bin/cjs/LiveMediaSessionCoordinator.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"LiveMediaSessionCoordinator.d.ts","sourceRoot":"","sources":["../../src/LiveMediaSessionCoordinator.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAGH,eAAe,EAKlB,MAAM,uBAAuB,CAAC;AAC/B,OAAO,EACH,gBAAgB,EAIhB,gBAAgB,EAEnB,MAAM,gCAAgC,CAAC;AACxC,OAAO,EACH,qBAAqB,EACrB,qBAAqB,EACrB,iCAAiC,EACjC,iCAAiC,EACpC,MAAM,6BAA6B,CAAC;AAiBrC,OAAO,EAAE,iBAAiB,EAAE,MAAM,8BAA8B,CAAC;AACjE,OAAO,EAAE,MAAM,EAAE,MAAM,iCAAiC,CAAC;AAEzD;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAC9B;;OAEG;IACH,QAAQ,EAAE,qBAAqB,GAAG,IAAI,CAAC;IAEvC;;;;;OAKG;IACH,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzB;;OAEG;IACH,aAAa,EAAE,iCAAiC,CAAC;IAEjD;;OAEG;IACH,aAAa,CAAC,EAAE,kBAAkB,CAAC;CACtC;AAED;;GAEG;AACH,MAAM,WAAW,kCAAmC,SAAQ,MAAM;IAC9D;;;;;OAKG;IACH,CAAC,KAAK,EAAE,MAAM,EAAE,QAAQ,EAAE,CAAC,KAAK,EAAE,GAAG,KAAK,IAAI,GAAG,IAAI,CAAC;CACzD;AAED;;;;GAIG;AACH,qBAAa,2BAA4B,SAAQ,iBAAiB,CAAC,kCAAkC,CAAC;IAClG,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAS;IAC7B,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAmB;IAC5C,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAmB;IAChD,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAsB;IAC9C,OAAO,CAAC,QAAQ,CAAC,eAAe,CAA0B;IAC1D,OAAO,CAAC,uBAAuB,CAU7B;IACF,OAAO,CAAC,iBAAiB,CASvB;IACF,OAAO,CAAC,cAAc,CAAC,CAAwB;IAC/C,OAAO,CAAC,eAAe,CACkB;IAGzC,OAAO,CAAC,UAAU,CAAC,CAA0C;IAC7D,OAAO,CAAC,WAAW,CAAC,CAA0C;IAC9D,OAAO,CAAC,YAAY,CAAC,CAA0C;IAC/D,OAAO,CAAC,gBAAgB,CAAC,CAA2C;IACpE,OAAO,CAAC,cAAc,CAAC,CAAkC;IACzD,OAAO,CAAC,kBAAkB,CAAC,CAAsC;IACjE,OAAO,CAAC,oBAAoB,CAAC,CAAwC;IAIrE,OAAO,CAAC,aAAa,CAAC,CAAoC;IAG1D,OAAO,CAAC,WAAW,CAAC,CAAwB;IAE5C;;;OAGG;gBAEC,EAAE,EAAE,MAAM,EACV,OAAO,EAAE,gBAAgB,EACzB,WAAW,EAAE,gBAAgB,EAC7B,cAAc,EAAE,MAAM,iBAAiB;IAU3C;;;;;;;;;;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;;;;;;;;;;;OAWG;IACI,kBAAkB,EAAE,OAAO,CAAQ;IAE1C;;;;;;OAMG;IACI,sBAAsB,EAAE,OAAO,CAAQ;IAE9C;;OAEG;IACH,IAAW,WAAW,IAAI,OAAO,CAEhC;IAED;;;;;;;;OAQG;IACH,IAAW,2BAA2B,IAAI,OAAO,CAEhD;IAED,IAAW,2BAA2B,CAAC,KAAK,EAAE,OAAO,EAEpD;IAED;;;;;;;OAOG;IACH,IAAW,gBAAgB,IAAI,MAAM,CAEpC;IAED,IAAW,gBAAgB,CAAC,KAAK,EAAE,MAAM,EAExC;IAED;;;;;;;;;OASG;IACH,IAAW,iCAAiC,IAAI,OAAO,CAEtD;IAED,IAAW,iCAAiC,CAAC,KAAK,EAAE,OAAO,EAE1D;IAED;;;;;;;OAOG;IACH,IAAW,sBAAsB,IAAI,MAAM,CAE1C;IAED,IAAW,sBAAsB,CAAC,KAAK,EAAE,MAAM,EAE9C;IAED;;;;;;;;OAQG;IACU,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC;IAqClC;;;;;;;;OAQG;IACU,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC;IAqCnC;;;;;;;;OAQG;IACU,MAAM,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAuChD;;;;;;;OAOG;IACU,eAAe,CAAC,YAAY,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAyBjE;;;;;;;;;OASG;IACU,QAAQ,CACjB,QAAQ,EAAE,qBAAqB,GAAG,IAAI,EACtC,UAAU,CAAC,EAAE,qBAAqB,EAAE,GACrC,OAAO,CAAC,IAAI,CAAC;IA2BhB;;;;;;;;;;;OAWG;IACU,YAAY,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC;IA0B7D;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACI,eAAe,CAClB,SAAS,CAAC,EAAE,qBAAqB,GAClC,iCAAiC;IA2DpC;;;OAGG;IACH,IAAW,aAAa,IAAI,OAAO,CAElC;IAED;;;OAGG;IACU,UAAU,CACnB,0BAA0B,CAAC,EAAE,eAAe,EAAE,GAC/C,OAAO,CAAC,IAAI,CAAC;IAkChB;;;OAGG;IACI,iBAAiB,IAAI,qBAAqB,GAAG,IAAI;IAQxD;;;OAGG;IACI,kBAAkB,CACrB,KAAK,EAAE,iBAAiB,EACxB,cAAc,CAAC,EAAE,MAAM,GACxB,IAAI;cAmCS,cAAc,CAC1B,0BAA0B,CAAC,EAAE,eAAe,EAAE,GAC/C,OAAO,CAAC,IAAI,CAAC;IA8GhB,OAAO,CAAC,iBAAiB;CAY5B"}