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

package/bin/VolumeLimiter.d.ts

@@ -0,0 +1,70 @@
+/**
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the Microsoft Live Share SDK License.
+ */
+import { IMediaPlayer } from './IMediaPlayer';
+export declare enum LevelType {
+    fixed = 0,
+    percentage = 1
+}
+export declare class VolumeLimiter {
+    private readonly _player;
+    private readonly _duration;
+    private readonly _rampDownDuration;
+    private readonly _rampUpDuration;
+    private _level;
+    private _levelType;
+    private _running;
+    private _endTime;
+    private _startTime;
+    private _startVolume;
+    private _inRamp;
+    constructor(player: IMediaPlayer);
+    /**
+     * Time, in seconds, that the volume should be lowered.
+     *
+     * @remarks
+     * Applications should periodically call `lowerVolume()` to keep the volume lowered.
+     */
+    get duration(): number;
+    set duration(value: number);
+    /**
+     * Target level to lower volume to.
+     *
+     * @remarks
+     * Expressed as a value between 0.0 and 1.0. The value is applied based upon the configured
+     * `levelType`. The default value is 0.2.
+     *
+     * For a level type of `LevelType.fixed` the value is the exact level the volume will be
+     * lowered to. The default value of 0.2 would cause the volume to be lowered to 0.2.
+     *
+     * For a level type of `LevelType.percentage` the value is the percentage by which the volume
+     * level should be lowered to. The default value of 0.2 would cause the volume to be lowered
+     * to 20% of its starting value.
+     */
+    get level(): number;
+    set level(value: number);
+    /**
+     * The type of level represented by the `level` property.
+     */
+    get levelType(): LevelType;
+    set levelType(value: LevelType);
+    /**
+     * Amount of time, in seconds, it should take to ramp the volume down to the desired level.
+     */
+    get rampDownDuration(): number;
+    set rampDownDuration(value: number);
+    /**
+     * Amount of time, in seconds, it should take to ramp the volume back up to the original level.
+     */
+    get rampUpDuration(): number;
+    set rampUpDuration(value: number);
+    /**
+     * Temporarily lowers an audio sources volume.
+     */
+    lowerVolume(): void;
+    private startLimiter;
+    private scheduleAnimationFrame;
+    private computeTargetVolume;
+}
+//# sourceMappingURL=VolumeLimiter.d.ts.map

package/bin/VolumeLimiter.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"VolumeLimiter.d.ts","sourceRoot":"","sources":["../src/VolumeLimiter.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAGF,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAE/C,oBAAY,SAAS;IAAG,KAAK,IAAA;IAAE,UAAU,IAAA;CAAE;AAE3C,qBAAa,aAAa;IACtB,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAe;IAGvC,OAAO,CAAC,QAAQ,CAAC,SAAS,CAA0B;IACpD,OAAO,CAAC,QAAQ,CAAC,iBAAiB,CAAyB;IAC3D,OAAO,CAAC,QAAQ,CAAC,eAAe,CAAyB;IACzD,OAAO,CAAC,MAAM,CAAc;IAC5B,OAAO,CAAC,UAAU,CAA8B;IAGhD,OAAO,CAAC,QAAQ,CAAS;IACzB,OAAO,CAAC,QAAQ,CAAK;IACrB,OAAO,CAAC,UAAU,CAAK;IACvB,OAAO,CAAC,YAAY,CAAK;IACzB,OAAO,CAAC,OAAO,CAAS;gBAEZ,MAAM,EAAE,YAAY;IAIhC;;;;;OAKG;IACH,IAAW,QAAQ,IAAI,MAAM,CAE5B;IAED,IAAW,QAAQ,CAAC,KAAK,EAAE,MAAM,EAEhC;IAED;;;;;;;;;;;;;OAaG;IACH,IAAW,KAAK,IAAI,MAAM,CAEzB;IAED,IAAW,KAAK,CAAC,KAAK,EAAE,MAAM,EAM7B;IAED;;OAEG;IACH,IAAW,SAAS,IAAI,SAAS,CAEhC;IAED,IAAW,SAAS,CAAC,KAAK,EAAE,SAAS,EAEpC;IAED;;OAEG;IACH,IAAW,gBAAgB,IAAI,MAAM,CAEpC;IAED,IAAW,gBAAgB,CAAC,KAAK,EAAE,MAAM,EAExC;IAED;;OAEG;IACF,IAAW,cAAc,IAAI,MAAM,CAEnC;IAED,IAAW,cAAc,CAAC,KAAK,EAAE,MAAM,EAEtC;IAED;;OAEG;IACI,WAAW,IAAI,IAAI;IAO1B,OAAO,CAAC,YAAY;IAkDpB,OAAO,CAAC,sBAAsB;IAQ9B,OAAO,CAAC,mBAAmB;CAS9B"}

