@microsoft/live-share-media 1.3.1 → 1.4.0

package/src/internals/GroupPlaybackRate.ts

@@ -0,0 +1,90 @@
+/**
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the Microsoft Live Share SDK License.
+ */
+
+import EventEmitter from "events";
+import { ExtendedMediaSessionActionSource } from "../MediaSessionExtensions";
+import { IGroupStateEvent } from "./interfaces";
+
+/**
+ * @hidden
+ */
+export interface IPlaybackRate {
+    playbackRate: number;
+    timestamp: number;
+    clientId: string;
+}
+
+/**
+ * @hidden
+ */
+export enum PlaybackRateEvents {
+    rateChange = "rateChange",
+}
+
+/**
+ * @hidden
+ */
+export interface IPlaybackRateChangeEvent extends IGroupStateEvent {
+    playbackRate: number;
+}
+
+/**
+ * @hidden
+ */
+export class GroupPlaybackRate extends EventEmitter {
+    private _current: IPlaybackRate;
+
+    constructor() {
+        super();
+        this._current = { playbackRate: 1.0, timestamp: 0, clientId: "" };
+    }
+
+    public get current(): Readonly<IPlaybackRate> {
+        return this._current;
+    }
+
+    public get rate(): number {
+        return this.current.playbackRate;
+    }
+
+    public updatePlaybackRate(
+        newRate: IPlaybackRate,
+        source: ExtendedMediaSessionActionSource
+    ): boolean {
+        // Ignore state changes that are older
+        const current = this.current;
+        if (newRate.timestamp < current.timestamp) {
+            return false;
+        }
+
+        // Ignore state changes that have the same timestamp and the clientId sorts higher.
+        if (
+            newRate.timestamp == current.timestamp &&
+            newRate.clientId.localeCompare(current.clientId) > 0
+        ) {
+            return false;
+        }
+
+        // Ignore state changes for same data object
+        if (current.playbackRate == newRate.playbackRate) {
+            return false;
+        }
+
+        // Update current data
+        this._current = newRate;
+
+        const event: IPlaybackRateChangeEvent = {
+            name: PlaybackRateEvents.rateChange,
+            clientId: newRate.clientId,
+            playbackRate: newRate.playbackRate,
+            source,
+        };
+
+        // Notify listeners
+        this.emit(PlaybackRateEvents.rateChange, event);
+
+        return true;
+    }
+}

package/src/internals/GroupPlaybackTrack.ts

@@ -3,7 +3,6 @@
  * Licensed under the Microsoft Live Share SDK License.
  */
 
