@microsoft/live-share-media 2.0.0-internal.15 → 2.0.0-internal.16

package/bin/MediaPlayerSynchronizer.d.ts

@@ -0,0 +1,189 @@
+/**
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the Microsoft Live Share SDK License.
+ */
+import { ILiveEvent, IRuntimeSignaler } from "@microsoft/live-share";
+import EventEmitter from "events";
+import { ExtendedMediaMetadata, CoordinationWaitPoint, ExtendedMediaSessionActionDetails } from "./MediaSessionExtensions";
+import { VolumeManager } from "./VolumeManager";
+import { LiveMediaSession } from "./LiveMediaSession";
+import { IMediaPlayer } from "./IMediaPlayer";
+/**
+ * Event data returned by `MediaPlayerSynchronizer` object.
+ */
+export interface IMediaPlayerSynchronizerEvent extends ILiveEvent {
+    /**
+     * Event details.
+     */
+    details: ExtendedMediaSessionActionDetails;
+    /**
+     * Action errors, including DOMException errors thrown by HTMLMediaElement
+     */
+    error?: Error;
+}
+/**
+ * Events supported by `MediaPlayerSynchronizer` object.
+ */
+export declare enum MediaPlayerSynchronizerEvents {
+    /**
+     *
+     */
+    coordinatorstatechange = "coordinatorstatechange",
+    groupaction = "groupaction",
+    useraction = "useraction"
+}
+/**
+ * Synchronizes a local HTML Media Element with a group of remote HTML Media Elements.
+ *
+ * @remarks
+ * All of an apps transport control commands should be routed through the synchronizer. If the
+ * app is not currently joined to the group media session, the commands will be applied directly
+ * to the local player. When the group session is joined the commands will be broadcast to the
+ * group in addition to being applied to the local player.
+ */
+export declare class MediaPlayerSynchronizer extends EventEmitter {
+    private static SESSION_ACTIONS;
+    private static PLAYER_EVENTS;
+    private _logger;
+    private _player;
+    private _mediaSession;
+    private _runtime;
+    private _volumeManager;
+    private _onEnd?;
+    private _onPlayerEvent;
+    private _seekSuspension?;
+    private _viewOnly;
+    private _blockUnexpectedPlayerEvents;
+    private _expectedPlaybackState;
+    private _expectedPlaybackRate;
+    private _metadata;
+    private _trackData;
+    /**
+     * Creates a new `MediaElementSynchronizer` instance.
+     * @param player Media player element. This can be an HTML Media Element or any player that looks like an HTML Media Element.
+     * @param mediaSession Group MediaSession object being used.
+     * @param onEnd Optional. Function to call when synchronizers `end()` method is called.
+     */
+    constructor(player: IMediaPlayer, mediaSession: LiveMediaSession, runtime: IRuntimeSignaler, onEnd: () => void);
+    /**
+     * Media player being synchronized.
+     */
+    get player(): IMediaPlayer;
+    /**
+     * Synchronizers media session.
+     */
+    get mediaSession(): LiveMediaSession;
+    /**
+     * If true the client is in a view only mode.
+     *
+     * @remarks
+     * Toggling this value to true results in `mediaSession.coordinator.canPlayPause`,
+     * `mediaSession.coordinator.canSeek`, `mediaSession.coordinator.canSetTrack`,
+     * `mediaSession.coordinator.canSetTrackData`, and `mediaSession.coordinator.canSetPlaybackRate`
+     *  all being set to false.  For more fine grained control over the local clients policies,
+     *  call the `mediaSession.coordinator` directly.
+     */
+    get viewOnly(): boolean;
+    set viewOnly(value: boolean);
+    /**
+     * @beta
+     * If true, pause and play actions will be ignored unless explicitly invoked from the corresponding play() and pause() functions.
+     *
+     * @remarks
+     * True is considered non-beta. If you set to false, this is an experimental beta behavior.
+     * Setting it to false may cause unintended side effects, such as local buffer events sending a pause event to remote clients.
+     * While setting this to false may prevent the need to add custom media controls for frameworks like video.js, we encourage you to be mindful of this and test thoroughly before using this setting.
+     */
+    get blockUnexpectedPlayerEvents(): boolean;
+    set blockUnexpectedPlayerEvents(value: boolean);
+    /**
+     * Volume limiter used to temporarily reduce the videos volume when someone speaks in a meeting.
+     */
+    get volumeManager(): VolumeManager;
+    /**
+     * Registers a new event listener.
+     * @param event Name of the event to add.
+     * @param listener Function to call when the event is triggered.
+     */
+    addEventListener(event: MediaPlayerSynchronizerEvents, listener: (evt: IMediaPlayerSynchronizerEvent) => void): this;
+    /**
+     * Un-registers an existing event listener.
+     * @param event Name of the event to remove.
+     * @param listener Function that was registered in call to `addEventListener()`.
+     */
+    removeEventListener(event: MediaPlayerSynchronizerEvents, listener: (evt: IMediaPlayerSynchronizerEvent) => void): this;
+    /**
+     * Ends synchronization of the current media player.
+     */
+    end(): void;
+    /**
+     * Begin a local seek operation.
+     *
+     * @remarks
+     * UI can call this when a user grabs a timeline scrubber and starts scrubbing the video to a
+     * new playback position. The synchronizer will being a new suspension which temporarily
+     * disconnects the client for the rest of the group for synchronization purposes. Calling
+     * `endSeek()` will end the suspension and seek the group to the users final seek position.
+     */
+    beginSeek(): void;
+    /**
+     * Ends a seek operation that was started by calling `beginSeek()`.
+     * @param seekTo Playback position in seconds to seek the group to.
+     */
+    endSeek(seekTo: number): void;
+    /**
+     * Tells the group to begin playing the current video.
+     *
+     * @remarks
+     * For proper operation apps should avoid calling `mediaSession.coordinator.play()` directly
+     * and instead use the synchronizers `play()` method.
+     *
+     * @returns a void promise that resolves once complete, throws if user does not have proper roles
+     */
+    play(): Promise<void>;
+    /**
+     * Tells the group to pause the current video.
+     *
+     * @remarks
+     * For proper operation apps should avoid calling `mediaSession.coordinator.pause()` directly
+     * and instead use the synchronizers `pause()` method.
+     *
+     * @returns a void promise that resolves once complete, throws if user does not have proper roles
+     */
+    pause(): Promise<void>;
+    /**
+     * Tells the group to seek the current video to a new playback position.
+     *
+     * @remarks
+     * For proper operation apps should avoid calling `mediaSession.coordinator.seekTo()` directly
+     * and instead use the synchronizers `seekTo()` method.
+     *
+     * @returns a void promise that resolves once complete, throws if user does not have proper roles
+     */
+    seekTo(time: number): Promise<void>;
+    setPlaybackRate(playbackRate: number): Promise<void>;
+    /**
+     * Tells the group to change to a new track.
+     *
+     * @remarks
+     * For proper operation apps should avoid calling `mediaSession.coordinator.setTrack()` directly
+     * and instead use the synchronizers `setTrack()` method.
+     *
+     * @returns a void promise that resolves once complete, throws if user does not have proper roles
+     */
+    setTrack(track: ExtendedMediaMetadata, waitPoints?: CoordinationWaitPoint[]): Promise<void>;
+    /**
+     * Updates the current tracks data object.
+     *
+     * @remarks
+     * For proper operation apps should avoid calling `mediaSession.coordinator.setTrackData()` directly
+     * and instead use the synchronizers `setTrackData()` method.
+     *
+     * @returns a void promise that resolves once complete, throws if user does not have proper roles
+     */
+    setTrackData(data: object | null): Promise<void>;
+    private dispatchGroupAction;
+    private dispatchUserAction;
+    private catchupPlayer;
+}
+//# sourceMappingURL=MediaPlayerSynchronizer.d.ts.map