package/bin/VolumeLimiter.js

@@ -0,0 +1,170 @@
+"use strict";
+/**
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the Microsoft Live Share SDK License.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.VolumeLimiter = exports.LevelType = void 0;
+const live_share_1 = require("@microsoft/live-share");
+var LevelType;
+(function (LevelType) {
+    LevelType[LevelType["fixed"] = 0] = "fixed";
+    LevelType[LevelType["percentage"] = 1] = "percentage";
+})(LevelType = exports.LevelType || (exports.LevelType = {}));
+class VolumeLimiter {
+    constructor(player) {
+        // Settings
+        this._duration = new live_share_1.TimeInterval(2000);
+        this._rampDownDuration = new live_share_1.TimeInterval(500);
+        this._rampUpDuration = new live_share_1.TimeInterval(500);
+        this._level = 0.1;
+        this._levelType = LevelType.fixed;
+        // Running state
+        this._running = false;
+        this._endTime = 0;
+        this._startTime = 0;
+        this._startVolume = 0;
+        this._inRamp = false;
+        this._player = player;
+    }
+    /**
+     * Time, in seconds, that the volume should be lowered.
+     *
+     * @remarks
+     * Applications should periodically call `lowerVolume()` to keep the volume lowered.
+     */
+    get duration() {
+        return this._duration.seconds;
+    }
+    set duration(value) {
+        this._duration.seconds = Math.abs(value);
+    }
+    /**
+     * Target level to lower volume to.
+     *
+     * @remarks
+     * Expressed as a value between 0.0 and 1.0. The value is applied based upon the configured
+     * `levelType`. The default value is 0.2.
+     *
+     * For a level type of `LevelType.fixed` the value is the exact level the volume will be
+     * lowered to. The default value of 0.2 would cause the volume to be lowered to 0.2.
+     *
+     * For a level type of `LevelType.percentage` the value is the percentage by which the volume
+     * level should be lowered to. The default value of 0.2 would cause the volume to be lowered
+     * to 20% of its starting value.
+     */
+    get level() {
+        return this._level;
+    }
+    set level(value) {
+        if (value < 0 || value > 1.0) {
+            throw new Error(`VolumeLimiter: cannot set level to ${value}. Level must be between 0.0 and 1.0.`);
+        }
+        this._level = value;
+    }
+    /**
+     * The type of level represented by the `level` property.
+     */
+    get levelType() {
+        return this._levelType;
+    }
+    set levelType(value) {
+        this._levelType = value;
+    }
+    /**
+     * Amount of time, in seconds, it should take to ramp the volume down to the desired level.
+     */
+    get rampDownDuration() {
+        return this._rampDownDuration.seconds;
+    }
+    set rampDownDuration(value) {
+        this._rampDownDuration.seconds = Math.abs(value);
+    }
+    /**
+     * Amount of time, in seconds, it should take to ramp the volume back up to the original level.
+     */
+    get rampUpDuration() {
+        return this._rampUpDuration.seconds;
+    }
+    set rampUpDuration(value) {
+        this._rampUpDuration.seconds = Math.abs(value);
+    }
+    /**
+     * Temporarily lowers an audio sources volume.
+     */
+    lowerVolume() {
+        this._endTime = new Date().getTime() + this._duration.milliseconds;
+        if (!this._running) {
+            this.startLimiter();
+        }
+    }
+    startLimiter() {
+        const adjustVolume = () => {
+            const now = new Date().getTime();
+            if (now < this._endTime) {
+                // Make no adjustment if muted
+                if (!this._player.muted) {
+                    // Compute adjusted volume level
+                    let volume;
+                    const targetVolume = this.computeTargetVolume();
+                    const rampRange = this._startVolume - targetVolume;
+                    const rampUpStart = this._endTime - this._rampUpDuration.milliseconds;
+                    const rampDownEnd = this._startTime + this._rampDownDuration.milliseconds;
+                    if (now > rampUpStart) {
+                        // We're about to end so ramping up
+                        const progress = (now - rampUpStart) / this._rampUpDuration.milliseconds;
+                        volume = targetVolume + (rampRange * progress);
+                        this._player.volume = volume;
+                        this._inRamp = true;
+                    }
+                    else if (now < rampDownEnd) {
+                        // We just begun so ramping down
+                        const remaining = (rampDownEnd - now) / this._rampUpDuration.milliseconds;
+                        volume = targetVolume + (rampRange * remaining);
+                        this._player.volume = volume;
+                        this._inRamp = true;
+                    }
+                    else if (this._inRamp) {
+                        // We're at the end of a ramp
+                        volume = targetVolume;
+                        this._player.volume = volume;
+                        this._inRamp = false;
+                    }
+                }
+                // Schedule next animation frame
+                this.scheduleAnimationFrame(adjustVolume);
+            }
+            else {
+                // Reset volume to original level
+                this._player.volume = this._startVolume;
+                this._running = false;
+                this._endTime = 0;
+                this._startTime = 0;
+                this._startVolume = 0;
+            }
+        };
+        this._running = true;
+        this._startTime = new Date().getTime();
+        this._startVolume = this._player.volume;
+        this.scheduleAnimationFrame(adjustVolume);
+    }
+    scheduleAnimationFrame(callback) {
+        if (requestAnimationFrame) {
+            requestAnimationFrame(callback);
+        }
+        else {
+            setTimeout(callback, 20);
+        }
+    }
+    computeTargetVolume() {
+        switch (this._levelType) {
+            case LevelType.percentage:
+                return this._startVolume * this._level;
+            case LevelType.fixed:
+            default:
+                return this._level;
+        }
+    }
+}
+exports.VolumeLimiter = VolumeLimiter;
+//# sourceMappingURL=VolumeLimiter.js.map