-import { ILiveEvent } from "@microsoft/live-share";
 import EventEmitter from "events";
 import { IMediaPlayerState } from "../LiveMediaSessionCoordinator";
 import {
@@ -11,6 +10,7 @@ import {
     ExtendedMediaMetadata,
     ExtendedMediaSessionActionSource,
 } from "../MediaSessionExtensions";
+import { IGroupStateEvent } from "./interfaces";
 
 /**
  * @hidden
@@ -32,7 +32,7 @@ export enum GroupPlaybackTrackEvents {
 /**
  * @hidden
  */
-export interface IPlaybackTrackChangeEvent extends ILiveEvent {
+export interface IPlaybackTrackChangeEvent extends IGroupStateEvent {
     metadata: ExtendedMediaMetadata | null;
 }
 
@@ -149,12 +149,13 @@ export class GroupPlaybackTrack extends EventEmitter {
         this._current = track;
 
         // Notify listeners
-        this.emit(GroupPlaybackTrackEvents.trackChange, {
+        const event: IPlaybackTrackChangeEvent = {
             name: GroupPlaybackTrackEvents.trackChange,
             clientId: track.clientId,
             metadata: track.metadata,
             source,
-        });
+        };
+        this.emit(GroupPlaybackTrackEvents.trackChange, event);
 
         return true;
     }

package/src/internals/GroupPlaybackTrackData.ts

@@ -3,13 +3,13 @@
  * Licensed under the Microsoft Live Share SDK License.
  */
 
-import { ILiveEvent } from "@microsoft/live-share";
 import EventEmitter from "events";
 import {
     GroupPlaybackTrack,
     GroupPlaybackTrackEvents,
 } from "./GroupPlaybackTrack";
 import { ExtendedMediaSessionActionSource } from "../MediaSessionExtensions";
+import { IGroupStateEvent } from "./interfaces";
 
 /**
  * @hidden
@@ -30,7 +30,7 @@ export enum PlaybackTrackDataEvents {
 /**
  * @hidden
  */
-export interface IPlaybackTrackDataChangeEvent extends ILiveEvent {
+export interface IPlaybackTrackDataChangeEvent extends IGroupStateEvent {
     data: object | null;
 }
 
@@ -66,38 +66,39 @@ export class GroupPlaybackTrackData extends EventEmitter {
     }
 
     public updateData(
-        event: IPlaybackTrackData,
+        trackData: IPlaybackTrackData,
         source: ExtendedMediaSessionActionSource
     ): boolean {
         // Ignore state changes that are older
         const current = this.current;
-        if (event.timestamp < current.timestamp) {
+        if (trackData.timestamp < current.timestamp) {
             return false;
         }
 
         // Ignore state changes that have the same timestamp and the clientId sorts higher.
         if (
-            event.timestamp == current.timestamp &&
-            event.clientId.localeCompare(current.clientId) > 0
+            trackData.timestamp == current.timestamp &&
+            trackData.clientId.localeCompare(current.clientId) > 0
         ) {
             return false;
         }
 
         // Ignore state changes for same data object
-        if (JSON.stringify(current.data) == JSON.stringify(event.data)) {
+        if (JSON.stringify(current.data) == JSON.stringify(trackData.data)) {
             return false;
         }
 
         // Update current data
-        this._current = event;
+        this._current = trackData;
 
         // Notify listeners
-        this.emit(PlaybackTrackDataEvents.dataChange, {
-            type: PlaybackTrackDataEvents.dataChange,
-            clientId: event.clientId,
-            data: event.data,
+        const event: IPlaybackTrackDataChangeEvent = {
+            name: PlaybackTrackDataEvents.dataChange,
+            clientId: trackData.clientId,
+            data: trackData.data,
             source,
-        });
+        };
+        this.emit(PlaybackTrackDataEvents.dataChange, event);
 
         return true;
     }

package/src/internals/GroupTransportState.ts

@@ -3,7 +3,7 @@
  * Licensed under the Microsoft Live Share SDK License.
  */
 
-import { ILiveEvent, LiveShareRuntime } from "@microsoft/live-share";
+import { LiveShareRuntime } from "@microsoft/live-share";
 import EventEmitter from "events";
 import { IMediaPlayerState } from "../LiveMediaSessionCoordinator";
 import {
@@ -15,6 +15,8 @@ import {
     GroupPlaybackTrack,
     GroupPlaybackTrackEvents,
 } from "./GroupPlaybackTrack";
+import { IGroupStateEvent } from "./interfaces";
+import { GroupPlaybackRate } from "./GroupPlaybackRate";
 
 /**
  * @hidden
@@ -36,7 +38,7 @@ export enum GroupTransportStateEvents {
 /**
  * @hidden
  */
-export interface ITransportStateChangeEvent extends ILiveEvent {
+export interface ITransportStateChangeEvent extends IGroupStateEvent {
     action: ExtendedMediaSessionAction;
     seekTime?: number;
 }
@@ -47,11 +49,13 @@ export interface ITransportStateChangeEvent extends ILiveEvent {
 export class GroupTransportState extends EventEmitter {
     private readonly _getMediaPlayerState: () => IMediaPlayerState;
     private _track: GroupPlaybackTrack;
+    private _playbackRate: GroupPlaybackRate;
     private readonly _liveRuntime: LiveShareRuntime;
     private _current: ITransportState;
 
     constructor(
         track: GroupPlaybackTrack,
+        playbackRate: GroupPlaybackRate,
         getMediaPlayerState: () => IMediaPlayerState,
         liveRuntime: LiveShareRuntime
     ) {
@@ -59,6 +63,7 @@ export class GroupTransportState extends EventEmitter {
         this._liveRuntime = liveRuntime;
         this._getMediaPlayerState = getMediaPlayerState;
         this._track = track;
+        this._playbackRate = playbackRate;
         this._current = {
             playbackState: "none",
             startPosition: 0.0,
@@ -137,32 +142,36 @@ export class GroupTransportState extends EventEmitter {
             originalState.playbackState == state.playbackState &&
             playerState != "ended"
         ) {
-            this.emit(GroupTransportStateEvents.transportStateChange, {
-                type: GroupTransportStateEvents.transportStateChange,
+            const event: ITransportStateChangeEvent = {
+                name: GroupTransportStateEvents.transportStateChange,
                 action: "seekto",
                 clientId: state.clientId,
                 seekTime: state.startPosition,
                 source,
-            });
+            };
+            this.emit(GroupTransportStateEvents.transportStateChange, event);
         } else if (state.playbackState == "playing") {
             const now = this._liveRuntime.getTimestamp();
             const projectedPosition =
-                state.startPosition + (now - state.timestamp) / 1000;
-            this.emit(GroupTransportStateEvents.transportStateChange, {
-                type: GroupTransportStateEvents.transportStateChange,
+                state.startPosition +
+                ((now - state.timestamp) / 1000) * this._playbackRate.rate;
+            const event: ITransportStateChangeEvent = {
+                name: GroupTransportStateEvents.transportStateChange,
                 action: "play",
                 clientId: state.clientId,
                 seekTime: projectedPosition,
                 source,
-            });
+            };
+            this.emit(GroupTransportStateEvents.transportStateChange, event);
         } else {
-            this.emit(GroupTransportStateEvents.transportStateChange, {
-                type: GroupTransportStateEvents.transportStateChange,
+            const event: ITransportStateChangeEvent = {
+                name: GroupTransportStateEvents.transportStateChange,
                 action: "pause",
                 clientId: state.clientId,
                 seekTime: state.startPosition,
                 source,
-            });
+            };
+            this.emit(GroupTransportStateEvents.transportStateChange, event);
         }
 
         return true;

package/src/internals/consts.ts

@@ -16,6 +16,7 @@ export const TelemetryEvents = {
         PlayAction: "MediaPlayerSynchronizer:PlayAction",
         PauseAction: "MediaPlayerSynchronizer:PauseAction",
         SeekToAction: "MediaPlayerSynchronizer:SeekToAction",
+        RateChangeAction: "MediaPlayerSynchronizer:RateChangeAction",
         CatchupAction: "MediaPlayerSynchronizer:CatchupAction",
         SetTrackAction: "MediaPlayerSynchronizer:SetTrackAction",
         DataChangeAction: "MediaPlayerSynchronizer:DataChangeAction",
@@ -24,8 +25,6 @@ export const TelemetryEvents = {
         ),
         UserTappedVideoToPlayError:
             "MediaPlayerSynchronizer:UserTappedVideoToPlayError",
-        PlaybackRateChangeBlocked:
-            "MediaPlayerSynchronizer:PlaybackRateChangeBlocked",
         PlayerBlockedOperation: transmit(
             "MediaPlayerSynchronizer:PlayerBlockedOperation"
         ),
@@ -36,6 +35,7 @@ export const TelemetryEvents = {
         PlayCalled: "MediaPlayerSynchronizer:PlayCalled",
         PauseCalled: "MediaPlayerSynchronizer:PauseCalled",
         SeekToCalled: "MediaPlayerSynchronizer:SeekToCalled",
+        RateChangeCalled: "MediaSession:RateChangeCalled",
         SetTrackCalled: "MediaPlayerSynchronizer:SetTrackCalled",
         SetTrackDataCalled: "MediaPlayerSynchronizer:SetTrackDataCalled",
     },
@@ -43,6 +43,7 @@ export const TelemetryEvents = {
         PlayAction: transmit("MediaSession:PlayAction"),
         PauseAction: transmit("MediaSession:PauseAction"),
         SeekToAction: transmit("MediaSession:SeekToAction"),
+        RateChangeAction: transmit("MediaSession:RateChangeAction"),
         CatchUpAction: transmit("MediaSession:CatchUpAction"),
         SetTrackAction: transmit("MediaSession:SetTrackAction"),
         DataChangeAction: "MediaSession:DataChangeAction",
@@ -52,6 +53,9 @@ export const TelemetryEvents = {
         PlayCalled: transmit("SessionCoordinator:PlayCalled"),
         PauseCalled: transmit("SessionCoordinator:PauseCalled"),
         SeekToCalled: transmit("SessionCoordinator:SeekToCalled"),
+        SetPlaybackRateCalled: transmit(
+            "SessionCoordinator:SetPlaybackRateCalled"
+        ),
         SetTrackCalled: transmit("SessionCoordinator:SetTrackCalled"),
         SetTrackDataCalled: "SessionCoordinator:SetTrackDataCalled",
         BeginSuspension: "SessionCoordinator:BeginSuspension",
@@ -74,6 +78,9 @@ export const TelemetryEvents = {
         RemoteSeekToReceived: transmit(
             "SessionCoordinator:RemoteSeekToReceived"
         ),
+        RemoteRateChangeReceived: transmit(
+            "SessionCoordinator:RemoteRateChangeReceived"
+        ),
         PositionUpdateEventError: "SessionCoordinator:PositionUpdateEventError",
         LiveObjectSynchronizerStartError:
             "SessionCoordinator:LiveObjectSynchronizerStartError",
@@ -86,12 +93,17 @@ export const TelemetryEvents = {
         TransportStateChanged: "GroupCoordinator:TransportStateChanged",
         TransportStateChangeDelayed:
             "GroupCoordinator:TransportStateChangeDelayed",
+        PlaybackRateChanged: "GroupCoordinator:PlaybackRateChanged",
+        PlaybackRateChangedDelayed: "GroupCoordinator:PlaybackRateChanged",
         BeginSoftSuspension: "GroupCoordinator:BeginSoftSuspension",
         CheckingForSyncIssues: "GroupCoordinator:CheckingForSyncIssues",
         TrackOutOfSync: transmit("GroupCoordinator:TrackOutOfSync"),
         TrackDataOutOfSync: transmit("GroupCoordinator:TrackDataOutOfSync"),
         TransportOutOfSync: transmit("GroupCoordinator:TransportOutOfSync"),
         PositionOutOfSync: transmit("GroupCoordinator:PositionOutOfSync"),
+        PlaybackRateOutOfSync: transmit(
+            "GroupCoordinator:PlaybackRateOutOfSync"
+        ),
     },
 };
 

package/src/internals/index.ts

@@ -9,4 +9,5 @@ export * from "./GroupPlaybackPosition";
 export * from "./GroupPlaybackTrack";
 export * from "./GroupPlaybackTrackData";
 export * from "./GroupTransportState";
+export * from "./GroupPlaybackRate";
 export * from "./errors";

package/src/internals/interfaces.ts

@@ -0,0 +1,10 @@
+import { IEvent } from "@microsoft/live-share";
+import { ExtendedMediaSessionActionSource } from "../MediaSessionExtensions";
+
+/**
+ * @hidden
+ */
+export interface IGroupStateEvent extends IEvent {
+    clientId: string;
+    source: ExtendedMediaSessionActionSource;
+}