@microsoft/live-share-media 1.2.0 → 1.2.1

package/src/internals/GroupCoordinatorState.ts

@@ -17,6 +17,7 @@ import {
     CoordinationWaitPoint,
     ExtendedMediaSessionPlaybackState,
     ExtendedMediaSessionActionDetails,
+    ExtendedMediaSessionActionSource,
 } from "../MediaSessionExtensions";
 import {
     GroupPlaybackTrack,
@@ -150,7 +151,7 @@ export class GroupCoordinatorState extends EventEmitter {
                 this._logger.sendTelemetryEvent(
                     TelemetryEvents.GroupCoordinator.TrackChanged
                 );
-                this.emitSetTrack(evt.clientId, evt.metadata!);
+                this.emitSetTrack(evt.clientId, evt.metadata!, evt.source);
             } else {
                 this._logger.sendTelemetryEvent(
                     TelemetryEvents.GroupCoordinator.TrackChangeDelayed
@@ -161,15 +162,18 @@ export class GroupCoordinatorState extends EventEmitter {
         // Listen for track data changes
         this._playbackTrackData.on(
             PlaybackTrackDataEvents.dataChange,
-            (evt) => {
+            async (evt) => {
                 if (!this.isSuspended && !this.isWaiting) {
                     this._logger.sendTelemetryEvent(
                         TelemetryEvents.GroupCoordinator.TrackDataChanged
                     );
+                    const clientId = await waitUntilConnected(this._runtime);
                     this.emitTriggerAction({
                         action: "datachange",
+                        source: evt.source,
                         data: evt.data,
                         clientId: evt.clientId,
+                        local: evt.clientId === clientId,
                     });
                 } else {
                     this._logger.sendTelemetryEvent(
@@ -182,7 +186,7 @@ export class GroupCoordinatorState extends EventEmitter {
         // Listen to transport related events
         this._transportState.on(
             GroupTransportStateEvents.transportStateChange,
-            (evt) => {
+            async (evt) => {
                 if (!this.isSuspended && !this.isWaiting) {
                     this._logger.sendTelemetryEvent(
                         TelemetryEvents.GroupCoordinator.TransportStateChanged,
@@ -193,12 +197,18 @@ export class GroupCoordinatorState extends EventEmitter {
                         }
                     );
 
+                    const localClientId = await waitUntilConnected(
+                        this._runtime
+                    );
+                    const local = evt.clientId === localClientId;
                     // Trigger action
                     switch (evt.action) {
                         case "play":
                             this.emitTriggerAction({
                                 action: "play",
+                                source: evt.source,
                                 clientId: evt.clientId,
+                                local,
                                 seekTime: evt.seekTime,
                             });
                             break;
@@ -206,7 +216,9 @@ export class GroupCoordinatorState extends EventEmitter {
                         case "pause":
                             this.emitTriggerAction({
                                 action: "pause",
+                                source: evt.source,
                                 clientId: evt.clientId,
+                                local,
                                 seekTime: evt.seekTime,
                             });
                             break;
@@ -214,7 +226,9 @@ export class GroupCoordinatorState extends EventEmitter {
                         case "seekto":
                             this.emitTriggerAction({
                                 action: "seekto",
+                                source: evt.source,
                                 clientId: evt.clientId,
+                                local,
                                 seekTime: evt.seekTime,
                             });
                             break;
@@ -319,12 +333,15 @@ export class GroupCoordinatorState extends EventEmitter {
     ): void {
         // Update shared track
         // - Will trigger 'trackChange' event to update media session
-        const updated = this.playbackTrack.updateTrack({
-            metadata: event.data.metadata,
-            waitPoints: event.data.waitPoints,
-            timestamp: event.timestamp,
-            clientId: event.clientId || "",
-        });
+        const updated = this.playbackTrack.updateTrack(
+            {
+                metadata: event.data.metadata,
+                waitPoints: event.data.waitPoints,
+                timestamp: event.timestamp,
+                clientId: event.clientId || "",
+            },
+            "user"
+        );
 
         if (updated) {
             this._logger.sendTelemetryEvent(
@@ -346,11 +363,14 @@ export class GroupCoordinatorState extends EventEmitter {
     ): void {
         // Update shared track data
         // - Will trigger 'dataChange' event to update media session
-        const updated = this.playbackTrackData.updateData({
-            data: event.data.data,
-            timestamp: event.timestamp,
-            clientId: event.clientId || "",
-        });
+        const updated = this.playbackTrackData.updateData(
+            {
+                data: event.data.data,
+                timestamp: event.timestamp,
+                clientId: event.clientId || "",
+            },
+            "user"
+        );
 
         if (updated) {
             this._logger.sendTelemetryEvent(
@@ -372,7 +392,7 @@ export class GroupCoordinatorState extends EventEmitter {
     ): void {
         // Ensure change is for current track
         // - Will trigger a 'trackChange' event if newer track.
-        this.playbackTrack.updateTrack(event.data.track);
+        this.playbackTrack.updateTrack(event.data.track, "system");
         if (this.playbackTrack.compare(event.data.track.metadata)) {
             // Update playback state
             let playbackState = this.transportState.playbackState;
@@ -392,7 +412,7 @@ export class GroupCoordinatorState extends EventEmitter {
                 timestamp: event.timestamp,
                 clientId: event.clientId || "",
             };
-            const updated = this.transportState.updateState(newState);
+            const updated = this.transportState.updateState(newState, "user");
 
             if (updated) {
                 const correlationId = LiveTelemetryLogger.formatCorrelationId(
@@ -441,16 +461,16 @@ export class GroupCoordinatorState extends EventEmitter {
     ): void {
         // Ensure change is for current track
         // - Will trigger a 'trackChange' event if newer track.
-        this.playbackTrack.updateTrack(event.data.track);
+        this.playbackTrack.updateTrack(event.data.track, "system");
         if (this.playbackTrack.compare(event.data.track.metadata)) {
             // Ensure we have the latest track data
-            this.playbackTrackData.updateData(event.data.trackData);
+            this.playbackTrackData.updateData(event.data.trackData, "system");
 
             // 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.data.playbackState != "ended") {
-                this.transportState.updateState(event.data.transport);
+                this.transportState.updateState(event.data.transport, "system");
             }
 
             // Ensure change is for current transport state
@@ -529,7 +549,8 @@ export class GroupCoordinatorState extends EventEmitter {
                 );
                 this.emitSetTrack(
                     this.playbackTrack.current.clientId,
-                    this.playbackTrack.metadata!
+                    this.playbackTrack.metadata!,
+                    "system"
                 );
                 return;
             }
@@ -568,11 +589,14 @@ export class GroupCoordinatorState extends EventEmitter {
                     );
                     await this.emitTriggerAction({
                         action: "catchup",
+                        source: "system",
                         clientId: await waitUntilConnected(this._runtime),
+                        local: true,
                         seekTime: target,
                     });
                 }
 
+                const localClientId = await waitUntilConnected(this._runtime);
                 // Sync transport state
                 if (this.transportState.playbackState != playbackState) {
                     this._logger.sendTelemetryEvent(
@@ -583,17 +607,23 @@ export class GroupCoordinatorState extends EventEmitter {
                             target: this.transportState.playbackState,
                         }
                     );
+                    const local =
+                        localClientId === this.transportState.current.clientId;
                     switch (this.transportState.playbackState) {
                         case "playing":
                             await this.emitTriggerAction({
                                 action: "play",
+                                source: "system",
                                 clientId: this.transportState.current.clientId,
+                                local,
                             });
                             break;
                         case "paused":
                             await this.emitTriggerAction({
                                 action: "pause",
+                                source: "system",
                                 clientId: this.transportState.current.clientId,
+                                local,
                             });
                             break;
                     }
@@ -607,9 +637,14 @@ export class GroupCoordinatorState extends EventEmitter {
                     this._logger.sendTelemetryEvent(
                         TelemetryEvents.GroupCoordinator.TrackDataOutOfSync
                     );
+                    const local =
+                        localClientId ===
+                        this.playbackTrackData.current.clientId;
                     await this.emitTriggerAction({
                         action: "datachange",
+                        source: "system",
                         clientId: this.playbackTrackData.current.clientId,
+                        local,
                         data: this.playbackTrackData.data,
                     });
                 }
@@ -617,17 +652,21 @@ export class GroupCoordinatorState extends EventEmitter {
         }
     }
 
-    private emitSetTrack(
+    private async emitSetTrack(
         clientId: string,
-        metadata: ExtendedMediaMetadata
-    ): void {
+        metadata: ExtendedMediaMetadata,
+        source: ExtendedMediaSessionActionSource
+    ): Promise<void> {
         // Reset tracking states
         this._waitPoint = undefined;
 
+        const localClientId = await waitUntilConnected(this._runtime);
         // Trigger settrack action
         this.emitTriggerAction({
             action: "settrack",
+            source,
             clientId,
+            local: localClientId === clientId,
             metadata,
         });
     }

package/src/internals/GroupPlaybackTrack.ts

@@ -9,6 +9,7 @@ import { IMediaPlayerState } from "../LiveMediaSessionCoordinator";
 import {
     CoordinationWaitPoint,
     ExtendedMediaMetadata,
+    ExtendedMediaSessionActionSource,
 } from "../MediaSessionExtensions";
 
 /**
@@ -99,7 +100,10 @@ export class GroupPlaybackTrack extends EventEmitter {
         return undefined;
     }
 
-    public updateTrack(track: IPlaybackTrack): boolean {
+    public updateTrack(
+        track: IPlaybackTrack,
+        source: ExtendedMediaSessionActionSource
+    ): boolean {
         // Guard against missing waitPoints collection
         if (!Array.isArray(track.waitPoints)) {
             track.waitPoints = [];
@@ -149,6 +153,7 @@ export class GroupPlaybackTrack extends EventEmitter {
             name: GroupPlaybackTrackEvents.trackChange,
             clientId: track.clientId,
             metadata: track.metadata,
+            source,
         });
 
         return true;

package/src/internals/GroupPlaybackTrackData.ts

@@ -9,6 +9,7 @@ import {
     GroupPlaybackTrack,
     GroupPlaybackTrackEvents,
 } from "./GroupPlaybackTrack";
+import { ExtendedMediaSessionActionSource } from "../MediaSessionExtensions";
 
 /**
  * @hidden
@@ -64,7 +65,10 @@ export class GroupPlaybackTrackData extends EventEmitter {
         return this.current.data;
     }
 
-    public updateData(event: IPlaybackTrackData): boolean {
+    public updateData(
+        event: IPlaybackTrackData,
+        source: ExtendedMediaSessionActionSource
+    ): boolean {
         // Ignore state changes that are older
         const current = this.current;
         if (event.timestamp < current.timestamp) {
@@ -92,6 +96,7 @@ export class GroupPlaybackTrackData extends EventEmitter {
             type: PlaybackTrackDataEvents.dataChange,
             clientId: event.clientId,
             data: event.data,
+            source,
         });
 
         return true;

package/src/internals/GroupTransportState.ts

@@ -9,6 +9,7 @@ import { IMediaPlayerState } from "../LiveMediaSessionCoordinator";
 import {
     ExtendedMediaSessionPlaybackState,
     ExtendedMediaSessionAction,
+    ExtendedMediaSessionActionSource,
 } from "../MediaSessionExtensions";
 import {
     GroupPlaybackTrack,
@@ -104,7 +105,10 @@ export class GroupTransportState extends EventEmitter {
         );
     }
 
-    public updateState(state: ITransportState): boolean {
+    public updateState(
+        state: ITransportState,
+        source: ExtendedMediaSessionActionSource
+    ): boolean {
         // Ignore if same playback state and start position
         if (this.compare(state)) {
             return false;
@@ -138,6 +142,7 @@ export class GroupTransportState extends EventEmitter {
                 action: "seekto",
                 clientId: state.clientId,
                 seekTime: state.startPosition,
+                source,
             });
         } else if (state.playbackState == "playing") {
             const now = this._liveRuntime.getTimestamp();
@@ -148,6 +153,7 @@ export class GroupTransportState extends EventEmitter {
                 action: "play",
                 clientId: state.clientId,
                 seekTime: projectedPosition,
+                source,
             });
         } else {
             this.emit(GroupTransportStateEvents.transportStateChange, {
@@ -155,6 +161,7 @@ export class GroupTransportState extends EventEmitter {
                 action: "pause",
                 clientId: state.clientId,
                 seekTime: state.startPosition,
+                source,
             });
         }