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

package/bin/VolumeLimiter.js

@@ -1,170 +0,0 @@
-"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

@@ -1 +0,0 @@
-{"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/src/EphemeralMediaSession.ts

@@ -1,248 +0,0 @@
-/**
- * Copyright (c) Microsoft Corporation. All rights reserved.
- * Licensed under the Microsoft Live Share SDK License.
- */
-
-import { DataObject, DataObjectFactory } from '@fluidframework/aqueduct';
-import { EphemeralTelemetryLogger, UserMeetingRole } from '@microsoft/live-share';
-import { MediaPlayerSynchronizer } from './MediaPlayerSynchronizer';
-import { ITriggerActionEvent, TelemetryEvents } from './internals';
-import { MediaSessionCoordinatorEvents, ExtendedMediaSessionAction, ExtendedMediaSessionActionDetails } from './MediaSessionExtensions';
-import { EphemeralMediaSessionCoordinator, IMediaPlayerState } from './EphemeralMediaSessionCoordinator';
-import { MediaSessionActionThrottler } from './MediaSessionActionThrottler';
-import { RepeatedActionThrottler } from './RepeatedActionThrottler';
-import { IMediaPlayer } from './IMediaPlayer';
-
-/**
- * Ephemeral fluid object that synchronizes media playback across multiple clients.
- */
- export class EphemeralMediaSession extends DataObject {
-    private _actionThrottler: MediaSessionActionThrottler = new RepeatedActionThrottler();
-    private _logger?: EphemeralTelemetryLogger;
-    private _requestPlayerStateHandler?: () => IMediaPlayerState;
-    private _coordinator?: EphemeralMediaSessionCoordinator;
-    private readonly _actionHandlers: Map<string, MediaSessionActionHandler> = new Map();
-    private _synchronizing?: MediaPlayerSynchronizer;
-
-    // Position update timer
-    private _updateTimer: any;
-    private _lastUpdateTime: number = 0;
-    
-    /**
-     * The objects fluid type name.
-     */
-     public static readonly TypeName = `@microsoft/fluid-media:SharedMediaSession`;
-
-    /**
-     * The objects fluid type factory.
-     */
-     public static readonly factory = new DataObjectFactory(
-        EphemeralMediaSession.TypeName,
-        EphemeralMediaSession,
-        [],
-        {}
-    );
-
-    /**
-     * Extension point that lets applications replace the default logic for throttling the sessions
-     * local sync behavior.
-     * 
-     * @remarks
-     * The `EphemeralMediaCoordinator` is fairly aggressive at wanting to keep the local media player 
-     * in sync with the rest of the group. This aggressiveness can result in the coordinator sending 
-     * new sync actions before the local player has finished responding to the previous sync action. 
-     * The `ActionThrottler` gives apps fine grain control over how aggressive they want sync to be.
-     * 
-     * By default, a `RepeatedAction` throttler is used which prevents the same sync action from 
-     * being sent within an adjustable time period.    
-     */
-    public get actionThrottler(): MediaSessionActionThrottler {
-        return this._actionThrottler;
-    }
-
-    public set actionThrottler(value: MediaSessionActionThrottler) {
-        this._actionThrottler = value;
-    }
-
-    /**
-     * Returns true if the object has been initialized.
-     */
-    public get isInitialized(): boolean {
-        return this.coordinator.isInitialized;
-    }
-
-    /**
-     * @deprecated isInitialized should be used instead
-     * Returns true if the object has been initialized.
-     */
-    public get isStarted(): boolean {
-        return this.isInitialized
-    }
-
-    /**
-     * The group coordinator for the session.
-     */
-    public get coordinator(): EphemeralMediaSessionCoordinator {
-        return this._coordinator!;
-    }
-
-    /**
-     * Returns the logger used by the session and coordinator.
-     * 
-     * @remarks
-     * This is used by the `MediaPlayerSynchronizer` to log events.
-     */
-    public get logger(): EphemeralTelemetryLogger {
-        return this._logger!;
-    }
-
-    /**
-     * initialize the object.
-     * @param acceptTransportChangesFrom Optional. List of roles allowed to group transport 
-     * operations like play/pause/seek/setTrack.
-     */
-     public initialize(acceptTransportChangesFrom?: UserMeetingRole[]): Promise<void> {
-        return this.coordinator.initialize(acceptTransportChangesFrom);
-    }
-
-    /**
-     * @deprecated initialize should be used instead
-     * initialize the object.
-     * @param acceptTransportChangesFrom Optional. List of roles allowed to group transport 
-     * operations like play/pause/seek/setTrack.
-     */
-    public start(acceptTransportChangesFrom?: UserMeetingRole[]): Promise<void> {
-        return this.initialize(acceptTransportChangesFrom)
-    }
-
-    /**
-     * Registers an action handler with the session.
-     * @param action Name of the action to register a handler for.
-     * @param handler Function called when the action is triggered.
-     */
-    public setActionHandler(action: ExtendedMediaSessionAction, handler: MediaSessionActionHandler | null): void {
-        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. 
-     */
-    public setRequestPlayerStateHandler(handler: () => IMediaPlayerState) {
-        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.
-     */
-    public synchronize(player: IMediaPlayer): MediaPlayerSynchronizer {
-        // 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._synchronizing = undefined;
-        });
-    }
-
-    protected async hasInitialized(): Promise<void> {
-        this. _logger = new EphemeralTelemetryLogger(this.runtime);
-
-        // Create coordinator and listen for triggered actions
-        this._coordinator = new EphemeralMediaSessionCoordinator(this.runtime, () => this.getCurrentPlayerState());
-        this._coordinator.on(MediaSessionCoordinatorEvents.triggeraction, (event: ITriggerActionEvent) => {
-            // 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 '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);
-        });
-    }
-
-    private checkWaitPointHit(state: IMediaPlayerState): void {
-        // Was a wait point hit?
-        if (state.positionState && this.coordinator.isInitialized) {
-            const waitPoint = this.coordinator.findNextWaitPoint();
-            if (waitPoint && state.positionState.position != undefined && state.positionState.position >= waitPoint.position) {
-                // Ensure handler registered
-                if (!this._actionHandlers.has('wait')) {
-                    throw new Error(`SharedMediaSession: wait point hit but no 'wait' action registered.`);
-                }
-
-                // Begin suspension for wait point
-                const suspension = this.coordinator.beginSuspension(waitPoint);
-                this.dispatchAction({action: 'wait', suspension: suspension});
-            }
-        }
-    }
-
-    private getCurrentPlayerState(): IMediaPlayerState {
-        if (!this._requestPlayerStateHandler) {
-            throw new Error(`SharedMediaSession: no getPlayerState callback configured.`);
-        }
-
-        return this._requestPlayerStateHandler();
-    }
-
-    private dispatchAction(details: MediaSessionActionDetails|ExtendedMediaSessionActionDetails): void {
-        if (this._actionHandlers.has(details.action)) {
-            const handler = this._actionHandlers.get(details.action);
-            this._actionThrottler.throttled(details, handler);
-        }
-    }
-}