@microsoft/live-share-media 1.0.0-preview.8 → 1.0.0

package/src/internals/GroupCoordinatorState.ts

@@ -4,12 +4,12 @@
  */
 
 import {
-    IEvent,
     ILiveEvent,
-    LiveEvent,
     TimeInterval,
     IRuntimeSignaler,
     LiveTelemetryLogger,
+    LiveShareRuntime,
+    IEvent,
 } from "@microsoft/live-share";
 import EventEmitter from "events";
 import {
@@ -40,7 +40,7 @@ import { TelemetryEvents } from "./consts";
 /**
  * @hidden
  */
-export interface IPositionUpdateEvent extends ILiveEvent {
+export interface IPositionUpdateEvent {
     track: IPlaybackTrack;
     trackData: IPlaybackTrackData;
     transport: ITransportState;
@@ -52,7 +52,7 @@ export interface IPositionUpdateEvent extends ILiveEvent {
 /**
  * @hidden
  */
-export interface ITransportCommandEvent extends ILiveEvent {
+export interface ITransportCommandEvent {
     track: IPlaybackTrack;
     position: number;
 }
@@ -60,7 +60,7 @@ export interface ITransportCommandEvent extends ILiveEvent {
 /**
  * @hidden
  */
-export interface ISetTrackEvent extends ILiveEvent {
+export interface ISetTrackEvent {
     metadata: ExtendedMediaMetadata | null;
     waitPoints: CoordinationWaitPoint[];
 }
@@ -68,7 +68,7 @@ export interface ISetTrackEvent extends ILiveEvent {
 /**
  * @hidden
  */
-export interface ISetTrackDataEvent extends ILiveEvent {
+export interface ISetTrackDataEvent {
     data: object | null;
 }
 
@@ -92,6 +92,7 @@ export enum GroupCoordinatorStateEvents {
  */
 export class GroupCoordinatorState extends EventEmitter {
     private readonly _runtime: IRuntimeSignaler;
+    private readonly _liveRuntime: LiveShareRuntime;
     private readonly _logger: LiveTelemetryLogger;
     private readonly _maxPlaybackDrift: TimeInterval;
     private _getMediaPlayerState: () => IMediaPlayerState;
@@ -115,13 +116,15 @@ export class GroupCoordinatorState extends EventEmitter {
 
     constructor(
         runtime: IRuntimeSignaler,
+        liveRuntime: LiveShareRuntime,
         maxPlaybackDrift: TimeInterval,
         positionUpdateInterval: TimeInterval,
         getMediaPlayerState: () => IMediaPlayerState
     ) {
         super();
         this._runtime = runtime;
-        this._logger = new LiveTelemetryLogger(runtime);
+        this._liveRuntime = liveRuntime;
+        this._logger = new LiveTelemetryLogger(runtime, liveRuntime);
         this._maxPlaybackDrift = maxPlaybackDrift;
         this._playbackTrack = new GroupPlaybackTrack(getMediaPlayerState);
         this._playbackTrackData = new GroupPlaybackTrackData(
@@ -129,11 +132,13 @@ export class GroupCoordinatorState extends EventEmitter {
         );
         this._transportState = new GroupTransportState(
             this._playbackTrack,
-            getMediaPlayerState
+            getMediaPlayerState,
+            this._liveRuntime
         );
         this._playbackPosition = new GroupPlaybackPosition(
             this._transportState,
             this._runtime,
+            this._liveRuntime,
             positionUpdateInterval
         );
         this._getMediaPlayerState = getMediaPlayerState;
@@ -278,7 +283,7 @@ export class GroupCoordinatorState extends EventEmitter {
 
     public createPositionUpdateEvent(
         state: IMediaPlayerState
-    ): Partial<IPositionUpdateEvent> {
+    ): IPositionUpdateEvent {
         const { positionState, playbackState } = state;
         if (this.isSuspended) {
             // Report suspension state
@@ -303,12 +308,15 @@ export class GroupCoordinatorState extends EventEmitter {
         }
     }
 
-    public handleSetTrack(event: ISetTrackEvent, local: boolean): void {
+    public handleSetTrack(
+        event: ILiveEvent<ISetTrackEvent>,
+        local: boolean
+    ): void {
         // Update shared track
         // - Will trigger 'trackChange' event to update media session
         const updated = this.playbackTrack.updateTrack({
-            metadata: event.metadata,
-            waitPoints: event.waitPoints,
+            metadata: event.data.metadata,
+            waitPoints: event.data.waitPoints,
             timestamp: event.timestamp,
             clientId: event.clientId || "",
         });
@@ -327,11 +335,14 @@ export class GroupCoordinatorState extends EventEmitter {
         }
     }
 
-    public handleSetTrackData(event: ISetTrackDataEvent, local: boolean): void {
+    public handleSetTrackData(
+        event: ILiveEvent<ISetTrackDataEvent>,
+        local: boolean
+    ): void {
         // Update shared track data
         // - Will trigger 'dataChange' event to update media session
         const updated = this.playbackTrackData.updateData({
-            data: event.data,
+            data: event.data.data,
             timestamp: event.timestamp,
             clientId: event.clientId || "",
         });
@@ -351,13 +362,13 @@ export class GroupCoordinatorState extends EventEmitter {
     }
 
     public handleTransportCommand(
-        event: ITransportCommandEvent,
+        event: ILiveEvent<ITransportCommandEvent>,
         local: boolean
     ): void {
         // Ensure change is for current track
         // - Will trigger a 'trackChange' event if newer track.
-        this.playbackTrack.updateTrack(event.track);
-        if (this.playbackTrack.compare(event.track.metadata)) {
+        this.playbackTrack.updateTrack(event.data.track);
+        if (this.playbackTrack.compare(event.data.track.metadata)) {
             // Update playback state
             let playbackState = this.transportState.playbackState;
             switch (event.name) {
@@ -372,7 +383,7 @@ export class GroupCoordinatorState extends EventEmitter {
             // Try to update playback state
             const newState: ITransportState = {
                 playbackState: playbackState,
-                startPosition: event.position,
+                startPosition: event.data.position,
                 timestamp: event.timestamp,
                 clientId: event.clientId || "",
             };
@@ -420,30 +431,30 @@ export class GroupCoordinatorState extends EventEmitter {
     }
 
     public handlePositionUpdate(
-        event: IPositionUpdateEvent,
+        event: Omit<ILiveEvent<IPositionUpdateEvent>, "name">,
         local: boolean
     ): void {
         // Ensure change is for current track
         // - Will trigger a 'trackChange' event if newer track.
-        this.playbackTrack.updateTrack(event.track);
-        if (this.playbackTrack.compare(event.track.metadata)) {
+        this.playbackTrack.updateTrack(event.data.track);
+        if (this.playbackTrack.compare(event.data.track.metadata)) {
             // Ensure we have the latest track data
-            this.playbackTrackData.updateData(event.trackData);
+            this.playbackTrackData.updateData(event.data.trackData);
 
             // Update transport state if needed
             // - Ignore transport state changes if the client has ended as this will cause the local
             //   player to start playback even though the video may have ended for everyone.
-            if (event.playbackState != "ended") {
-                this.transportState.updateState(event.transport);
+            if (event.data.playbackState != "ended") {
+                this.transportState.updateState(event.data.transport);
             }
 
             // Ensure change is for current transport state
-            if (this.transportState.compare(event.transport)) {
+            if (this.transportState.compare(event.data.transport)) {
                 // Update playback position
                 const position: ICurrentPlaybackPosition = {
-                    playbackState: event.playbackState,
-                    waitPoint: event.waitPoint,
-                    position: event.position,
+                    playbackState: event.data.playbackState,
+                    waitPoint: event.data.waitPoint,
+                    position: event.data.position,
                     timestamp: event.timestamp,
                     clientId: event.clientId || "",
                 };
@@ -455,20 +466,24 @@ export class GroupCoordinatorState extends EventEmitter {
                     // - This is needed because the catchup logic can try to sink the client with
                     //  the rest of the group while the local player is trying to to seek to a
                     //  new position.
-                    switch (event.playbackState) {
+                    switch (event.data.playbackState) {
                         case "none":
                         case "paused":
                         case "playing":
-                            if (event.playbackState != this._lastStateChange) {
+                            if (
+                                event.data.playbackState !=
+                                this._lastStateChange
+                            ) {
                                 this._logger.sendTelemetryEvent(
                                     TelemetryEvents.GroupCoordinator
                                         .BeginSoftSuspension,
                                     null,
-                                    { playbackState: event.playbackState }
+                                    { playbackState: event.data.playbackState }
                                 );
-                                this._lastStateChange = event.playbackState;
+                                this._lastStateChange =
+                                    event.data.playbackState;
                                 this._lastStateChangeTime =
-                                    LiveEvent.getTimestamp();
+                                    this._liveRuntime.getTimestamp();
                             }
                             break;
                     }
@@ -494,7 +509,7 @@ export class GroupCoordinatorState extends EventEmitter {
     public async syncLocalMediaSession(): Promise<void> {
         // Skip further syncs if we're waiting or in a "soft suspension".
         const softSuspensionDelta =
-            LiveEvent.getTimestamp() - this._lastStateChangeTime;
+            this._liveRuntime.getTimestamp() - this._lastStateChangeTime;
         if (!this.isWaiting && softSuspensionDelta >= 1000) {
             let { metadata, trackData, positionState, playbackState } =
                 this._getMediaPlayerState();

package/src/internals/GroupPlaybackPosition.ts

@@ -4,9 +4,10 @@
  */
 
 import {
-    LiveEvent,
     IRuntimeSignaler,
     TimeInterval,
+    LiveShareClient,
+    LiveShareRuntime,
 } from "@microsoft/live-share";
 import { GroupTransportState } from "./GroupTransportState";
 import { GroupPlaybackTrackEvents } from "./GroupPlaybackTrack";
@@ -34,16 +35,19 @@ export interface ICurrentPlaybackPosition {
 export class GroupPlaybackPosition {
     private _transportState: GroupTransportState;
     private _runtime: IRuntimeSignaler;
+    private _liveRuntime: LiveShareRuntime;
     private _updateInterval: TimeInterval;
     private _positions: Map<string, ICurrentPlaybackPosition>;
 
     constructor(
         transportState: GroupTransportState,
         runtime: IRuntimeSignaler,
+        liveRuntime: LiveShareRuntime,
         updateInterval: TimeInterval
     ) {
         this._transportState = transportState;
         this._runtime = runtime;
+        this._liveRuntime = liveRuntime;
         this._updateInterval = updateInterval;
         this._positions = new Map();
 
@@ -129,7 +133,7 @@ export class GroupPlaybackPosition {
      */
     public get maxPosition(): number {
         if (this._transportState.playbackState == "playing") {
-            const now = LiveEvent.getTimestamp();
+            const now = this._liveRuntime.getTimestamp();
             const projected =
                 this._transportState.startPosition +
                 (now - this._transportState.timestamp) / 1000;
@@ -162,7 +166,7 @@ export class GroupPlaybackPosition {
             projectedPosition: number
         ) => void
     ): void {
-        const now = LiveEvent.getTimestamp();
+        const now = this._liveRuntime.getTimestamp();
         const ignoreBefore = now - this._updateInterval.milliseconds * 2;
         const shouldProject = !this._transportState.track.metadata?.liveStream;
         this._positions.forEach((value, key) => {

package/src/internals/GroupPlaybackTrack.ts

@@ -3,7 +3,7 @@
  * Licensed under the Microsoft Live Share SDK License.
  */
 
-import { IEvent } from "@microsoft/live-share";
+import { ILiveEvent } from "@microsoft/live-share";
 import EventEmitter from "events";
 import { IMediaPlayerState } from "../LiveMediaSessionCoordinator";
 import {
@@ -31,7 +31,7 @@ export enum GroupPlaybackTrackEvents {
 /**
  * @hidden
  */
-export interface IPlaybackTrackChangeEvent extends IEvent {
+export interface IPlaybackTrackChangeEvent extends ILiveEvent {
     metadata: ExtendedMediaMetadata | null;
 }
 

package/src/internals/GroupPlaybackTrackData.ts

@@ -3,7 +3,7 @@
  * Licensed under the Microsoft Live Share SDK License.
  */
 
-import { IEvent } from "@microsoft/live-share";
+import { ILiveEvent } from "@microsoft/live-share";
 import EventEmitter from "events";
 import {
     GroupPlaybackTrack,
@@ -29,7 +29,7 @@ export enum PlaybackTrackDataEvents {
 /**
  * @hidden
  */
-export interface IPlaybackTrackDataChangeEvent extends IEvent {
+export interface IPlaybackTrackDataChangeEvent extends ILiveEvent {
     data: object | null;
 }
 

package/src/internals/GroupTransportState.ts

@@ -3,7 +3,11 @@
  * Licensed under the Microsoft Live Share SDK License.
  */
 
-import { IEvent, LiveEvent } from "@microsoft/live-share";
+import {
+    ILiveEvent,
+    LiveShareRuntime,
+    LiveShareClient,
+} from "@microsoft/live-share";
 import EventEmitter from "events";
 import { IMediaPlayerState } from "../LiveMediaSessionCoordinator";
 import {
@@ -35,7 +39,7 @@ export enum GroupTransportStateEvents {
 /**
  * @hidden
  */
-export interface ITransportStateChangeEvent extends IEvent {
+export interface ITransportStateChangeEvent extends ILiveEvent {
     action: ExtendedMediaSessionAction;
     seekTime?: number;
 }
@@ -46,13 +50,16 @@ export interface ITransportStateChangeEvent extends IEvent {
 export class GroupTransportState extends EventEmitter {
     private readonly _getMediaPlayerState: () => IMediaPlayerState;
     private _track: GroupPlaybackTrack;
+    private readonly _liveRuntime: LiveShareRuntime;
     private _current: ITransportState;
 
     constructor(
         track: GroupPlaybackTrack,
-        getMediaPlayerState: () => IMediaPlayerState
+        getMediaPlayerState: () => IMediaPlayerState,
+        liveRuntime: LiveShareRuntime
     ) {
         super();
+        this._liveRuntime = liveRuntime;
         this._getMediaPlayerState = getMediaPlayerState;
         this._track = track;
         this._current = {
@@ -136,7 +143,7 @@ export class GroupTransportState extends EventEmitter {
                 seekTime: state.startPosition,
             });
         } else if (state.playbackState == "playing") {
-            const now = LiveEvent.getTimestamp();
+            const now = this._liveRuntime.getTimestamp();
             const projectedPosition =
                 state.startPosition + (now - state.timestamp) / 1000;
             this.emit(GroupTransportStateEvents.transportStateChange, {

package/src/internals/consts.ts

@@ -22,6 +22,8 @@ export const TelemetryEvents = {
         UserTappedVideoToPlay: transmit(
             "MediaPlayerSynchronizer:UserTappedVideoToPlay"
         ),
+        UserTappedVideoToPlayError:
+            "MediaPlayerSynchronizer:UserTappedVideoToPlayError",
         PlaybackRateChangeBlocked:
             "MediaPlayerSynchronizer:PlaybackRateChangeBlocked",
         PlayerBlockedOperation: transmit(
@@ -72,6 +74,8 @@ export const TelemetryEvents = {
         RemoteSeekToReceived: transmit(
             "SessionCoordinator:RemoteSeekToReceived"
         ),
+        PositionUpdateEventError: "SessionCoordinator:PositionUpdateEventError",
+        SendJoinedEventError: "SessionCoordinator:SendJoinedEventError",
     },
     GroupCoordinator: {
         TrackChanged: "GroupCoordinator:TrackChanged",

package/typedoc.json

@@ -0,0 +1,10 @@
+{
+    "entryPoints": ["./src/index.ts"],
+    "excludeExternals": true,
+    "excludePrivate": true,
+    "excludeInternal": true,
+    "name": "_microsoft_live_share_media",
+    "validation": {
+        "invalidLink": true
+    }
+}

package/bin/EphemeralMediaSession.d.ts

@@ -1,102 +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 { ExtendedMediaSessionAction } from './MediaSessionExtensions';
-import { EphemeralMediaSessionCoordinator, IMediaPlayerState } from './EphemeralMediaSessionCoordinator';
-import { MediaSessionActionThrottler } from './MediaSessionActionThrottler';
-import { IMediaPlayer } from './IMediaPlayer';
-/**
- * Ephemeral fluid object that synchronizes media playback across multiple clients.
- */
-export declare class EphemeralMediaSession 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<EphemeralMediaSession, import("@fluidframework/aqueduct").DataObjectTypes>;
-    /**
-     * 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.
-     */
-    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(): EphemeralMediaSessionCoordinator;
-    /**
-     * Returns the logger used by the session and coordinator.
-     *
-     * @remarks
-     * This is used by the `MediaPlayerSynchronizer` to log events.
-     */
-    get logger(): EphemeralTelemetryLogger;
-    /**
-     * initialize the object.
-     * @param acceptTransportChangesFrom Optional. List of roles allowed to group transport
-     * operations like play/pause/seek/setTrack.
-     */
-    initialize(acceptTransportChangesFrom?: UserMeetingRole[]): Promise<void>;
-    /**
-     * @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.
-     */
-    start(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;
-}
-//# sourceMappingURL=EphemeralMediaSession.d.ts.map

package/bin/EphemeralMediaSession.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"EphemeralMediaSession.d.ts","sourceRoot":"","sources":["../src/EphemeralMediaSession.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,UAAU,EAAE,iBAAiB,EAAE,MAAM,0BAA0B,CAAC;AACzE,OAAO,EAAE,wBAAwB,EAAE,eAAe,EAAE,MAAM,uBAAuB,CAAC;AAClF,OAAO,EAAE,uBAAuB,EAAE,MAAM,2BAA2B,CAAC;AAEpE,OAAO,EAAiC,0BAA0B,EAAqC,MAAM,0BAA0B,CAAC;AACxI,OAAO,EAAE,gCAAgC,EAAE,iBAAiB,EAAE,MAAM,oCAAoC,CAAC;AACzG,OAAO,EAAE,2BAA2B,EAAE,MAAM,+BAA+B,CAAC;AAE5E,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAE9C;;GAEG;AACF,qBAAa,qBAAsB,SAAQ,UAAU;IAClD,OAAO,CAAC,gBAAgB,CAA8D;IACtF,OAAO,CAAC,OAAO,CAAC,CAA2B;IAC3C,OAAO,CAAC,0BAA0B,CAAC,CAA0B;IAC7D,OAAO,CAAC,YAAY,CAAC,CAAmC;IACxD,OAAO,CAAC,QAAQ,CAAC,eAAe,CAAqD;IACrF,OAAO,CAAC,cAAc,CAAC,CAA0B;IAGjD,OAAO,CAAC,YAAY,CAAM;IAC1B,OAAO,CAAC,eAAe,CAAa;IAEpC;;OAEG;IACF,gBAAuB,QAAQ,+CAA+C;IAE/E;;OAEG;IACF,gBAAuB,OAAO,+FAK7B;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,gCAAgC,CAEzD;IAED;;;;;OAKG;IACH,IAAW,MAAM,IAAI,wBAAwB,CAE5C;IAED;;;;OAIG;IACK,UAAU,CAAC,0BAA0B,CAAC,EAAE,eAAe,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC;IAIjF;;;;;OAKG;IACI,KAAK,CAAC,0BAA0B,CAAC,EAAE,eAAe,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC;IAI3E;;;;OAIG;IACI,gBAAgB,CAAC,MAAM,EAAE,0BAA0B,EAAE,OAAO,EAAE,yBAAyB,GAAG,IAAI,GAAG,IAAI;IAW5G;;;OAGG;IACI,4BAA4B,CAAC,OAAO,EAAE,MAAM,iBAAiB;IAIpE;;;;OAIG;IACI,WAAW,CAAC,MAAM,EAAE,YAAY,GAAG,uBAAuB;cA+BjD,cAAc,IAAI,OAAO,CAAC,IAAI,CAAC;IAuC/C,OAAO,CAAC,iBAAiB;IAiBzB,OAAO,CAAC,qBAAqB;IAQ7B,OAAO,CAAC,cAAc;CAMzB"}