@microsoft/live-share-media 0.5.1 → 1.0.0-preview.1

package/tsconfig.build.json

@@ -1,9 +1,9 @@
-{
-    "extends": "./tsconfig.json",
-    "compilerOptions": {
-      "target": "es6"                          /* Specify ECMAScript target version: 'ES3' (default), 'ES5', 'ES2015', 'ES2016', 'ES2017', 'ES2018', 'ES2019', 'ES2020', or 'ESNEXT'. */
-    },
-    "exclude": [
-      "test/**/*.ts"
-    ]
+{
+    "extends": "./tsconfig.json",
+    "compilerOptions": {
+      "target": "es6"                          /* Specify ECMAScript target version: 'ES3' (default), 'ES5', 'ES2015', 'ES2016', 'ES2017', 'ES2018', 'ES2019', 'ES2020', or 'ESNEXT'. */
+    },
+    "exclude": [
+      "test/**/*.ts"
+    ]
   }

package/tsconfig.json

@@ -1,75 +1,75 @@
-{
-  "compilerOptions": {
-    /* Visit https://aka.ms/tsconfig.json to read more about this file */
-
-    /* Basic Options */
-    // "incremental": true,                   /* Enable incremental compilation */
-    "target": "es6",                          /* Specify ECMAScript target version: 'ES3' (default), 'ES5', 'ES2015', 'ES2016', 'ES2017', 'ES2018', 'ES2019', 'ES2020', or 'ESNEXT'. */
-    "module": "commonjs",                     /* Specify module code generation: 'none', 'commonjs', 'amd', 'system', 'umd', 'es2015', 'es2020', or 'ESNext'. */
-    "lib": ["es2020","DOM"],                             /* Specify library files to be included in the compilation. */
-    "allowJs": false,                       /* Allow javascript files to be compiled. */
-    // "checkJs": true,                       /* Report errors in .js files. */
-    // "jsx": "preserve",                     /* Specify JSX code generation: 'preserve', 'react-native', or 'react'. */
-    "declaration": true,                   /* Generates corresponding '.d.ts' file. */
-    "declarationMap": true,                /* Generates a sourcemap for each corresponding '.d.ts' file. */
-    "sourceMap": true,                     /* Generates corresponding '.map' file. */
-    // "outFile": "./",                       /* Concatenate and emit output to single file. */
-    "outDir": "./bin",                        /* Redirect output structure to the directory. */
-    // "rootDir": "./src",                       /* Specify the root directory of input files. Use to control the output directory structure with --outDir. */
-    // "composite": true,                     /* Enable project compilation */
-    // "tsBuildInfoFile": "./",               /* Specify file to store incremental compilation information */
-    // "removeComments": true,                /* Do not emit comments to output. */
-    // "noEmit": true,                        /* Do not emit outputs. */
-    // "importHelpers": true,                 /* Import emit helpers from 'tslib'. */
-    // "downlevelIteration": true,            /* Provide full support for iterables in 'for-of', spread, and destructuring when targeting 'ES5' or 'ES3'. */
-    // "isolatedModules": true,               /* Transpile each file as a separate module (similar to 'ts.transpileModule'). */
-
-    /* Strict Type-Checking Options */
-    "strict": true,                           /* Enable all strict type-checking options. */
-    // "noImplicitAny": true,                 /* Raise error on expressions and declarations with an implied 'any' type. */
-    // "strictNullChecks": true,              /* Enable strict null checks. */
-    // "strictFunctionTypes": true,           /* Enable strict checking of function types. */
-    // "strictBindCallApply": true,           /* Enable strict 'bind', 'call', and 'apply' methods on functions. */
-    // "strictPropertyInitialization": true,  /* Enable strict checking of property initialization in classes. */
-    // "noImplicitThis": true,                /* Raise error on 'this' expressions with an implied 'any' type. */
-    // "alwaysStrict": true,                  /* Parse in strict mode and emit "use strict" for each source file. */
-
-    /* Additional Checks */
-    // "noUnusedLocals": true,                /* Report errors on unused locals. */
-    // "noUnusedParameters": true,            /* Report errors on unused parameters. */
-    // "noImplicitReturns": true,             /* Report error when not all code paths in function return a value. */
-    // "noFallthroughCasesInSwitch": true,    /* Report errors for fallthrough cases in switch statement. */
-
-    /* Module Resolution Options */
-    // "moduleResolution": "node",            /* Specify module resolution strategy: 'node' (Node.js) or 'classic' (TypeScript pre-1.6). */
-    // "baseUrl": "./",                       /* Base directory to resolve non-absolute module names. */
-    // "paths": {},                           /* A series of entries which re-map imports to lookup locations relative to the 'baseUrl'. */
-    // "rootDirs": [],                        /* List of root folders whose combined content represents the structure of the project at runtime. */
-    // "typeRoots": [],                       /* List of folders to include type definitions from. */
-    // "types": [],                           /* Type declaration files to be included in compilation. */
-    // "allowSyntheticDefaultImports": true,  /* Allow default imports from modules with no default export. This does not affect code emit, just typechecking. */
-    "esModuleInterop": true,                  /* Enables emit interoperability between CommonJS and ES Modules via creation of namespace objects for all imports. Implies 'allowSyntheticDefaultImports'. */
-    // "preserveSymlinks": true,              /* Do not resolve the real path of symlinks. */
-    // "allowUmdGlobalAccess": true,          /* Allow accessing UMD globals from modules. */
-
-    /* Source Map Options */
-    // "sourceRoot": "",                      /* Specify the location where debugger should locate TypeScript files instead of source locations. */
-    // "mapRoot": "",                         /* Specify the location where debugger should locate map files instead of generated locations. */
-    // "inlineSourceMap": true,               /* Emit a single file with source maps instead of having a separate file. */
-    // "inlineSources": true,                 /* Emit the source alongside the sourcemaps within a single file; requires '--inlineSourceMap' or '--sourceMap' to be set. */
-
-    /* Experimental Options */
-    // "experimentalDecorators": true,        /* Enables experimental support for ES7 decorators. */
-    // "emitDecoratorMetadata": true,         /* Enables experimental support for emitting type metadata for decorators. */
-
-    /* Advanced Options */
-    "skipLibCheck": true,                     /* Skip type checking of declaration files. */
-    "forceConsistentCasingInFileNames": true  /* Disallow inconsistently-cased references to the same file. */
-  },
-  "include": [
-    "test/**/*.ts"
-  ],
-  "files": [
-    "src/index.ts"
-  ]
-}
+{
+  "compilerOptions": {
+    /* Visit https://aka.ms/tsconfig.json to read more about this file */
+
+    /* Basic Options */
+    // "incremental": true,                   /* Enable incremental compilation */
+    "target": "es6",                          /* Specify ECMAScript target version: 'ES3' (default), 'ES5', 'ES2015', 'ES2016', 'ES2017', 'ES2018', 'ES2019', 'ES2020', or 'ESNEXT'. */
+    "module": "commonjs",                     /* Specify module code generation: 'none', 'commonjs', 'amd', 'system', 'umd', 'es2015', 'es2020', or 'ESNext'. */
+    "lib": ["es2020","DOM"],                             /* Specify library files to be included in the compilation. */
+    "allowJs": false,                       /* Allow javascript files to be compiled. */
+    // "checkJs": true,                       /* Report errors in .js files. */
+    // "jsx": "preserve",                     /* Specify JSX code generation: 'preserve', 'react-native', or 'react'. */
+    "declaration": true,                   /* Generates corresponding '.d.ts' file. */
+    "declarationMap": true,                /* Generates a sourcemap for each corresponding '.d.ts' file. */
+    "sourceMap": true,                     /* Generates corresponding '.map' file. */
+    // "outFile": "./",                       /* Concatenate and emit output to single file. */
+    "outDir": "./bin",                        /* Redirect output structure to the directory. */
+    // "rootDir": "./src",                       /* Specify the root directory of input files. Use to control the output directory structure with --outDir. */
+    // "composite": true,                     /* Enable project compilation */
+    // "tsBuildInfoFile": "./",               /* Specify file to store incremental compilation information */
+    // "removeComments": true,                /* Do not emit comments to output. */
+    // "noEmit": true,                        /* Do not emit outputs. */
+    // "importHelpers": true,                 /* Import emit helpers from 'tslib'. */
+    // "downlevelIteration": true,            /* Provide full support for iterables in 'for-of', spread, and destructuring when targeting 'ES5' or 'ES3'. */
+    // "isolatedModules": true,               /* Transpile each file as a separate module (similar to 'ts.transpileModule'). */
+
+    /* Strict Type-Checking Options */
+    "strict": true,                           /* Enable all strict type-checking options. */
+    // "noImplicitAny": true,                 /* Raise error on expressions and declarations with an implied 'any' type. */
+    // "strictNullChecks": true,              /* Enable strict null checks. */
+    // "strictFunctionTypes": true,           /* Enable strict checking of function types. */
+    // "strictBindCallApply": true,           /* Enable strict 'bind', 'call', and 'apply' methods on functions. */
+    // "strictPropertyInitialization": true,  /* Enable strict checking of property initialization in classes. */
+    // "noImplicitThis": true,                /* Raise error on 'this' expressions with an implied 'any' type. */
+    // "alwaysStrict": true,                  /* Parse in strict mode and emit "use strict" for each source file. */
+
+    /* Additional Checks */
+    // "noUnusedLocals": true,                /* Report errors on unused locals. */
+    // "noUnusedParameters": true,            /* Report errors on unused parameters. */
+    // "noImplicitReturns": true,             /* Report error when not all code paths in function return a value. */
+    // "noFallthroughCasesInSwitch": true,    /* Report errors for fallthrough cases in switch statement. */
+
+    /* Module Resolution Options */
+    // "moduleResolution": "node",            /* Specify module resolution strategy: 'node' (Node.js) or 'classic' (TypeScript pre-1.6). */
+    // "baseUrl": "./",                       /* Base directory to resolve non-absolute module names. */
+    // "paths": {},                           /* A series of entries which re-map imports to lookup locations relative to the 'baseUrl'. */
+    // "rootDirs": [],                        /* List of root folders whose combined content represents the structure of the project at runtime. */
+    // "typeRoots": [],                       /* List of folders to include type definitions from. */
+    // "types": [],                           /* Type declaration files to be included in compilation. */
+    // "allowSyntheticDefaultImports": true,  /* Allow default imports from modules with no default export. This does not affect code emit, just typechecking. */
+    "esModuleInterop": true,                  /* Enables emit interoperability between CommonJS and ES Modules via creation of namespace objects for all imports. Implies 'allowSyntheticDefaultImports'. */
+    // "preserveSymlinks": true,              /* Do not resolve the real path of symlinks. */
+    // "allowUmdGlobalAccess": true,          /* Allow accessing UMD globals from modules. */
+
+    /* Source Map Options */
+    // "sourceRoot": "",                      /* Specify the location where debugger should locate TypeScript files instead of source locations. */
+    // "mapRoot": "",                         /* Specify the location where debugger should locate map files instead of generated locations. */
+    // "inlineSourceMap": true,               /* Emit a single file with source maps instead of having a separate file. */
+    // "inlineSources": true,                 /* Emit the source alongside the sourcemaps within a single file; requires '--inlineSourceMap' or '--sourceMap' to be set. */
+
+    /* Experimental Options */
+    // "experimentalDecorators": true,        /* Enables experimental support for ES7 decorators. */
+    // "emitDecoratorMetadata": true,         /* Enables experimental support for emitting type metadata for decorators. */
+
+    /* Advanced Options */
+    "skipLibCheck": true,                     /* Skip type checking of declaration files. */
+    "forceConsistentCasingInFileNames": true  /* Disallow inconsistently-cased references to the same file. */
+  },
+  "include": [
+    "test/**/*.ts"
+  ],
+  "files": [
+    "src/index.ts"
+  ]
+}

package/src/VolumeLimiter.ts

@@ -1,182 +0,0 @@
-/**
- * Copyright (c) Microsoft Corporation. All rights reserved.
- * Licensed under the Microsoft Live Share SDK License.
- */
-
- import { TimeInterval } from '@microsoft/live-share';
- import { IMediaPlayer } from './IMediaPlayer';
-
-export enum LevelType { fixed, percentage }
-
-export class VolumeLimiter {
-    private readonly _player: IMediaPlayer;
-
-    // Settings
-    private readonly _duration = new TimeInterval(2000);
-    private readonly _rampDownDuration = new TimeInterval(500);
-    private readonly _rampUpDuration = new TimeInterval(500);
-    private _level: number = 0.1
-    private _levelType: LevelType = LevelType.fixed;
-
-    // Running state
-    private _running = false;
-    private _endTime = 0;
-    private _startTime = 0;
-    private _startVolume = 0;
-    private _inRamp = false;
-
-    constructor(player: IMediaPlayer) {
-        this._player = player;
-    }
-
-    /**
-     * Time, in seconds, that the volume should be lowered.
-     * 
-     * @remarks
-     * Applications should periodically call `lowerVolume()` to keep the volume lowered. 
-     */
-    public get duration(): number {
-        return this._duration.seconds;
-    }
-
-    public set duration(value: number) {
-        this._duration.seconds = Math.abs(value);
-    }
-
-    /**
-     * Target level to lower volume to.
-     * 
-     * @remarks
-     * Expressed as a value between 0.0 and 1.0. The value is applied based upon the configured
-     * `levelType`. The default value is 0.2.
-     * 
-     * For a level type of `LevelType.fixed` the value is the exact level the volume will be 
-     * lowered to. The default value of 0.2 would cause the volume to be lowered to 0.2.
-     * 
-     * For a level type of `LevelType.percentage` the value is the percentage by which the volume
-     * level should be lowered to. The default value of 0.2 would cause the volume to be lowered
-     * to 20% of its starting value.
-     */
-    public get level(): number {
-        return this._level;
-    }
-
-    public set level(value: number) {
-        if (value < 0 || value > 1.0) {
-            throw new Error(`VolumeLimiter: cannot set level to ${value}. Level must be between 0.0 and 1.0.`);
-        }
-
-        this._level = value;
-    }
-
-    /**
-     * The type of level represented by the `level` property.
-     */
-    public get levelType(): LevelType {
-        return this._levelType;
-    }
-
-    public set levelType(value: LevelType) {
-        this._levelType = value;
-    }
-
-    /**
-     * Amount of time, in seconds, it should take to ramp the volume down to the desired level.
-     */
-    public get rampDownDuration(): number {
-        return this._rampDownDuration.seconds;
-    }
-
-    public set rampDownDuration(value: number) {
-        this._rampDownDuration.seconds = Math.abs(value);
-    }
-
-    /**
-     * Amount of time, in seconds, it should take to ramp the volume back up to the original level.
-     */
-     public get rampUpDuration(): number {
-        return this._rampUpDuration.seconds;
-    }
-
-    public set rampUpDuration(value: number) {
-        this._rampUpDuration.seconds = Math.abs(value);
-    }
-
-    /**
-     * Temporarily lowers an audio sources volume.
-     */
-    public lowerVolume(): void {
-        this._endTime = new Date().getTime() + this._duration.milliseconds;
-        if (!this._running) {
-            this.startLimiter();
-        }
-    }
-
-    private startLimiter(): void {
-        const adjustVolume = () => {
-            const now = new Date().getTime();
-            if (now < this._endTime) {
-                // Make no adjustment if muted
-                if (!this._player.muted) {
-                    // Compute adjusted volume level
-                    let volume: number;
-                    const targetVolume = this.computeTargetVolume();
-                    const rampRange = this._startVolume - targetVolume;
-                    const rampUpStart = this._endTime - this._rampUpDuration.milliseconds;
-                    const rampDownEnd = this._startTime + this._rampDownDuration.milliseconds;
-                    if (now > rampUpStart) {
-                        // We're about to end so ramping up
-                        const progress = (now - rampUpStart) / this._rampUpDuration.milliseconds;
-                        volume = targetVolume + (rampRange * progress);
-                        this._player.volume = volume;
-                        this._inRamp = true;
-                    } else if (now < rampDownEnd) {
-                        // We just begun so ramping down
-                        const remaining = (rampDownEnd - now) / this._rampUpDuration.milliseconds;
-                        volume = targetVolume + (rampRange * remaining);
-                        this._player.volume = volume;
-                        this._inRamp = true;
-                    } else if (this._inRamp) {
-                        // We're at the end of a ramp
-                        volume = targetVolume;
-                        this._player.volume = volume;
-                        this._inRamp = false;
-                    }
-                }
-
-                // Schedule next animation frame
-                this.scheduleAnimationFrame(adjustVolume);
-            } else {
-                // Reset volume to original level
-                this._player.volume = this._startVolume;
-                this._running = false;
-                this._endTime = 0;
-                this._startTime = 0;
-                this._startVolume = 0;
-            }
-        };
-
-        this._running = true;
-        this._startTime = new Date().getTime();
-        this._startVolume = this._player.volume;
-        this.scheduleAnimationFrame(adjustVolume)
-    }
-
-    private scheduleAnimationFrame(callback: FrameRequestCallback): void {
-        if (requestAnimationFrame) {
-            requestAnimationFrame(callback);
-        } else {
-            setTimeout(callback, 20);
-        }
-    }
-
-    private computeTargetVolume(): number {
-        switch (this._levelType) {
-            case LevelType.percentage:
-                return this._startVolume * this._level;
-            case LevelType.fixed:
-            default:
-                return this._level;
-        }
-    }
-}