package/bin/VolumeLimiter.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"VolumeLimiter.js","sourceRoot":"","sources":["../src/VolumeLimiter.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAEF,sDAAqD;AAGtD,IAAY,SAA+B;AAA3C,WAAY,SAAS;IAAG,2CAAK,CAAA;IAAE,qDAAU,CAAA;AAAC,CAAC,EAA/B,SAAS,GAAT,iBAAS,KAAT,iBAAS,QAAsB;AAE3C,MAAa,aAAa;IAiBtB,YAAY,MAAoB;QAdhC,WAAW;QACM,cAAS,GAAG,IAAI,yBAAY,CAAC,IAAI,CAAC,CAAC;QACnC,sBAAiB,GAAG,IAAI,yBAAY,CAAC,GAAG,CAAC,CAAC;QAC1C,oBAAe,GAAG,IAAI,yBAAY,CAAC,GAAG,CAAC,CAAC;QACjD,WAAM,GAAW,GAAG,CAAA;QACpB,eAAU,GAAc,SAAS,CAAC,KAAK,CAAC;QAEhD,gBAAgB;QACR,aAAQ,GAAG,KAAK,CAAC;QACjB,aAAQ,GAAG,CAAC,CAAC;QACb,eAAU,GAAG,CAAC,CAAC;QACf,iBAAY,GAAG,CAAC,CAAC;QACjB,YAAO,GAAG,KAAK,CAAC;QAGpB,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC;IAC1B,CAAC;IAED;;;;;OAKG;IACH,IAAW,QAAQ;QACf,OAAO,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC;IAClC,CAAC;IAED,IAAW,QAAQ,CAAC,KAAa;QAC7B,IAAI,CAAC,SAAS,CAAC,OAAO,GAAG,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;IAC7C,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,IAAW,KAAK;QACZ,OAAO,IAAI,CAAC,MAAM,CAAC;IACvB,CAAC;IAED,IAAW,KAAK,CAAC,KAAa;QAC1B,IAAI,KAAK,GAAG,CAAC,IAAI,KAAK,GAAG,GAAG,EAAE;YAC1B,MAAM,IAAI,KAAK,CAAC,sCAAsC,KAAK,sCAAsC,CAAC,CAAC;SACtG;QAED,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC;IACxB,CAAC;IAED;;OAEG;IACH,IAAW,SAAS;QAChB,OAAO,IAAI,CAAC,UAAU,CAAC;IAC3B,CAAC;IAED,IAAW,SAAS,CAAC,KAAgB;QACjC,IAAI,CAAC,UAAU,GAAG,KAAK,CAAC;IAC5B,CAAC;IAED;;OAEG;IACH,IAAW,gBAAgB;QACvB,OAAO,IAAI,CAAC,iBAAiB,CAAC,OAAO,CAAC;IAC1C,CAAC;IAED,IAAW,gBAAgB,CAAC,KAAa;QACrC,IAAI,CAAC,iBAAiB,CAAC,OAAO,GAAG,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;IACrD,CAAC;IAED;;OAEG;IACF,IAAW,cAAc;QACtB,OAAO,IAAI,CAAC,eAAe,CAAC,OAAO,CAAC;IACxC,CAAC;IAED,IAAW,cAAc,CAAC,KAAa;QACnC,IAAI,CAAC,eAAe,CAAC,OAAO,GAAG,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;IACnD,CAAC;IAED;;OAEG;IACI,WAAW;QACd,IAAI,CAAC,QAAQ,GAAG,IAAI,IAAI,EAAE,CAAC,OAAO,EAAE,GAAG,IAAI,CAAC,SAAS,CAAC,YAAY,CAAC;QACnE,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE;YAChB,IAAI,CAAC,YAAY,EAAE,CAAC;SACvB;IACL,CAAC;IAEO,YAAY;QAChB,MAAM,YAAY,GAAG,GAAG,EAAE;YACtB,MAAM,GAAG,GAAG,IAAI,IAAI,EAAE,CAAC,OAAO,EAAE,CAAC;YACjC,IAAI,GAAG,GAAG,IAAI,CAAC,QAAQ,EAAE;gBACrB,8BAA8B;gBAC9B,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE;oBACrB,gCAAgC;oBAChC,IAAI,MAAc,CAAC;oBACnB,MAAM,YAAY,GAAG,IAAI,CAAC,mBAAmB,EAAE,CAAC;oBAChD,MAAM,SAAS,GAAG,IAAI,CAAC,YAAY,GAAG,YAAY,CAAC;oBACnD,MAAM,WAAW,GAAG,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,eAAe,CAAC,YAAY,CAAC;oBACtE,MAAM,WAAW,GAAG,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC,iBAAiB,CAAC,YAAY,CAAC;oBAC1E,IAAI,GAAG,GAAG,WAAW,EAAE;wBACnB,mCAAmC;wBACnC,MAAM,QAAQ,GAAG,CAAC,GAAG,GAAG,WAAW,CAAC,GAAG,IAAI,CAAC,eAAe,CAAC,YAAY,CAAC;wBACzE,MAAM,GAAG,YAAY,GAAG,CAAC,SAAS,GAAG,QAAQ,CAAC,CAAC;wBAC/C,IAAI,CAAC,OAAO,CAAC,MAAM,GAAG,MAAM,CAAC;wBAC7B,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC;qBACvB;yBAAM,IAAI,GAAG,GAAG,WAAW,EAAE;wBAC1B,gCAAgC;wBAChC,MAAM,SAAS,GAAG,CAAC,WAAW,GAAG,GAAG,CAAC,GAAG,IAAI,CAAC,eAAe,CAAC,YAAY,CAAC;wBAC1E,MAAM,GAAG,YAAY,GAAG,CAAC,SAAS,GAAG,SAAS,CAAC,CAAC;wBAChD,IAAI,CAAC,OAAO,CAAC,MAAM,GAAG,MAAM,CAAC;wBAC7B,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC;qBACvB;yBAAM,IAAI,IAAI,CAAC,OAAO,EAAE;wBACrB,6BAA6B;wBAC7B,MAAM,GAAG,YAAY,CAAC;wBACtB,IAAI,CAAC,OAAO,CAAC,MAAM,GAAG,MAAM,CAAC;wBAC7B,IAAI,CAAC,OAAO,GAAG,KAAK,CAAC;qBACxB;iBACJ;gBAED,gCAAgC;gBAChC,IAAI,CAAC,sBAAsB,CAAC,YAAY,CAAC,CAAC;aAC7C;iBAAM;gBACH,iCAAiC;gBACjC,IAAI,CAAC,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC,YAAY,CAAC;gBACxC,IAAI,CAAC,QAAQ,GAAG,KAAK,CAAC;gBACtB,IAAI,CAAC,QAAQ,GAAG,CAAC,CAAC;gBAClB,IAAI,CAAC,UAAU,GAAG,CAAC,CAAC;gBACpB,IAAI,CAAC,YAAY,GAAG,CAAC,CAAC;aACzB;QACL,CAAC,CAAC;QAEF,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC;QACrB,IAAI,CAAC,UAAU,GAAG,IAAI,IAAI,EAAE,CAAC,OAAO,EAAE,CAAC;QACvC,IAAI,CAAC,YAAY,GAAG,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC;QACxC,IAAI,CAAC,sBAAsB,CAAC,YAAY,CAAC,CAAA;IAC7C,CAAC;IAEO,sBAAsB,CAAC,QAA8B;QACzD,IAAI,qBAAqB,EAAE;YACvB,qBAAqB,CAAC,QAAQ,CAAC,CAAC;SACnC;aAAM;YACH,UAAU,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC;SAC5B;IACL,CAAC;IAEO,mBAAmB;QACvB,QAAQ,IAAI,CAAC,UAAU,EAAE;YACrB,KAAK,SAAS,CAAC,UAAU;gBACrB,OAAO,IAAI,CAAC,YAAY,GAAG,IAAI,CAAC,MAAM,CAAC;YAC3C,KAAK,SAAS,CAAC,KAAK,CAAC;YACrB;gBACI,OAAO,IAAI,CAAC,MAAM,CAAC;SAC1B;IACL,CAAC;CACJ;AA3KD,sCA2KC"}

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@microsoft/live-share-media",
-    "version": "1.0.0-preview.3",
+    "version": "1.0.0-preview.5",
     "description": "Live Share classes that synchronize media playback across clients.",
     "author": "Microsoft",
     "license": "SEE LICENSE IN LICENSE",
