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

package/bin/esm/MediaSessionExtensions.d.ts

@@ -0,0 +1,177 @@
+/**
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the Microsoft Live Share SDK License.
+ */
+/**
+ * Suspension object for when group synchronization is suspended for the local user.
+ */
+export interface MediaSessionCoordinatorSuspension {
+    /**
+     * The wait point that the suspension was created with.
+     *
+     * @remarks
+     * If undefined, the suspension was not created with a wait point.
+     */
+    waitPoint?: CoordinationWaitPoint;
+    /**
+     * Ends the suspension.
+     *
+     * @param seekTo the timestamp to seek to after the suspension ends.
+     * If no value is provided, the local user will return to the group playback position.
+     *
+     * @remarks
+     * If there are other suspensions active, all other suspensions must be ended before group synchronization can resume.
+     */
+    end(seekTo?: number): void;
+}
+/**
+ * Wait point interface for a suspension.
+ *
+ * @remarks
+ * Used by {@link MediaSessionCoordinatorSuspension} to schedule a suspension at a specific media position.
+ */
+export interface CoordinationWaitPoint {
+    /**
+     * The position in milliseconds that the suspension should begin.
+     */
+    position: number;
+    /**
+     * Optional. The reason for the suspension.
+     */
+    reason?: string;
+    /**
+     * Optional. The max clients to wait for before a suspension ends.
+     */
+    maxClients?: number;
+}
+/**
+ * Event types of `LiveMediaSessionCoordinator`.
+ */
+export declare enum MediaSessionCoordinatorEvents {
+    /**
+     * Event emitted after the coordinator's state changed
+     */
+    coordinatorstatechange = "coordinatorstatechange",
+    /**
+     * Event emitted when an action was triggered.
+     */
+    triggeraction = "triggeraction",
+    /**
+     * Event emitted when an action would have been triggered, but a suspension is active for the local client.
+     */
+    triggeractionignored = "triggeractionignored"
+}
+/**
+ * Action types supported for `LiveMediaSession`.
+ *
+ * @remarks
+ * These types extend the default actions supported by the `MediaSession` specification in browsers.
+ * These additional actions help with group synchronization.
+ */
+export type ExtendedMediaSessionAction = MediaSessionAction | "settrack" | "ratechange" | "wait" | "catchup" | "datachange" | "blocked";
+/**
+ * Extended playback state for `LiveMediaSession`.
+ *
+ * @remarks
+ * These types extend the default state types supported by the `MediaSession` specification in browsers.
+ * These additional types help with group synchronization.
+ */
+export type ExtendedMediaSessionPlaybackState = MediaSessionPlaybackState | "suspended" | "waiting" | "ended";
+/**
+ * The source of the action for `LiveMediaSession`.
+ *
+ * @remarks
+ * Is `user` when the action was explicitly invoked via the `LiveMediaSessionCoordinator`.
+ * Is `system` when the action was invoked via `GroupCoordinatorState` when the local client is out of sync.
+ */
+export type ExtendedMediaSessionActionSource = "user" | "system";
+/**
+ * Metadata for `LiveMediaSession`.
+ *
+ * @remarks
+ * These types extend the default session metadata supported by the `MediaSession` specification in browsers.
+ * These additional types help with group synchronization.
+ */
+export interface ExtendedMediaMetadata extends MediaMetadata {
+    /**
+     * A unique identifier for the track (e.g., UUID, URL, etc.)
+     */
+    trackIdentifier: string;
+    /**
+     * Flag indicating whether or not the stream is a live broadcast.
+     */
+    liveStream?: boolean;
+}
+/**
+ * The reasons why an action is ignored.
+ *
+ * @remarks
+ * Is `localusersuspended` when the action updated the group state, but ignored locally due to the local client being suspended.
+
+ */
+export type ExtendedMediaSessionActionIgnore = "localusersuspended";
+/**
+ * Details for emitted actions from `LiveMediaSession`.
+ *
+ * @remarks
+ * These types extend the default event details supported by the `MediaSession` specification in browsers.
+ * These additional types help with group synchronization.
+ */
+export interface ExtendedMediaSessionActionDetails {
+    /**
+     * The action type of this event.
+     */
+    action: ExtendedMediaSessionAction;
+    /**
+     * The source of the action.
+     *
+     * @remarks
+     * Is `user` when the action was explicitly invoked via the `LiveMediaSessionCoordinator`.
+     * Is `system` when the action was invoked via `GroupCoordinatorState` when the local client is out of sync.
+     */
+    source: ExtendedMediaSessionActionSource;
+    /**
+     * Unique identifier of the client that triggered this action.
+     */
+    clientId: string;
+    /**
+     * Flag indicating whether or not the action was triggered by the local client.
+     */
+    local: boolean;
+    /**
+     * Flag indicating whether or not this was a fast seek action.
+     */
+    fastSeek?: boolean | null;
+    /**
+     * The offset of the seek.
+     */
+    seekOffset?: number | null;
+    /**
+     * Timestamp of the seek event.
+     */
+    seekTime?: number | null;
+    /**
+     * Updated session metadata that was changed via this action.
+     */
+    metadata?: ExtendedMediaMetadata | null;
+    /**
+     * Suspension associated with this action.
+     */
+    suspension?: MediaSessionCoordinatorSuspension | null;
+    /**
+     * Custom data associated with this action.
+     */
+    data?: object | null;
+    /**
+     * Reason an action is ignored by the local client, undefined if not ignored.
+     */
+    ignoreReason?: ExtendedMediaSessionActionIgnore | null;
+    playbackRate?: number | null;
+}
+/**
+ * Handler for `LiveMediaSession` actions.
+ */
+export interface ExtendedMediaSessionActionHandler {
+    (details: ExtendedMediaSessionActionDetails): void;
+}
+//# sourceMappingURL=MediaSessionExtensions.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"MediaSessionExtensions.d.ts","sourceRoot":"","sources":["../../src/MediaSessionExtensions.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH;;GAEG;AACH,MAAM,WAAW,iCAAiC;IAC9C;;;;;OAKG;IACH,SAAS,CAAC,EAAE,qBAAqB,CAAC;IAClC;;;;;;;;OAQG;IACH,GAAG,CAAC,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC9B;AAED;;;;;GAKG;AACH,MAAM,WAAW,qBAAqB;IAClC;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;CACvB;AAED;;GAEG;AACH,oBAAY,6BAA6B;IACrC;;OAEG;IACH,sBAAsB,2BAA2B;IACjD;;OAEG;IACH,aAAa,kBAAkB;IAC/B;;OAEG;IACH,oBAAoB,yBAAyB;CAChD;AAED;;;;;;GAMG;AACH,MAAM,MAAM,0BAA0B,GAChC,kBAAkB,GAClB,UAAU,GACV,YAAY,GACZ,MAAM,GACN,SAAS,GACT,YAAY,GACZ,SAAS,CAAC;AAEhB;;;;;;GAMG;AACH,MAAM,MAAM,iCAAiC,GACvC,yBAAyB,GACzB,WAAW,GACX,SAAS,GACT,OAAO,CAAC;AAEd;;;;;;GAMG;AACH,MAAM,MAAM,gCAAgC,GAAG,MAAM,GAAG,QAAQ,CAAC;AAEjE;;;;;;GAMG;AACH,MAAM,WAAW,qBAAsB,SAAQ,aAAa;IACxD;;OAEG;IACH,eAAe,EAAE,MAAM,CAAC;IACxB;;OAEG;IACH,UAAU,CAAC,EAAE,OAAO,CAAC;CACxB;AAED;;;;;;GAMG;AACH,MAAM,MAAM,gCAAgC,GAAG,oBAAoB,CAAC;AAEpE;;;;;;GAMG;AACH,MAAM,WAAW,iCAAiC;IAC9C;;OAEG;IACH,MAAM,EAAE,0BAA0B,CAAC;IACnC;;;;;;OAMG;IACH,MAAM,EAAE,gCAAgC,CAAC;IACzC;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,KAAK,EAAE,OAAO,CAAC;IACf;;OAEG;IACH,QAAQ,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IAC1B;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACzB;;OAEG;IACH,QAAQ,CAAC,EAAE,qBAAqB,GAAG,IAAI,CAAC;IACxC;;OAEG;IACH,UAAU,CAAC,EAAE,iCAAiC,GAAG,IAAI,CAAC;IACtD;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACrB;;OAEG;IACH,YAAY,CAAC,EAAE,gCAAgC,GAAG,IAAI,CAAC;IAEvD,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAChC;AAED;;GAEG;AACH,MAAM,WAAW,iCAAiC;IAC9C,CAAC,OAAO,EAAE,iCAAiC,GAAG,IAAI,CAAC;CACtD"}

