@microsoft/live-share-media 2.0.0-internal.3 → 2.0.0-internal.4

package/nyc/junit-report.xml

@@ -0,0 +1,54 @@
+<testsuite name="@microsoft/live-share-media" tests="52" failures="0" errors="0" skipped="0" timestamp="Thu, 28 Mar 2024 19:12:27 GMT" time="15.076">
+<testcase classname="GroupPlaybackPosition" name="should start with 0 clients" time="0.001"/>
+<testcase classname="GroupPlaybackPosition" name="should find local position" time="0"/>
+<testcase classname="GroupPlaybackPosition" name="should update local position" time="0"/>
+<testcase classname="GroupPlaybackPosition" name="should ignore older position updates" time="0"/>
+<testcase classname="GroupPlaybackPosition" name="should track other client positions" time="0"/>
+<testcase classname="GroupPlaybackPosition" name="should enumerate client positions" time="0"/>
+<testcase classname="GroupPlaybackPosition" name="should ignore stale positions" time="0"/>
+<testcase classname="GroupPlaybackPosition" name="should project position when playing" time="0"/>
+<testcase classname="GroupPlaybackPosition" name="should compute max playback position relative to transport state" time="0.001"/>
+<testcase classname="GroupPlaybackPosition" name="should compute target position relative to other client positions" time="0"/>
+<testcase classname="GroupPlaybackPosition" name="should limit max and target position by media duration" time="0"/>
+<testcase classname="GroupPlaybackPosition" name="should count number of waiting clients" time="0.001"/>
+<testcase classname="GroupPlaybackPosition" name="should drop waiting count after suspension ends" time="0"/>
+<testcase classname="GroupPlaybackPosition" name="should drop waiting count to 0 after all clients reach wait point" time="0"/>
+<testcase classname="GroupPlaybackRate" name="updatePlaybackRate should return false for older events" time="0"/>
+<testcase classname="GroupPlaybackRate" name="updatePlaybackRate should return false for events that are the same time, but clientId is higher sort" time="0"/>
+<testcase classname="GroupPlaybackTrack" name="should fire &#x22;trackChange&#x22; event when no media" time="0"/>
+<testcase classname="GroupPlaybackTrack" name="should switch tracks" time="0"/>
+<testcase classname="GroupPlaybackTrack" name="should ignore track changes with older timestamps" time="0"/>
+<testcase classname="GroupPlaybackTrack" name="should insert waitpoint if no existing waitpoints" time="0"/>
+<testcase classname="GroupPlaybackTrack" name="should insert waitpoints in correct order" time="0"/>
+<testcase classname="GroupPlaybackTrack" name="updateTrack should return false for events that are the same time, but clientId is higher sort" time="0"/>
+<testcase classname="GroupPlaybackTrackData" name="updateData should return false for older events" time="0"/>
+<testcase classname="GroupPlaybackTrackData" name="updateData should return false for events that are the same time, but clientId is higher sort" time="0"/>
+<testcase classname="LiveMediaSession Manual Action Handlers (mostly testing coordinator) Fluid Test: LiveMediaSession Manual Action Handlers (mostly testing coordinator)" name="should send &#x27;positionUpdate&#x27; event when someone joins." time="0.027"/>
+<testcase classname="LiveMediaSession Manual Action Handlers (mostly testing coordinator) Fluid Test: LiveMediaSession Manual Action Handlers (mostly testing coordinator)" name="should not send &#x27;positionUpdate&#x27; event if object has canSendPositionUpdates set to false" time="0.008"/>
+<testcase classname="LiveMediaSession Manual Action Handlers (mostly testing coordinator) Fluid Test: LiveMediaSession Manual Action Handlers (mostly testing coordinator)" name="should send &#x27;positionUpdate&#x27; event if object has canSendPositionUpdates set to false, but is suspended" time="0.01"/>
+<testcase classname="LiveMediaSession Manual Action Handlers (mostly testing coordinator) Fluid Test: LiveMediaSession Manual Action Handlers (mostly testing coordinator)" name="should send &#x27;positionUpdate&#x27; event regularly." time="0.514"/>
+<testcase classname="LiveMediaSession Manual Action Handlers (mostly testing coordinator) Fluid Test: LiveMediaSession Manual Action Handlers (mostly testing coordinator)" name="should broadcast &#x27;play&#x27; transport command." time="0.022"/>
+<testcase classname="LiveMediaSession Manual Action Handlers (mostly testing coordinator) Fluid Test: LiveMediaSession Manual Action Handlers (mostly testing coordinator)" name="should broadcast &#x27;pause&#x27; transport command." time="0.008"/>
+<testcase classname="LiveMediaSession Manual Action Handlers (mostly testing coordinator) Fluid Test: LiveMediaSession Manual Action Handlers (mostly testing coordinator)" name="should broadcast &#x27;seekTo&#x27; transport command." time="0.006"/>
+<testcase classname="LiveMediaSession Manual Action Handlers (mostly testing coordinator) Fluid Test: LiveMediaSession Manual Action Handlers (mostly testing coordinator)" name="should broadcast &#x27;setTrack&#x27; transport command." time="0.006"/>
+<testcase classname="LiveMediaSession Manual Action Handlers (mostly testing coordinator) Fluid Test: LiveMediaSession Manual Action Handlers (mostly testing coordinator)" name="should broadcast &#x27;catchup&#x27; transport command." time="2.03"/>
+<testcase classname="LiveMediaSession Using MediaPlayerSynchronizer Fluid Test: LiveMediaSession Using MediaPlayerSynchronizer" name="should play and pause on both" time="0.316"/>
+<testcase classname="LiveMediaSession Using MediaPlayerSynchronizer Fluid Test: LiveMediaSession Using MediaPlayerSynchronizer" name="should seek forward and play then pause" time="0.318"/>
+<testcase classname="LiveMediaSession Using MediaPlayerSynchronizer Fluid Test: LiveMediaSession Using MediaPlayerSynchronizer" name="should play then seek forward then pause" time="0.419"/>
+<testcase classname="LiveMediaSession Using MediaPlayerSynchronizer Fluid Test: LiveMediaSession Using MediaPlayerSynchronizer" name="should play then seek backwards then keep playing" time="0.317"/>
+<testcase classname="LiveMediaSession Using MediaPlayerSynchronizer Fluid Test: LiveMediaSession Using MediaPlayerSynchronizer" name="should change playback rate" time="0.216"/>
+<testcase classname="LiveMediaSession Using MediaPlayerSynchronizer Fluid Test: LiveMediaSession Using MediaPlayerSynchronizer" name="should only let organizer play, pause, seek" time="0.018"/>
+<testcase classname="LiveMediaSession Using MediaPlayerSynchronizer Fluid Test: LiveMediaSession Using MediaPlayerSynchronizer" name="should setTrack" time="0.309"/>
+<testcase classname="LiveMediaSession Using MediaPlayerSynchronizer Fluid Test: LiveMediaSession Using MediaPlayerSynchronizer" name="should beginSeek and suspend till endSeek" time="0.319"/>
+<testcase classname="LiveMediaSession Using MediaPlayerSynchronizer Fluid Test: LiveMediaSession Using MediaPlayerSynchronizer" name="should not load twice" time="0.215"/>
+<testcase classname="LiveMediaSession Using MediaPlayerSynchronizer Fluid Test: LiveMediaSession Using MediaPlayerSynchronizer" name="should suspend at waitpoint with DIFFERENT player for ad" time="1.516"/>
+<testcase classname="LiveMediaSession Using MediaPlayerSynchronizer Fluid Test: LiveMediaSession Using MediaPlayerSynchronizer" name="should suspend at waitpoint with SAME player for ad" time="1.516"/>
+<testcase classname="LiveMediaSession Using MediaPlayerSynchronizer Fluid Test: LiveMediaSession Using MediaPlayerSynchronizer" name="client should catchup to leader" time="1.723"/>
+<testcase classname="VolumeManager" name="should ramp down volume" time="0.778"/>
+<testcase classname="VolumeManager" name="should ramp up volume" time="1.05"/>
+<testcase classname="VolumeManager" name="should ramp down halfway, then ramp up" time="0.774"/>
+<testcase classname="VolumeManager" name="ramp using selected volume" time="0.525"/>
+<testcase classname="VolumeManager" name="enable limit, change selected volume, then disable limit" time="0.776"/>
+<testcase classname="VolumeManager" name="ramp down with selected volume to 0.3, then up to 0.8" time="0.775"/>
+<testcase classname="VolumeManager" name="test 50% limiting" time="0.526"/>
+</testsuite>

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@microsoft/live-share-media",
-    "version": "2.0.0-internal.3",
+    "version": "2.0.0-internal.4",
     "description": "Live Share classes that synchronize media playback across clients.",
     "author": "Microsoft",
     "license": "SEE LICENSE IN LICENSE",
