@microsoft/live-share-media 1.0.0-preview.12 → 1.0.0-preview.14

package/README.md

@@ -113,7 +113,7 @@ The Live Share SDK contains dependencies for [@microsoft/teams-js](https://www.n
 
 | @microsoft/live-share | @microsoft/teams-js  | fluid-framework | @microsoft/live-share-\*   | @fluidframework/azure-client | @microsoft/TeamsFx              | @microsoft/TeamsFx-react        |
 | --------------------- | -------------------- | --------------- | -------------------------- | ---------------------------- | ------------------------------- | ------------------------------- |
-| 1.0.0-preview.12       | ^2.11.0              | ^1.2.3          | 1.0.0-preview.12 (optional) | ^1.0.0 (optional)            | ^2.5.0 (optional)               | ^2.5.0 (optional)               |
+| 1.0.0-preview.14       | ^2.11.0              | ^1.2.3          | 1.0.0-preview.14 (optional) | ^1.0.0 (optional)            | ^2.5.0 (optional)               | ^2.5.0 (optional)               |
 | 1.0.0-preview.10       | ^2.10.1              | ~1.2.3          | 1.0.0-preview.10 (optional) | ~1.0.2 (optional)            | ^2.5.0 (optional)               | ^2.5.0 (optional)               |
 | 1.0.0-preview.8       | ^2.5.0               | ~1.2.3          | 1.0.0-preview.10 (optional) | ~1.0.2 (optional)            | ^2.5.0 (optional)               | ^2.5.0 (optional)               |
 | 1.0.0-preview.3       | 2.0.0-experimental.1 | ~1.2.3          | 1.0.0-preview.3 (optional) | ~1.0.2 (optional)            | 2.0.0-experimental.0 (optional) | 2.0.0-experimental.0 (optional) |

package/bin/IMediaPlayer.d.ts

@@ -1,21 +1,21 @@
-/**
- * Copyright (c) Microsoft Corporation. All rights reserved.
- * Licensed under the Microsoft Live Share SDK License.
- */
-export interface IMediaPlayer {
-    readonly currentSrc: string;
-    currentTime: number;
-    readonly duration: number;
-    readonly ended: boolean;
-    muted: boolean;
-    readonly paused: boolean;
-    playbackRate: number;
-    src: string;
-    volume: number;
-    load(): void;
-    pause(): void;
-    play(): Promise<void>;
-    addEventListener(type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void;
-    removeEventListener(type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void;
-}
+/**
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the Microsoft Live Share SDK License.
+ */
+export interface IMediaPlayer {
+    readonly currentSrc: string;
+    currentTime: number;
+    readonly duration: number;
+    readonly ended: boolean;
+    muted: boolean;
+    readonly paused: boolean;
+    playbackRate: number;
+    src: string;
+    volume: number;
+    load(): void;
+    pause(): void;
+    play(): Promise<void>;
+    addEventListener(type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void;
+    removeEventListener(type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void;
+}
 //# sourceMappingURL=IMediaPlayer.d.ts.map

package/bin/IMediaPlayer.js

@@ -1,7 +1,7 @@
-"use strict";
-/**
- * Copyright (c) Microsoft Corporation. All rights reserved.
- * Licensed under the Microsoft Live Share SDK License.
- */
-Object.defineProperty(exports, "__esModule", { value: true });
+"use strict";
+/**
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the Microsoft Live Share SDK License.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
 //# sourceMappingURL=IMediaPlayer.js.map

package/bin/LiveMediaSession.d.ts

@@ -1,95 +1,96 @@
-/**
- * Copyright (c) Microsoft Corporation. All rights reserved.
- * Licensed under the Microsoft Live Share SDK License.
- */
-import { DataObject, DataObjectFactory } from "@fluidframework/aqueduct";
-import { LiveTelemetryLogger, UserMeetingRole } from "@microsoft/live-share";
-import { MediaPlayerSynchronizer } from "./MediaPlayerSynchronizer";
-import { ExtendedMediaSessionAction } from "./MediaSessionExtensions";
-import { LiveMediaSessionCoordinator, IMediaPlayerState } from "./LiveMediaSessionCoordinator";
-import { MediaSessionActionThrottler } from "./MediaSessionActionThrottler";
-import { IMediaPlayer } from "./IMediaPlayer";
-/**
- * Live fluid object that synchronizes media playback across multiple clients.
- */
-export declare class LiveMediaSession extends DataObject {
-    private _actionThrottler;
-    private _logger?;
-    private _requestPlayerStateHandler?;
-    private _coordinator?;
-    private readonly _actionHandlers;
-    private _synchronizing?;
-    private _updateTimer;
-    private _lastUpdateTime;
-    /**
-     * The objects fluid type name.
-     */
-    static readonly TypeName = "@microsoft/fluid-media:SharedMediaSession";
-    /**
-     * The objects fluid type factory.
-     */
-    static readonly factory: DataObjectFactory<LiveMediaSession, import("@fluidframework/aqueduct").DataObjectTypes>;
-    /**
-     * Extension point that lets applications replace the default logic for throttling the sessions
-     * local sync behavior.
-     *
-     * @remarks
-     * The `LiveMediaCoordinator` is fairly aggressive at wanting to keep the local media player
-     * in sync with the rest of the group. This aggressiveness can result in the coordinator sending
-     * new sync actions before the local player has finished responding to the previous sync action.
-     * The `ActionThrottler` gives apps fine grain control over how aggressive they want sync to be.
-     *
-     * By default, a `RepeatedAction` throttler is used which prevents the same sync action from
-     * being sent within an adjustable time period.
-     */
-    get actionThrottler(): MediaSessionActionThrottler;
-    set actionThrottler(value: MediaSessionActionThrottler);
-    /**
-     * Returns true if the object has been initialized.
-     */
-    get isInitialized(): boolean;
-    /**
-     * @deprecated isInitialized should be used instead
-     * Returns true if the object has been initialized.
-     */
-    get isStarted(): boolean;
-    /**
-     * The group coordinator for the session.
-     */
-    get coordinator(): LiveMediaSessionCoordinator;
-    /**
-     * Returns the logger used by the session and coordinator.
-     *
-     * @remarks
-     * This is used by the `MediaPlayerSynchronizer` to log events.
-     */
-    get logger(): LiveTelemetryLogger;
-    /**
-     * initialize the object.
-     * @param acceptTransportChangesFrom Optional. List of roles allowed to group transport
-     * operations like play/pause/seek/setTrack.
-     */
-    initialize(acceptTransportChangesFrom?: UserMeetingRole[]): Promise<void>;
-    /**
-     * Registers an action handler with the session.
-     * @param action Name of the action to register a handler for.
-     * @param handler Function called when the action is triggered.
-     */
-    setActionHandler(action: ExtendedMediaSessionAction, handler: MediaSessionActionHandler | null): void;
-    /**
-     * Registers a handler that will be queried anytime the group coordinate needs to know the
-     * local players transport state and position.
-     */
-    setRequestPlayerStateHandler(handler: () => IMediaPlayerState): void;
-    /**
-     * Begins synchronizing the playback of a media element.
-     * @param player Something that "looks like" and HTML Media Element.
-     * @returns A new synchronizer instance. Call `synchronizer.end()` to stop synchronizing the elements playback.
-     */
-    synchronize(player: IMediaPlayer): MediaPlayerSynchronizer;
-    protected hasInitialized(): Promise<void>;
-    private checkWaitPointHit;
-    private getCurrentPlayerState;
-    private dispatchAction;
-}
+/**
+ * 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 } from "./MediaSessionExtensions";
+import { LiveMediaSessionCoordinator, IMediaPlayerState } from "./LiveMediaSessionCoordinator";
+import { MediaSessionActionThrottler } from "./MediaSessionActionThrottler";
+import { IMediaPlayer } from "./IMediaPlayer";
+/**
+ * Live fluid object that synchronizes media playback across multiple clients.
+ */
+export declare class LiveMediaSession extends LiveDataObject {
+    private _actionThrottler;
+    private _logger?;
+    private _requestPlayerStateHandler?;
+    private _coordinator?;
+    private readonly _actionHandlers;
+    private _synchronizing?;
+    private _updateTimer;
+    private _lastUpdateTime;
+    /**
+     * The objects fluid type name.
+     */
+    static readonly TypeName = "@microsoft/fluid-media:SharedMediaSession";
+    /**
+     * The objects fluid type factory.
+     */
+    static readonly factory: DataObjectFactory<LiveMediaSession, import("@fluidframework/aqueduct").DataObjectTypes>;
+    /**
+     * Extension point that lets applications replace the default logic for throttling the sessions
+     * local sync behavior.
+     *
+     * @remarks
+     * The `LiveMediaCoordinator` is fairly aggressive at wanting to keep the local media player
+     * in sync with the rest of the group. This aggressiveness can result in the coordinator sending
+     * new sync actions before the local player has finished responding to the previous sync action.
+     * The `ActionThrottler` gives apps fine grain control over how aggressive they want sync to be.
+     *
+     * By default, a `RepeatedAction` throttler is used which prevents the same sync action from
+     * being sent within an adjustable time period.
+     */
+    get actionThrottler(): MediaSessionActionThrottler;
+    set actionThrottler(value: MediaSessionActionThrottler);
+    /**
+     * Returns true if the object has been initialized.
+     */
+    get isInitialized(): boolean;
+    /**
+     * @deprecated isInitialized should be used instead
+     * Returns true if the object has been initialized.
+     */
+    get isStarted(): boolean;
+    /**
+     * The group coordinator for the session.
+     */
+    get coordinator(): LiveMediaSessionCoordinator;
+    /**
+     * Returns the logger used by the session and coordinator.
+     *
+     * @remarks
+     * This is used by the `MediaPlayerSynchronizer` to log events.
+     */
+    get logger(): LiveTelemetryLogger;
+    /**
+     * initialize the object.
+     * @param allowedRoles Optional. List of roles allowed to group transport
+     * operations like play/pause/seek/setTrack.
+     * @returns a void promise that resolves once complete
+     */
+    initialize(allowedRoles?: UserMeetingRole[]): Promise<void>;
+    /**
+     * Registers an action handler with the session.
+     * @param action Name of the action to register a handler for.
+     * @param handler Function called when the action is triggered.
+     */
+    setActionHandler(action: ExtendedMediaSessionAction, handler: MediaSessionActionHandler | null): void;
+    /**
+     * Registers a handler that will be queried anytime the group coordinate needs to know the
+     * local players transport state and position.
+     */
+    setRequestPlayerStateHandler(handler: () => IMediaPlayerState): void;
+    /**
+     * Begins synchronizing the playback of a media element.
+     * @param player Something that "looks like" and HTML Media Element.
+     * @returns A new synchronizer instance. Call `synchronizer.end()` to stop synchronizing the elements playback.
+     */
+    synchronize(player: IMediaPlayer): MediaPlayerSynchronizer;
+    protected hasInitialized(): Promise<void>;
+    private checkWaitPointHit;
+    private getCurrentPlayerState;
+    private dispatchAction;
+}
 //# sourceMappingURL=LiveMediaSession.d.ts.map

package/bin/LiveMediaSession.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"LiveMediaSession.d.ts","sourceRoot":"","sources":["../src/LiveMediaSession.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,UAAU,EAAE,iBAAiB,EAAE,MAAM,0BAA0B,CAAC;AACzE,OAAO,EAAyB,mBAAmB,EAAE,eAAe,EAAE,MAAM,uBAAuB,CAAC;AACpG,OAAO,EAAE,uBAAuB,EAAE,MAAM,2BAA2B,CAAC;AAEpE,OAAO,EAEH,0BAA0B,EAE7B,MAAM,0BAA0B,CAAC;AAClC,OAAO,EACH,2BAA2B,EAC3B,iBAAiB,EACpB,MAAM,+BAA+B,CAAC;AACvC,OAAO,EAAE,2BAA2B,EAAE,MAAM,+BAA+B,CAAC;AAE5E,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAE9C;;GAEG;AACH,qBAAa,gBAAiB,SAAQ,UAAU;IAC5C,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,CAClB;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,0FAK5B;IAEF;;;;;;;;;;;;OAYG;IACH,IAAW,eAAe,IAAI,2BAA2B,CAExD;IAED,IAAW,eAAe,CAAC,KAAK,EAAE,2BAA2B,EAE5D;IAED;;OAEG;IACH,IAAW,aAAa,IAAI,OAAO,CAElC;IAED;;;OAGG;IACH,IAAW,SAAS,IAAI,OAAO,CAE9B;IAED;;OAEG;IACH,IAAW,WAAW,IAAI,2BAA2B,CAEpD;IAED;;;;;OAKG;IACH,IAAW,MAAM,IAAI,mBAAmB,CAEvC;IAED;;;;OAIG;IACI,UAAU,CACb,0BAA0B,CAAC,EAAE,eAAe,EAAE,GAC/C,OAAO,CAAC,IAAI,CAAC;IAIhB;;;;OAIG;IACI,gBAAgB,CACnB,MAAM,EAAE,0BAA0B,EAClC,OAAO,EAAE,yBAAyB,GAAG,IAAI,GAC1C,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;IAyE/C,OAAO,CAAC,iBAAiB;IAuBzB,OAAO,CAAC,qBAAqB;IAU7B,OAAO,CAAC,cAAc;CAQzB"}
+{"version":3,"file":"LiveMediaSession.d.ts","sourceRoot":"","sources":["../src/LiveMediaSession.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,iBAAiB,EAAE,MAAM,0BAA0B,CAAC;AAC7D,OAAO,EAEH,cAAc,EACd,mBAAmB,EACnB,eAAe,EAClB,MAAM,uBAAuB,CAAC;AAC/B,OAAO,EAAE,uBAAuB,EAAE,MAAM,2BAA2B,CAAC;AAEpE,OAAO,EAEH,0BAA0B,EAE7B,MAAM,0BAA0B,CAAC;AAClC,OAAO,EACH,2BAA2B,EAC3B,iBAAiB,EACpB,MAAM,+BAA+B,CAAC;AACvC,OAAO,EAAE,2BAA2B,EAAE,MAAM,+BAA+B,CAAC;AAE5E,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAE9C;;GAEG;AACH,qBAAa,gBAAiB,SAAQ,cAAc;IAChD,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,CAClB;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,0FAK5B;IAEF;;;;;;;;;;;;OAYG;IACH,IAAW,eAAe,IAAI,2BAA2B,CAExD;IAED,IAAW,eAAe,CAAC,KAAK,EAAE,2BAA2B,EAE5D;IAED;;OAEG;IACH,IAAW,aAAa,IAAI,OAAO,CAElC;IAED;;;OAGG;IACH,IAAW,SAAS,IAAI,OAAO,CAE9B;IAED;;OAEG;IACH,IAAW,WAAW,IAAI,2BAA2B,CAEpD;IAED;;;;;OAKG;IACH,IAAW,MAAM,IAAI,mBAAmB,CAEvC;IAED;;;;;OAKG;IACI,UAAU,CAAC,YAAY,CAAC,EAAE,eAAe,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC;IAOlE;;;;OAIG;IACI,gBAAgB,CACnB,MAAM,EAAE,0BAA0B,EAClC,OAAO,EAAE,yBAAyB,GAAG,IAAI,GAC1C,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;IA2E/C,OAAO,CAAC,iBAAiB;IAuBzB,OAAO,CAAC,qBAAqB;IAU7B,OAAO,CAAC,cAAc;CAQzB"}