package/bin/esm/MediaSessionExtensions.js

@@ -0,0 +1,23 @@
+/**
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the Microsoft Live Share SDK License.
+ */
+/**
+ * Event types of `LiveMediaSessionCoordinator`.
+ */
+export var MediaSessionCoordinatorEvents;
+(function (MediaSessionCoordinatorEvents) {
+    /**
+     * Event emitted after the coordinator's state changed
+     */
+    MediaSessionCoordinatorEvents["coordinatorstatechange"] = "coordinatorstatechange";
+    /**
+     * Event emitted when an action was triggered.
+     */
+    MediaSessionCoordinatorEvents["triggeraction"] = "triggeraction";
+    /**
+     * Event emitted when an action would have been triggered, but a suspension is active for the local client.
+     */
+    MediaSessionCoordinatorEvents["triggeractionignored"] = "triggeractionignored";
+})(MediaSessionCoordinatorEvents || (MediaSessionCoordinatorEvents = {}));
+//# sourceMappingURL=MediaSessionExtensions.js.map

package/bin/esm/MediaSessionExtensions.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"MediaSessionExtensions.js","sourceRoot":"","sources":["../../src/MediaSessionExtensions.ts"],"names":[],"mappings":"AAAA;;;GAGG;AA8CH;;GAEG;AACH,MAAM,CAAN,IAAY,6BAaX;AAbD,WAAY,6BAA6B;IACrC;;OAEG;IACH,kFAAiD,CAAA;IACjD;;OAEG;IACH,gEAA+B,CAAA;IAC/B;;OAEG;IACH,8EAA6C,CAAA;AACjD,CAAC,EAbW,6BAA6B,KAA7B,6BAA6B,QAaxC"}