@@ -15,7 +15,7 @@
         "test:race": "node ./../live-share/test-for-race-conditions.js"
     },
     "devDependencies": {
-        "@microsoft/live-share": "2.0.0-internal.3",
+        "@microsoft/live-share": "2.0.0-internal.4",
         "@fluidframework/mocha-test-setup": "^2.0.0-rc.1",
         "@fluidframework/test-runtime-utils": "^2.0.0-rc.1",
         "@fluidframework/test-utils": "^2.0.0-rc.1",
@@ -30,7 +30,7 @@
         "typescript": "^5.0.4"
     },
     "peerDependencies": {
-        "@microsoft/live-share": "2.0.0-internal.3",
+        "@microsoft/live-share": "2.0.0-internal.4",
         "fluid-framework": "^2.0.0-rc || ^2.0.0-internal"
     },
     "repository": {

package/src/LiveMediaSessionCoordinator.ts

@@ -36,8 +36,9 @@ import {
     IRateChangeCommandEvent,
 } from "./internals";
 import { LiveMediaSessionCoordinatorSuspension } from "./LiveMediaSessionCoordinatorSuspension";
-import EventEmitter from "events";
 import { isErrorLike } from "@microsoft/live-share/bin/internals";
+import { TypedEventEmitter } from "@fluid-internal/client-utils";
+import { IEvent } from "@fluidframework/common-definitions";
 
 /**
  * Most recent state of the media session.
@@ -67,12 +68,25 @@ export interface IMediaPlayerState {
     positionState?: MediaPositionState;
 }
 
+/**
+ * @hidden
+ */
+export interface ILiveMediaSessionCoordinatorEvents extends IEvent {
+    /**
+     * Event listener for events emitted
+     * @param event update
+     * @param listener listener function
+     * @param listener.event the event instance
+     */
+    (event: string, listener: (event: any) => void): void;
+}
+
 /**
  * The `LiveMediaSessionCoordinator` tracks the playback & position state of all other
  * clients being synchronized with. It is responsible for keeping the local media player
  * in sync with the group.
  */
-export class LiveMediaSessionCoordinator extends EventEmitter {
+export class LiveMediaSessionCoordinator extends TypedEventEmitter<ILiveMediaSessionCoordinatorEvents> {
     private readonly _id: string;
     private readonly _runtime: IRuntimeSignaler;
     private readonly _liveRuntime: LiveShareRuntime;

package/src/MediaPlayerSynchronizer.ts

@@ -7,7 +7,6 @@ import {
     ILiveEvent,
     IRuntimeSignaler,
 } from "@microsoft/live-share";
-import EventEmitter from "events";
 import {
     ExtendedMediaSessionAction,
     ExtendedMediaSessionPlaybackState,
@@ -22,6 +21,8 @@ import { LiveMediaSession } from "./LiveMediaSession";
 import { IMediaPlayer } from "./IMediaPlayer";
 import { ITriggerActionEvent, TelemetryEvents } from "./internals";
 import { waitUntilConnected } from "@microsoft/live-share/bin/internals";
+import { TypedEventEmitter } from "@fluid-internal/client-utils";
+import { IEvent } from "@fluidframework/common-definitions";
 
 /**
  * Event data returned by `MediaPlayerSynchronizer` object.
@@ -49,6 +50,20 @@ export enum MediaPlayerSynchronizerEvents {
     useraction = "useraction",
 }
 
+/**
+ * @hidden
+ * Emitted events from the `MediaPlayerSynchronizer` class.
+ */
+export interface IMediaPlayerSynchronizerEvents extends IEvent {
+    /**
+     * Event listener for events emitted
+     * @param event update
+     * @param listener listener function
+     * @param listener.event the event instance
+     */
+    (event: string, listener: (event: any) => void): void;
+}
+
 /**
  * Synchronizes a local HTML Media Element with a group of remote HTML Media Elements.
  *
@@ -58,7 +73,7 @@ export enum MediaPlayerSynchronizerEvents {
  * 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 class MediaPlayerSynchronizer extends EventEmitter {
+export class MediaPlayerSynchronizer extends TypedEventEmitter<IMediaPlayerSynchronizerEvents> {
     private static SESSION_ACTIONS: ExtendedMediaSessionAction[] = [
         "play",
         "pause",

package/src/internals/GroupCoordinatorState.ts

@@ -11,7 +11,6 @@ import {
     LiveShareRuntime,
     IEvent,
 } from "@microsoft/live-share";
-import EventEmitter from "events";
 import {
     ExtendedMediaMetadata,
     CoordinationWaitPoint,
@@ -50,6 +49,9 @@ import {
     IPlaybackRateChangeEvent,
     PlaybackRateEvents,
 } from "./GroupPlaybackRate";
+import { TypedEventEmitter } from "@fluid-internal/client-utils";
+import { IEvent as FluidIEvent } from "@fluidframework/common-definitions";
+import { IGenericTypedEvents } from "./interfaces";
 
 /**
  * @hidden
@@ -113,7 +115,7 @@ export enum GroupCoordinatorStateEvents {
 /**
  * @hidden
  */
-export class GroupCoordinatorState extends EventEmitter {
+export class GroupCoordinatorState extends TypedEventEmitter<IGenericTypedEvents> {
     private readonly _runtime: IRuntimeSignaler;
     private readonly _liveRuntime: LiveShareRuntime;
     private readonly _logger: LiveTelemetryLogger;

package/src/internals/GroupPlaybackRate.ts

@@ -3,9 +3,9 @@
  * Licensed under the Microsoft Live Share SDK License.
  */
 
-import EventEmitter from "events";
+import { TypedEventEmitter } from "@fluid-internal/client-utils";
 import { ExtendedMediaSessionActionSource } from "../MediaSessionExtensions";
-import { IGroupStateEvent } from "./interfaces";
+import { IGroupStateEvent, IGenericTypedEvents } from "./interfaces";
 
 /**
  * @hidden
@@ -33,7 +33,7 @@ export interface IPlaybackRateChangeEvent extends IGroupStateEvent {
 /**
  * @hidden
  */
-export class GroupPlaybackRate extends EventEmitter {
+export class GroupPlaybackRate extends TypedEventEmitter<IGenericTypedEvents> {
     private _current: IPlaybackRate;
 
     constructor() {

package/src/internals/GroupPlaybackTrack.ts

@@ -3,14 +3,14 @@
  * Licensed under the Microsoft Live Share SDK License.
  */
 
-import EventEmitter from "events";
 import { IMediaPlayerState } from "../LiveMediaSessionCoordinator";
 import {
     CoordinationWaitPoint,
     ExtendedMediaMetadata,
     ExtendedMediaSessionActionSource,
 } from "../MediaSessionExtensions";
-import { IGroupStateEvent } from "./interfaces";
+import { IGenericTypedEvents, IGroupStateEvent } from "./interfaces";
+import { TypedEventEmitter } from "@fluid-internal/client-utils";
 
 /**
  * @hidden
@@ -39,7 +39,7 @@ export interface IPlaybackTrackChangeEvent extends IGroupStateEvent {
 /**
  * @hidden
  */
-export class GroupPlaybackTrack extends EventEmitter {
+export class GroupPlaybackTrack extends TypedEventEmitter<IGenericTypedEvents> {
     private readonly _getMediaPlayerState: () => IMediaPlayerState;
     private _current: IPlaybackTrack;
 

package/src/internals/GroupPlaybackTrackData.ts

@@ -3,13 +3,13 @@
  * Licensed under the Microsoft Live Share SDK License.
  */
 
-import EventEmitter from "events";
 import {
     GroupPlaybackTrack,
     GroupPlaybackTrackEvents,
 } from "./GroupPlaybackTrack";
 import { ExtendedMediaSessionActionSource } from "../MediaSessionExtensions";
-import { IGroupStateEvent } from "./interfaces";
+import { IGenericTypedEvents, IGroupStateEvent } from "./interfaces";
+import { TypedEventEmitter } from "@fluid-internal/client-utils";
 
 /**
  * @hidden
@@ -37,7 +37,7 @@ export interface IPlaybackTrackDataChangeEvent extends IGroupStateEvent {
 /**
  * @hidden
  */
-export class GroupPlaybackTrackData extends EventEmitter {
+export class GroupPlaybackTrackData extends TypedEventEmitter<IGenericTypedEvents> {
     private _track: GroupPlaybackTrack;
     private _current: IPlaybackTrackData;
 

package/src/internals/GroupTransportState.ts

@@ -4,7 +4,7 @@
  */
 
 import { LiveShareRuntime } from "@microsoft/live-share";
-import EventEmitter from "events";
+import { TypedEventEmitter } from "@fluid-internal/client-utils";
 import { IMediaPlayerState } from "../LiveMediaSessionCoordinator";
 import {
     ExtendedMediaSessionPlaybackState,
@@ -15,7 +15,7 @@ import {
     GroupPlaybackTrack,
     GroupPlaybackTrackEvents,
 } from "./GroupPlaybackTrack";
-import { IGroupStateEvent } from "./interfaces";
+import { IGenericTypedEvents, IGroupStateEvent } from "./interfaces";
 import { GroupPlaybackRate } from "./GroupPlaybackRate";
 
 /**
@@ -46,7 +46,7 @@ export interface ITransportStateChangeEvent extends IGroupStateEvent {
 /**
  * @hidden
  */
-export class GroupTransportState extends EventEmitter {
+export class GroupTransportState extends TypedEventEmitter<IGenericTypedEvents> {
     private readonly _getMediaPlayerState: () => IMediaPlayerState;
     private _track: GroupPlaybackTrack;
     private _playbackRate: GroupPlaybackRate;

package/src/internals/interfaces.ts

@@ -1,4 +1,5 @@
 import { IEvent } from "@microsoft/live-share";
+import { IEvent as IFluidEvent } from "@fluidframework/common-definitions";
 import { ExtendedMediaSessionActionSource } from "../MediaSessionExtensions";
 
 /**
@@ -8,3 +9,16 @@ export interface IGroupStateEvent extends IEvent {
     clientId: string;
     source: ExtendedMediaSessionActionSource;
 }
+
+/**
+ * @hidden
+ */
+export interface IGenericTypedEvents extends IFluidEvent {
+    /**
+     * Event listener for events emitted
+     * @param event update
+     * @param listener listener function
+     * @param listener.event the event instance
+     */
+    (event: string, listener: (event: any) => void): void;
+}