@@ -14,16 +14,16 @@
         "test:coverage": "nyc --reporter=html --reporter=text --reporter=text-summary npm test"
     },
     "dependencies": {
-        "fluid-framework": "~1.2.3",
-        "@microsoft/live-share": "1.0.0-preview.3"
+        "@microsoft/live-share": "1.0.0-preview.4",
+        "fluid-framework": "~1.2.3"
     },
     "devDependencies": {
         "@types/assert": "^1.5.6",
-        "@types/mocha": "^9.0.0",
-        "@types/node": "^18.11.0",
-        "mocha": "^9.1.1",
+        "@types/mocha": "^10.0.1",
+        "@types/node": "^18.11.18",
+        "mocha": "^10.2.0",
         "nyc": "^15.1.0",
-        "ts-mocha": "^9.0.2",
+        "ts-mocha": "^10.0.0",
         "typescript": "^4.6.4"
     },
     "repository": {

package/src/LiveMediaSession.ts

@@ -4,7 +4,7 @@
  */
 
 import { DataObject, DataObjectFactory } from "@fluidframework/aqueduct";
-import { LiveTelemetryLogger, UserMeetingRole } from "@microsoft/live-share";
+import { DynamicObjectRegistry, LiveTelemetryLogger, UserMeetingRole } from "@microsoft/live-share";
 import { MediaPlayerSynchronizer } from "./MediaPlayerSynchronizer";
 import { ITriggerActionEvent, TelemetryEvents } from "./internals";
 import {
@@ -298,3 +298,8 @@ export class LiveMediaSession extends DataObject {
         }
     }
 }