package/bin/esm/RepeatedActionThrottler.d.ts

@@ -0,0 +1,20 @@
+/**
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the Microsoft Live Share SDK License.
+ */
+import { MediaSessionActionThrottler } from "./MediaSessionActionThrottler.js";
+import { ExtendedMediaSessionActionDetails } from "./MediaSessionExtensions.js";
+/**
+ *  A Throttler that passes through all actions but will only let an action be repeated once every 2 seconds.
+ */
+export declare class RepeatedActionThrottler extends MediaSessionActionThrottler {
+    private static FILTERED_ACTIONS;
+    private _repeatInterval;
+    private _lastActionSentTime?;
+    private _lastActionSent?;
+    get repeatInterval(): number;
+    set repeatInterval(value: number);
+    throttled(details: MediaSessionActionDetails | ExtendedMediaSessionActionDetails, handler?: MediaSessionActionHandler): void;
+    private getChangeKey;
+}
+//# sourceMappingURL=RepeatedActionThrottler.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"RepeatedActionThrottler.d.ts","sourceRoot":"","sources":["../../src/RepeatedActionThrottler.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,OAAO,EAAE,2BAA2B,EAAE,MAAM,kCAAkC,CAAC;AAC/E,OAAO,EACH,iCAAiC,EAEpC,MAAM,6BAA6B,CAAC;AAErC;;GAEG;AACH,qBAAa,uBAAwB,SAAQ,2BAA2B;IACpE,OAAO,CAAC,MAAM,CAAC,gBAAgB,CAK7B;IACF,OAAO,CAAC,eAAe,CAA0B;IACjD,OAAO,CAAC,mBAAmB,CAAC,CAAS;IACrC,OAAO,CAAC,eAAe,CAAC,CAAS;IAEjC,IAAW,cAAc,IAAI,MAAM,CAElC;IAED,IAAW,cAAc,CAAC,KAAK,EAAE,MAAM,EAEtC;IAEM,SAAS,CACZ,OAAO,EAAE,yBAAyB,GAAG,iCAAiC,EACtE,OAAO,CAAC,EAAE,yBAAyB,GACpC,IAAI;IA4BP,OAAO,CAAC,YAAY;CAUvB"}

package/bin/esm/RepeatedActionThrottler.js

@@ -0,0 +1,59 @@
+/**
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the Microsoft Live Share SDK License.
+ */
+import { TimeInterval } from "@microsoft/live-share";
+import { MediaSessionActionThrottler } from "./MediaSessionActionThrottler.js";
+/**
+ *  A Throttler that passes through all actions but will only let an action be repeated once every 2 seconds.
+ */
+export class RepeatedActionThrottler extends MediaSessionActionThrottler {
+    constructor() {
+        super(...arguments);
+        this._repeatInterval = new TimeInterval(2000);
+    }
+    get repeatInterval() {
+        return this._repeatInterval.seconds;
+    }
+    set repeatInterval(value) {
+        this._repeatInterval.seconds = value;
+    }
+    throttled(details, handler) {
+        if (handler) {
+            if (RepeatedActionThrottler.FILTERED_ACTIONS.indexOf(details.action) >= 0) {
+                const changeKey = this.getChangeKey(details);
+                const now = new Date().getTime();
+                if (this._lastActionSent && changeKey == this._lastActionSent) {
+                    if (now - this._lastActionSentTime >=
+                        this._repeatInterval.milliseconds) {
+                        handler(details);
+                        this._lastActionSentTime = now;
+                    }
+                }
+                else {
+                    handler(details);
+                    this._lastActionSent = changeKey;
+                    this._lastActionSentTime = now;
+                }
+            }
+            else {
+                handler(details);
+            }
+        }
+    }
+    getChangeKey(details) {
+        switch (details.action) {
+            case "seekto":
+                return `seekto:${details.seekTime}`;
+            default:
+                return details.action;
+        }
+    }
+}
+RepeatedActionThrottler.FILTERED_ACTIONS = [
+    "play",
+    "pause",
+    "seekto",
+    "catchup",
+];
+//# sourceMappingURL=RepeatedActionThrottler.js.map

