@microsoft/live-share-media 0.1.1 → 0.2.1

package/src/internals/GroupPlaybackTrackData.ts

@@ -1,27 +1,40 @@
 /**
  * Copyright (c) Microsoft Corporation. All rights reserved.
- * Licensed under the MIT License.
+ * Licensed under the Microsoft Live Share SDK License.
  */
 
 import { IEvent } from '@microsoft/live-share';
 import EventEmitter from 'events';
 import { GroupPlaybackTrack, GroupPlaybackTrackEvents } from './GroupPlaybackTrack';
 
-export interface IPlaybackTrackData {
+
+/**
+ * @hidden
+ */
+ export interface IPlaybackTrackData {
     data: object|null;
     timestamp: number;
     clientId: string;
 }
 
-export enum PlaybackTrackDataEvents {
+/**
+ * @hidden
+ */
+ export enum PlaybackTrackDataEvents {
     dataChange = 'dataChange'
 }
 
+/**
+ * @hidden
+ */
 export interface IPlaybackTrackDataChangeEvent extends IEvent {
     data: object|null;
 }
 
-export class GroupPlaybackTrackData extends EventEmitter {
+/**
+ * @hidden
+ */
+ export class GroupPlaybackTrackData extends EventEmitter {
     private _track: GroupPlaybackTrack;
     private _current: IPlaybackTrackData;
 
@@ -50,7 +63,7 @@ export class GroupPlaybackTrackData extends EventEmitter {
     }
 
     public updateData(event: IPlaybackTrackData): boolean {
-        // Ignore state changes that are older 
+        // Ignore state changes that are older
         const current = this.current;
         if (event.timestamp < current.timestamp) {
             return false;
@@ -70,8 +83,8 @@ export class GroupPlaybackTrackData extends EventEmitter {
         this._current = event;
 
         // Notify listeners
-        this.emit(PlaybackTrackDataEvents.dataChange, { type: PlaybackTrackDataEvents.dataChange, data: event.data }); 
-        
+        this.emit(PlaybackTrackDataEvents.dataChange, { type: PlaybackTrackDataEvents.dataChange, data: event.data });
+
         return true;
     }
 }

package/src/internals/GroupTransportState.ts

@@ -1,6 +1,6 @@
 /**
  * Copyright (c) Microsoft Corporation. All rights reserved.
- * Licensed under the MIT License.
+ * Licensed under the Microsoft Live Share SDK License.
  */
 
 import { IEvent, EphemeralEvent } from '@microsoft/live-share';
@@ -9,23 +9,36 @@ import { IMediaPlayerState } from '../EphemeralMediaSessionCoordinator';
 import { ExtendedMediaSessionPlaybackState, ExtendedMediaSessionAction } from '../MediaSessionExtensions';
 import { GroupPlaybackTrack, GroupPlaybackTrackEvents } from './GroupPlaybackTrack';
 
-export interface ITransportState {
+
+/**
+ * @hidden
+ */
+ export interface ITransportState {
     playbackState: ExtendedMediaSessionPlaybackState;
     startPosition: number;
     timestamp: number;
     clientId: string;
 }
 
+/**
+ * @hidden
+ */
 export enum GroupTransportStateEvents {
     transportStateChange = 'transportStateChange'
 }
 
+/**
+ * @hidden
+ */
 export interface ITransportStateChangeEvent extends IEvent {
     action: ExtendedMediaSessionAction;
     seekTime?: number;
 }
 
-export class GroupTransportState extends EventEmitter {
+/**
+ * @hidden
+ */
+ export class GroupTransportState extends EventEmitter {
     private readonly _getMediaPlayerState: () => IMediaPlayerState;
     private _track: GroupPlaybackTrack;
     private _current: ITransportState;
@@ -83,7 +96,7 @@ export class GroupTransportState extends EventEmitter {
             return false;
         }
 
-        // Ignore state changes that are older 
+        // Ignore state changes that are older
         const originalState = this.current;
         if (state.timestamp < originalState.timestamp) {
             return false;
@@ -100,13 +113,13 @@ export class GroupTransportState extends EventEmitter {
         // Trigger transport change
         const playerState = this._getMediaPlayerState().playbackState;
         if (originalState.playbackState == state.playbackState && playerState != 'ended') {
-            this.emit(GroupTransportStateEvents.transportStateChange, { type: GroupTransportStateEvents.transportStateChange, action: 'seekto', seekTime: state.startPosition }); 
+            this.emit(GroupTransportStateEvents.transportStateChange, { type: GroupTransportStateEvents.transportStateChange, action: 'seekto', seekTime: state.startPosition });
         } else if (state.playbackState == 'playing') {
             const now = EphemeralEvent.getTimestamp();
             const projectedPosition = state.startPosition + ((now - state.timestamp) / 1000);
-            this.emit(GroupTransportStateEvents.transportStateChange, { type: GroupTransportStateEvents.transportStateChange, action: 'play', seekTime: projectedPosition}); 
+            this.emit(GroupTransportStateEvents.transportStateChange, { type: GroupTransportStateEvents.transportStateChange, action: 'play', seekTime: projectedPosition});
         } else {
-            this.emit(GroupTransportStateEvents.transportStateChange, { type: GroupTransportStateEvents.transportStateChange, action: 'pause', seekTime: state.startPosition}); 
+            this.emit(GroupTransportStateEvents.transportStateChange, { type: GroupTransportStateEvents.transportStateChange, action: 'pause', seekTime: state.startPosition});
         }
 
         return true;

package/src/internals/consts.ts

@@ -1,11 +1,12 @@
 /**
  * Copyright (c) Microsoft Corporation. All rights reserved.
- * Licensed under the MIT License.
+ * Licensed under the Microsoft Live Share SDK License.
  */
 
 /**
- * List of telemetry events. Wrap with a call to transmit() if the event should be transmitted to 
- * the telemetry service. 
+ * @hidden
+ * List of telemetry events. Wrap with a call to transmit() if the event should be transmitted to
+ * the telemetry service.
  */
 export const TelemetryEvents = {
     MediaPlayerSynchronizer: {
@@ -71,6 +72,9 @@ export const TelemetryEvents = {
     }
 }
 
+/**
+ * @hidden
+ */
 function transmit(eventName: string): string {
     return `${eventName}#transmit`;
 }

package/src/internals/index.ts

@@ -1,6 +1,6 @@
 /**
  * Copyright (c) Microsoft Corporation. All rights reserved.
- * Licensed under the MIT License.
+ * Licensed under the Microsoft Live Share SDK License.
  */
 
 export * from './consts';

package/src/test/GroupPlaybackPosition.spec.ts

@@ -1,6 +1,6 @@
 /**
  * Copyright (c) Microsoft Corporation. All rights reserved.
- * Licensed under the MIT License.
+ * Licensed under the Microsoft Live Share SDK License.
  */
 
 import 'mocha';

package/src/test/GroupPlaybackTrack.spec.ts

@@ -1,6 +1,6 @@
 /**
  * Copyright (c) Microsoft Corporation. All rights reserved.
- * Licensed under the MIT License.
+ * Licensed under the Microsoft Live Share SDK License.
  */
 
 import 'mocha';

package/src/test/SharedMediaSession.spec.ts

@@ -1,6 +1,6 @@
 /**
  * Copyright (c) Microsoft Corporation. All rights reserved.
- * Licensed under the MIT License.
+ * Licensed under the Microsoft Live Share SDK License.
  */
 
 import 'mocha';

package/src/test/SharedMediaSessionCoordinator.spec.ts

@@ -1,6 +1,6 @@
 /**
  * Copyright (c) Microsoft Corporation. All rights reserved.
- * Licensed under the MIT License.
+ * Licensed under the Microsoft Live Share SDK License.
  */
 
 import 'mocha';