package/bin/MediaPlayerSynchronizer.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"MediaPlayerSynchronizer.d.ts","sourceRoot":"","sources":["../src/MediaPlayerSynchronizer.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,OAAO,EAEH,UAAU,EACV,gBAAgB,EACnB,MAAM,uBAAuB,CAAC;AAC/B,OAAO,YAAY,MAAM,QAAQ,CAAC;AAClC,OAAO,EAGH,qBAAqB,EACrB,qBAAqB,EACrB,iCAAiC,EAGpC,MAAM,0BAA0B,CAAC;AAClC,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAChD,OAAO,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AACtD,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAI9C;;GAEG;AACH,MAAM,WAAW,6BAA8B,SAAQ,UAAU;IAC7D;;OAEG;IACH,OAAO,EAAE,iCAAiC,CAAC;IAC3C;;OAEG;IACH,KAAK,CAAC,EAAE,KAAK,CAAC;CACjB;AAED;;GAEG;AACH,oBAAY,6BAA6B;IACrC;;OAEG;IACH,sBAAsB,2BAA2B;IACjD,WAAW,gBAAgB;IAC3B,UAAU,eAAe;CAC5B;AAED;;;;;;;;GAQG;AACH,qBAAa,uBAAwB,SAAQ,YAAY;IACrD,OAAO,CAAC,MAAM,CAAC,eAAe,CAS5B;IACF,OAAO,CAAC,MAAM,CAAC,aAAa,CAQ1B;IAEF,OAAO,CAAC,OAAO,CAAsB;IACrC,OAAO,CAAC,OAAO,CAAe;IAC9B,OAAO,CAAC,aAAa,CAAmB;IACxC,OAAO,CAAC,QAAQ,CAAmB;IACnC,OAAO,CAAC,cAAc,CAAgB;IACtC,OAAO,CAAC,MAAM,CAAC,CAAa;IAC5B,OAAO,CAAC,cAAc,CAAgB;IACtC,OAAO,CAAC,eAAe,CAAC,CAAoC;IAC5D,OAAO,CAAC,SAAS,CAAS;IAC1B,OAAO,CAAC,4BAA4B,CAAQ;IAC5C,OAAO,CAAC,sBAAsB,CAA6C;IAC3E,OAAO,CAAC,qBAAqB,CAAe;IAC5C,OAAO,CAAC,SAAS,CAAsC;IACvD,OAAO,CAAC,UAAU,CAAuB;IAEzC;;;;;OAKG;gBAEC,MAAM,EAAE,YAAY,EACpB,YAAY,EAAE,gBAAgB,EAC9B,OAAO,EAAE,gBAAgB,EACzB,KAAK,EAAE,MAAM,IAAI;IA4SrB;;OAEG;IACH,IAAW,MAAM,IAAI,YAAY,CAEhC;IAED;;OAEG;IACH,IAAW,YAAY,IAAI,gBAAgB,CAE1C;IAED;;;;;;;;;OASG;IACH,IAAW,QAAQ,IAAI,OAAO,CAE7B;IAED,IAAW,QAAQ,CAAC,KAAK,EAAE,OAAO,EAOjC;IAED;;;;;;;;OAQG;IACH,IAAW,2BAA2B,IAAI,OAAO,CAEhD;IAED,IAAW,2BAA2B,CAAC,KAAK,EAAE,OAAO,EAEpD;IAED;;OAEG;IACH,IAAW,aAAa,IAAI,aAAa,CAExC;IAED;;;;OAIG;IACI,gBAAgB,CACnB,KAAK,EAAE,6BAA6B,EACpC,QAAQ,EAAE,CAAC,GAAG,EAAE,6BAA6B,KAAK,IAAI,GACvD,IAAI;IAKP;;;;OAIG;IACI,mBAAmB,CACtB,KAAK,EAAE,6BAA6B,EACpC,QAAQ,EAAE,CAAC,GAAG,EAAE,6BAA6B,KAAK,IAAI,GACvD,IAAI;IAKP;;OAEG;IACI,GAAG,IAAI,IAAI;IAwBlB;;;;;;;;OAQG;IACI,SAAS,IAAI,IAAI;IAaxB;;;OAGG;IACI,OAAO,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI;IAmCpC;;;;;;;;OAQG;IACU,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC;IAelC;;;;;;;;OAQG;IACU,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC;IAenC;;;;;;;;OAQG;IACU,MAAM,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAsBnC,eAAe,CAAC,YAAY,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAkBjE;;;;;;;;OAQG;IACU,QAAQ,CACjB,KAAK,EAAE,qBAAqB,EAC5B,UAAU,CAAC,EAAE,qBAAqB,EAAE,GACrC,OAAO,CAAC,IAAI,CAAC;IAehB;;;;;;;;OAQG;IACU,YAAY,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC;IAgB7D,OAAO,CAAC,mBAAmB;IAW3B,OAAO,CAAC,kBAAkB;YASZ,aAAa;CAG9B"}