package/bin/esm/RepeatedActionThrottler.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"RepeatedActionThrottler.js","sourceRoot":"","sources":["../../src/RepeatedActionThrottler.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,YAAY,EAAE,MAAM,uBAAuB,CAAC;AACrD,OAAO,EAAE,2BAA2B,EAAE,MAAM,kCAAkC,CAAC;AAM/E;;GAEG;AACH,MAAM,OAAO,uBAAwB,SAAQ,2BAA2B;IAAxE;;QAOY,oBAAe,GAAG,IAAI,YAAY,CAAC,IAAI,CAAC,CAAC;IAqDrD,CAAC;IAjDG,IAAW,cAAc;QACrB,OAAO,IAAI,CAAC,eAAe,CAAC,OAAO,CAAC;IACxC,CAAC;IAED,IAAW,cAAc,CAAC,KAAa;QACnC,IAAI,CAAC,eAAe,CAAC,OAAO,GAAG,KAAK,CAAC;IACzC,CAAC;IAEM,SAAS,CACZ,OAAsE,EACtE,OAAmC;QAEnC,IAAI,OAAO,EAAE,CAAC;YACV,IACI,uBAAuB,CAAC,gBAAgB,CAAC,OAAO,CAC5C,OAAO,CAAC,MAAM,CACjB,IAAI,CAAC,EACR,CAAC;gBACC,MAAM,SAAS,GAAG,IAAI,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC;gBAC7C,MAAM,GAAG,GAAG,IAAI,IAAI,EAAE,CAAC,OAAO,EAAE,CAAC;gBACjC,IAAI,IAAI,CAAC,eAAe,IAAI,SAAS,IAAI,IAAI,CAAC,eAAe,EAAE,CAAC;oBAC5D,IACI,GAAG,GAAG,IAAI,CAAC,mBAAoB;wBAC/B,IAAI,CAAC,eAAe,CAAC,YAAY,EACnC,CAAC;wBACC,OAAO,CAAC,OAAoC,CAAC,CAAC;wBAC9C,IAAI,CAAC,mBAAmB,GAAG,GAAG,CAAC;oBACnC,CAAC;gBACL,CAAC;qBAAM,CAAC;oBACJ,OAAO,CAAC,OAAoC,CAAC,CAAC;oBAC9C,IAAI,CAAC,eAAe,GAAG,SAAS,CAAC;oBACjC,IAAI,CAAC,mBAAmB,GAAG,GAAG,CAAC;gBACnC,CAAC;YACL,CAAC;iBAAM,CAAC;gBACJ,OAAO,CAAC,OAAoC,CAAC,CAAC;YAClD,CAAC;QACL,CAAC;IACL,CAAC;IAEO,YAAY,CAChB,OAAsE;QAEtE,QAAQ,OAAO,CAAC,MAAM,EAAE,CAAC;YACrB,KAAK,QAAQ;gBACT,OAAO,UAAU,OAAO,CAAC,QAAQ,EAAE,CAAC;YACxC;gBACI,OAAO,OAAO,CAAC,MAAM,CAAC;QAC9B,CAAC;IACL,CAAC;;AA1Dc,wCAAgB,GAAiC;IAC5D,MAAM;IACN,OAAO;IACP,QAAQ;IACR,SAAS;CACZ,AAL8B,CAK7B"}

package/bin/esm/VolumeManager.d.ts