+
+/**
+ * Register `LiveMediaSession` as an available `LoadableObjectClass` for use in packages that support dynamic object loading, such as `@microsoft/live-share-turbo`.
+ */
+DynamicObjectRegistry.registerObjectClass(LiveMediaSession, LiveMediaSession.TypeName);

package/src/MediaPlayerSynchronizer.ts

@@ -167,22 +167,31 @@ export class MediaPlayerSynchronizer extends EventEmitter {
                             this.play();
                         }
                     }
-                    // block play if player state is playing when expected synced state is paused.
+                    // block play if player state is playing when expected synced state is paused and coordinator is not suspended.
                     // needed because cannot tell if its a user initiated event, so disallow play
-                    if (this._expectedPlaybackState === "paused") {
+                    if (
+                        this._expectedPlaybackState === "paused" &&
+                        !this._mediaSession.coordinator.isSuspended
+                    ) {
                         this._player.pause();
                     }
 
-                    // block play if player state is playing when expected synced state is none.
+                    // block play if player state is playing when expected synced state is none and coordinator is not suspended.
                     // needed because user who is not in control should not be able to start, so disallow play
-                    if (this._expectedPlaybackState === "none") {
+                    if (
+                        this._expectedPlaybackState === "none" &&
+                        !this._mediaSession.coordinator.isSuspended
+                    ) {
                         this._player.pause();
                     }
                     break;
                 case "pause":
-                    // block pause if player state is paused when expected synced state is playing
+                    // block pause if player state is paused when expected synced state is playing and coordinator is not suspended.
                     // needed because cannot tell if its a user initiated event, so disallow pause
-                    if (this._expectedPlaybackState === "playing") {
+                    if (
+                        this._expectedPlaybackState === "playing" &&
+                        !this._mediaSession.coordinator.isSuspended
+                    ) {
                         this._player.play();
                     }
                     break;

package/.vscode/launch.json

@@ -1,29 +0,0 @@
-{
-    // Use IntelliSense to learn about possible attributes.
-    // Hover to view descriptions of existing attributes.
-    // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
-    "version": "0.2.0",
-    "configurations": [
-        {
-            "name": "Attach by Process ID",
-            "processId": "${command:PickProcess}",
-            "request": "attach",
-            "skipFiles": [
-                "<node_internals>/**"
-            ],
-            "type": "node"
-        },
-        {
-            "type": "pwa-node",
-            "request": "launch",
-            "name": "Launch Program",
-            "skipFiles": [
-                "<node_internals>/**"
-            ],
-            "program": "${workspaceFolder}\\bin\\index.js",
-            "outFiles": [
-                "${workspaceFolder}/**/*.js"
-            ]
-        }
-    ]
-}

package/.vscode/settings.json

@@ -1,2 +0,0 @@
-{
-}