@@ -0,0 +1,84 @@
+/**
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the Microsoft Live Share SDK License.
+ */
+import { IMediaPlayer } from "./IMediaPlayer.js";
+export declare enum LimitLevelType {
+    fixed = 0,
+    percentage = 1
+}
+/**
+ * Smooth audio level changes when volume is modified, or if volume limiting has started/ended.
+ */
+export declare class VolumeManager {
+    private readonly _player;
+    private readonly _volumeChangeDuration;
+    private _volume;
+    private _isLimiting;
+    private _limitLevel;
+    private _limitLevelType;
+    private _startTime;
+    private _startVolume;
+    private _running;
+    constructor(player: IMediaPlayer);
+    /**
+     * The selected volume.
+     *
+     * @remarks
+     * Expressed as a value between 0.0 and 1.0. The default value is 1.0.
+     * Can be used for things like volume sliders.
+     *
+     * Does not return the current volume if limiting is enabled, but the desired volume.
+     */
+    get volume(): number;
+    set volume(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
+     * @see LimitLevelType. The default value is 0.1.
+     *
+     * For a level type of @see LimitLevelType.fixed the value is the exact level the volume will be
+     * lowered to. The default value of 0.1 would cause the volume to be lowered to 0.1.
+     *
+     * For a level type of @see LimitLevelType.percentage the value is the percentage by which the volume
+     * level should be lowered to. The default value of 0.1 would cause the volume to be lowered
+     * to 10% of its starting value.
+     */
+    get limitLevel(): number;
+    set limitLevel(value: number);
+    /**
+     * The type of level represented by the `limitLevel` property.
+     */
+    get limitLevelType(): LimitLevelType;
+    set limitLevelType(value: LimitLevelType);
+    /**
+     * Amount of time, in seconds, it should take to change the volume up or down to the desired level.
+     *
+     * @remarks
+     * Default `volumeChangeDuration` is 0.5 seconds.
+     */
+    get volumeChangeDuration(): number;
+    set volumeChangeDuration(value: number);
+    /**
+     * Whether or not volume limiting is currently enabled.
+     */
+    get isLimiting(): boolean;
+    /**
+     * Limits volume based on `limitLevel` and `limitLevelType` properties.
+     * @see limitLevel
+     * @see limitLevelType
+     */
+    startLimiting(): void;
+    /**
+     * Disables volume limit.
+     */
+    stopLimiting(): void;
+    private startAdjusting;
+    private scheduleAnimationFrame;
+    private computeInterpolatedVolume;
+    private computeTargetVolume;
+    private millisSinceVolumeChangeStart;
+}
+//# sourceMappingURL=VolumeManager.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"VolumeManager.d.ts","sourceRoot":"","sources":["../../src/VolumeManager.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,OAAO,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AAEjD,oBAAY,cAAc;IACtB,KAAK,IAAA;IACL,UAAU,IAAA;CACb;AAED;;GAEG;AACH,qBAAa,aAAa;IACtB,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAe;IACvC,OAAO,CAAC,QAAQ,CAAC,qBAAqB,CAAyB;IAG/D,OAAO,CAAC,OAAO,CAAO;IACtB,OAAO,CAAC,WAAW,CAAS;IAC5B,OAAO,CAAC,WAAW,CAAO;IAC1B,OAAO,CAAC,eAAe,CAAwC;IAC/D,OAAO,CAAC,UAAU,CAAK;IACvB,OAAO,CAAC,YAAY,CAAK;IACzB,OAAO,CAAC,QAAQ,CAAS;gBAEb,MAAM,EAAE,YAAY;IAKhC;;;;;;;;OAQG;IACH,IAAW,MAAM,IAAI,MAAM,CAE1B;IAED,IAAW,MAAM,CAAC,KAAK,EAAE,MAAM,EAS9B;IAED;;;;;;;;;;;;;OAaG;IACH,IAAW,UAAU,IAAI,MAAM,CAE9B;IAED,IAAW,UAAU,CAAC,KAAK,EAAE,MAAM,EAQlC;IAED;;OAEG;IACH,IAAW,cAAc,IAAI,cAAc,CAE1C;IAED,IAAW,cAAc,CAAC,KAAK,EAAE,cAAc,EAE9C;IAED;;;;;OAKG;IACH,IAAW,oBAAoB,IAAI,MAAM,CAExC;IAED,IAAW,oBAAoB,CAAC,KAAK,EAAE,MAAM,EAE5C;IAED;;OAEG;IACH,IAAW,UAAU,IAAI,OAAO,CAE/B;IAED;;;;OAIG;IACI,aAAa,IAAI,IAAI;IAK5B;;OAEG;IACI,YAAY,IAAI,IAAI;IAK3B,OAAO,CAAC,cAAc;IAuBtB,OAAO,CAAC,sBAAsB;IAW9B,OAAO,CAAC,yBAAyB;IASjC,OAAO,CAAC,mBAAmB;IAgB3B,OAAO,CAAC,4BAA4B;CAIvC"}

package/bin/esm/VolumeManager.js

@@ -0,0 +1,171 @@
+/**
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the Microsoft Live Share SDK License.
+ */
+import { TimeInterval } from "@microsoft/live-share";
+export var LimitLevelType;
+(function (LimitLevelType) {
+    LimitLevelType[LimitLevelType["fixed"] = 0] = "fixed";
+    LimitLevelType[LimitLevelType["percentage"] = 1] = "percentage";
+})(LimitLevelType || (LimitLevelType = {}));
+/**
+ * Smooth audio level changes when volume is modified, or if volume limiting has started/ended.
+ */
+export class VolumeManager {
+    constructor(player) {
+        this._volumeChangeDuration = new TimeInterval(500);
+        // defaults to player volume
+        this._volume = 0.0;
+        this._isLimiting = false;
+        this._limitLevel = 0.1;
+        this._limitLevelType = LimitLevelType.fixed;
+        this._startTime = 0;
+        this._startVolume = 0;
+        this._running = false;
+        this._player = player;
+        this._volume = this._player.volume;
+    }
+    /**
+     * The selected volume.
+     *
+     * @remarks
+     * Expressed as a value between 0.0 and 1.0. The default value is 1.0.
+     * Can be used for things like volume sliders.
+     *
+     * Does not return the current volume if limiting is enabled, but the desired volume.
+     */
+    get volume() {
+        return this._volume;
+    }
+    set volume(value) {
+        if (value < 0 || value > 1.0) {
+            throw new Error(`VolumeManager: cannot set volume to ${value}. Level must be between 0.0 and 1.0.`);
+        }
+        this._volume = value;
+        this.startAdjusting();
+    }
+    /**
+     * 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
+     * @see LimitLevelType. The default value is 0.1.
+     *
+     * For a level type of @see LimitLevelType.fixed the value is the exact level the volume will be
+     * lowered to. The default value of 0.1 would cause the volume to be lowered to 0.1.
+     *
+     * For a level type of @see LimitLevelType.percentage the value is the percentage by which the volume
+     * level should be lowered to. The default value of 0.1 would cause the volume to be lowered
+     * to 10% of its starting value.
+     */
+    get limitLevel() {
+        return this._limitLevel;
+    }
+    set limitLevel(value) {
+        if (value < 0 || value > 1.0) {
+            throw new Error(`VolumeManager: cannot set level to ${value}. Level must be between 0.0 and 1.0.`);
+        }
+        this._limitLevel = value;
+    }
+    /**
+     * The type of level represented by the `limitLevel` property.
+     */
+    get limitLevelType() {
+        return this._limitLevelType;
+    }
+    set limitLevelType(value) {
+        this._limitLevelType = value;
+    }
+    /**
+     * Amount of time, in seconds, it should take to change the volume up or down to the desired level.
+     *
+     * @remarks
+     * Default `volumeChangeDuration` is 0.5 seconds.
+     */
+    get volumeChangeDuration() {
+        return this._volumeChangeDuration.seconds;
+    }
+    set volumeChangeDuration(value) {
+        this._volumeChangeDuration.seconds = Math.abs(value);
+    }
+    /**
+     * Whether or not volume limiting is currently enabled.
+     */
+    get isLimiting() {
+        return this._isLimiting;
+    }
+    /**
+     * Limits volume based on `limitLevel` and `limitLevelType` properties.
+     * @see limitLevel
+     * @see limitLevelType
+     */
+    startLimiting() {
+        this._isLimiting = true;
+        this.startAdjusting();
+    }
+    /**
+     * Disables volume limit.
+     */
+    stopLimiting() {
+        this._isLimiting = false;
+        this.startAdjusting();
+    }
+    startAdjusting() {
+        const adjustVolume = () => {
+            // Schedule next animation frame if volume change not finished
+            if (this.millisSinceVolumeChangeStart() <=
+                this._volumeChangeDuration.milliseconds) {
+                this._player.volume = this.computeInterpolatedVolume();
+                this.scheduleAnimationFrame(adjustVolume);
+            }
+            else {
+                this._player.volume = this.computeTargetVolume();
+                this._running = false;
+            }
+        };
+        this._startTime = new Date().getTime();
+        this._startVolume = this._player.volume;
+        if (!this._running) {
+            this._running = true;
+            this.scheduleAnimationFrame(adjustVolume);
+        }
+    }
+    scheduleAnimationFrame(callback) {
+        if (typeof requestAnimationFrame == "function") {
+            requestAnimationFrame(callback);
+        }
+        else {
+            setTimeout(callback, Math.min(this._volumeChangeDuration.milliseconds / 25, 20));
+        }
+    }
+    computeInterpolatedVolume() {
+        const volumeChangeMillis = this._volumeChangeDuration.milliseconds;
+        const volumeDifference = this.computeTargetVolume() - this._startVolume;
+        const adjustmentFromStart = (volumeDifference / volumeChangeMillis) *
+            this.millisSinceVolumeChangeStart();
+        return this._startVolume + adjustmentFromStart;
+    }
+    computeTargetVolume() {
+        if (this._limitLevelType == LimitLevelType.percentage) {
+            if (this._isLimiting) {
+                return this._volume * this._limitLevel;
+            }
+            else {
+                return this._volume;
+            }
+        }
+        else {
+            if (this._isLimiting && this._volume > this._limitLevel) {
+                return this._limitLevel;
+            }
+            else {
+                return this._volume;
+            }
+        }
+    }
+    millisSinceVolumeChangeStart() {
+        const now = new Date().getTime();
+        return now - this._startTime;
+    }
+}
+//# sourceMappingURL=VolumeManager.js.map

package/bin/esm/VolumeManager.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"VolumeManager.js","sourceRoot":"","sources":["../../src/VolumeManager.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,YAAY,EAAE,MAAM,uBAAuB,CAAC;AAGrD,MAAM,CAAN,IAAY,cAGX;AAHD,WAAY,cAAc;IACtB,qDAAK,CAAA;IACL,+DAAU,CAAA;AACd,CAAC,EAHW,cAAc,KAAd,cAAc,QAGzB;AAED;;GAEG;AACH,MAAM,OAAO,aAAa;IAatB,YAAY,MAAoB;QAXf,0BAAqB,GAAG,IAAI,YAAY,CAAC,GAAG,CAAC,CAAC;QAE/D,4BAA4B;QACpB,YAAO,GAAG,GAAG,CAAC;QACd,gBAAW,GAAG,KAAK,CAAC;QACpB,gBAAW,GAAG,GAAG,CAAC;QAClB,oBAAe,GAAmB,cAAc,CAAC,KAAK,CAAC;QACvD,eAAU,GAAG,CAAC,CAAC;QACf,iBAAY,GAAG,CAAC,CAAC;QACjB,aAAQ,GAAG,KAAK,CAAC;QAGrB,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC;QACtB,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC;IACvC,CAAC;IAED;;;;;;;;OAQG;IACH,IAAW,MAAM;QACb,OAAO,IAAI,CAAC,OAAO,CAAC;IACxB,CAAC;IAED,IAAW,MAAM,CAAC,KAAa;QAC3B,IAAI,KAAK,GAAG,CAAC,IAAI,KAAK,GAAG,GAAG,EAAE,CAAC;YAC3B,MAAM,IAAI,KAAK,CACX,uCAAuC,KAAK,sCAAsC,CACrF,CAAC;QACN,CAAC;QAED,IAAI,CAAC,OAAO,GAAG,KAAK,CAAC;QACrB,IAAI,CAAC,cAAc,EAAE,CAAC;IAC1B,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,IAAW,UAAU;QACjB,OAAO,IAAI,CAAC,WAAW,CAAC;IAC5B,CAAC;IAED,IAAW,UAAU,CAAC,KAAa;QAC/B,IAAI,KAAK,GAAG,CAAC,IAAI,KAAK,GAAG,GAAG,EAAE,CAAC;YAC3B,MAAM,IAAI,KAAK,CACX,sCAAsC,KAAK,sCAAsC,CACpF,CAAC;QACN,CAAC;QAED,IAAI,CAAC,WAAW,GAAG,KAAK,CAAC;IAC7B,CAAC;IAED;;OAEG;IACH,IAAW,cAAc;QACrB,OAAO,IAAI,CAAC,eAAe,CAAC;IAChC,CAAC;IAED,IAAW,cAAc,CAAC,KAAqB;QAC3C,IAAI,CAAC,eAAe,GAAG,KAAK,CAAC;IACjC,CAAC;IAED;;;;;OAKG;IACH,IAAW,oBAAoB;QAC3B,OAAO,IAAI,CAAC,qBAAqB,CAAC,OAAO,CAAC;IAC9C,CAAC;IAED,IAAW,oBAAoB,CAAC,KAAa;QACzC,IAAI,CAAC,qBAAqB,CAAC,OAAO,GAAG,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;IACzD,CAAC;IAED;;OAEG;IACH,IAAW,UAAU;QACjB,OAAO,IAAI,CAAC,WAAW,CAAC;IAC5B,CAAC;IAED;;;;OAIG;IACI,aAAa;QAChB,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC;QACxB,IAAI,CAAC,cAAc,EAAE,CAAC;IAC1B,CAAC;IAED;;OAEG;IACI,YAAY;QACf,IAAI,CAAC,WAAW,GAAG,KAAK,CAAC;QACzB,IAAI,CAAC,cAAc,EAAE,CAAC;IAC1B,CAAC;IAEO,cAAc;QAClB,MAAM,YAAY,GAAG,GAAG,EAAE;YACtB,8DAA8D;YAC9D,IACI,IAAI,CAAC,4BAA4B,EAAE;gBACnC,IAAI,CAAC,qBAAqB,CAAC,YAAY,EACzC,CAAC;gBACC,IAAI,CAAC,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC,yBAAyB,EAAE,CAAC;gBACvD,IAAI,CAAC,sBAAsB,CAAC,YAAY,CAAC,CAAC;YAC9C,CAAC;iBAAM,CAAC;gBACJ,IAAI,CAAC,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC,mBAAmB,EAAE,CAAC;gBACjD,IAAI,CAAC,QAAQ,GAAG,KAAK,CAAC;YAC1B,CAAC;QACL,CAAC,CAAC;QAEF,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,IAAI,CAAC,QAAQ,EAAE,CAAC;YACjB,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC;YACrB,IAAI,CAAC,sBAAsB,CAAC,YAAY,CAAC,CAAC;QAC9C,CAAC;IACL,CAAC;IAEO,sBAAsB,CAAC,QAA8B;QACzD,IAAI,OAAO,qBAAqB,IAAI,UAAU,EAAE,CAAC;YAC7C,qBAAqB,CAAC,QAAQ,CAAC,CAAC;QACpC,CAAC;aAAM,CAAC;YACJ,UAAU,CACN,QAAQ,EACR,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,qBAAqB,CAAC,YAAY,GAAG,EAAE,EAAE,EAAE,CAAC,CAC7D,CAAC;QACN,CAAC;IACL,CAAC;IAEO,yBAAyB;QAC7B,MAAM,kBAAkB,GAAG,IAAI,CAAC,qBAAqB,CAAC,YAAY,CAAC;QACnE,MAAM,gBAAgB,GAAG,IAAI,CAAC,mBAAmB,EAAE,GAAG,IAAI,CAAC,YAAY,CAAC;QACxE,MAAM,mBAAmB,GACrB,CAAC,gBAAgB,GAAG,kBAAkB,CAAC;YACvC,IAAI,CAAC,4BAA4B,EAAE,CAAC;QACxC,OAAO,IAAI,CAAC,YAAY,GAAG,mBAAmB,CAAC;IACnD,CAAC;IAEO,mBAAmB;QACvB,IAAI,IAAI,CAAC,eAAe,IAAI,cAAc,CAAC,UAAU,EAAE,CAAC;YACpD,IAAI,IAAI,CAAC,WAAW,EAAE,CAAC;gBACnB,OAAO,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC,WAAW,CAAC;YAC3C,CAAC;iBAAM,CAAC;gBACJ,OAAO,IAAI,CAAC,OAAO,CAAC;YACxB,CAAC;QACL,CAAC;aAAM,CAAC;YACJ,IAAI,IAAI,CAAC,WAAW,IAAI,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC,WAAW,EAAE,CAAC;gBACtD,OAAO,IAAI,CAAC,WAAW,CAAC;YAC5B,CAAC;iBAAM,CAAC;gBACJ,OAAO,IAAI,CAAC,OAAO,CAAC;YACxB,CAAC;QACL,CAAC;IACL,CAAC;IAEO,4BAA4B;QAChC,MAAM,GAAG,GAAG,IAAI,IAAI,EAAE,CAAC,OAAO,EAAE,CAAC;QACjC,OAAO,GAAG,GAAG,IAAI,CAAC,UAAU,CAAC;IACjC,CAAC;CACJ"}

package/bin/esm/index.d.ts

@@ -0,0 +1,14 @@
+/**
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the Microsoft Live Share SDK License.
+ */
+export * from "./LiveMediaSession.js";
+export * from "./LiveMediaSessionCoordinator.js";
+export * from "./LiveMediaSessionCoordinatorSuspension.js";
+export * from "./IMediaPlayer.js";
+export * from "./MediaPlayerSynchronizer.js";
+export * from "./MediaSessionActionThrottler.js";
+export * from "./MediaSessionExtensions.js";
+export * from "./RepeatedActionThrottler.js";
+export * from "./VolumeManager.js";
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,cAAc,uBAAuB,CAAC;AACtC,cAAc,kCAAkC,CAAC;AACjD,cAAc,4CAA4C,CAAC;AAC3D,cAAc,mBAAmB,CAAC;AAClC,cAAc,8BAA8B,CAAC;AAC7C,cAAc,kCAAkC,CAAC;AACjD,cAAc,6BAA6B,CAAC;AAC5C,cAAc,8BAA8B,CAAC;AAC7C,cAAc,oBAAoB,CAAC"}

package/bin/esm/index.js

@@ -0,0 +1,14 @@
+/**
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the Microsoft Live Share SDK License.
+ */
+export * from "./LiveMediaSession.js";
+export * from "./LiveMediaSessionCoordinator.js";
+export * from "./LiveMediaSessionCoordinatorSuspension.js";
+export * from "./IMediaPlayer.js";
+export * from "./MediaPlayerSynchronizer.js";
+export * from "./MediaSessionActionThrottler.js";
+export * from "./MediaSessionExtensions.js";
+export * from "./RepeatedActionThrottler.js";
+export * from "./VolumeManager.js";
+//# sourceMappingURL=index.js.map

package/bin/esm/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,cAAc,uBAAuB,CAAC;AACtC,cAAc,kCAAkC,CAAC;AACjD,cAAc,4CAA4C,CAAC;AAC3D,cAAc,mBAAmB,CAAC;AAClC,cAAc,8BAA8B,CAAC;AAC7C,cAAc,kCAAkC,CAAC;AACjD,cAAc,6BAA6B,CAAC;AAC5C,cAAc,8BAA8B,CAAC;AAC7C,cAAc,oBAAoB,CAAC"}