feat: limit appliable constraints (#56)

* feat: limit appliable constraints * refactor: pick VideoDeviceConstraints from MediaTrackConstraints --------- Co-authored-by: Bryce Tham <[email protected]>
webex · Jun 30, 2023 · b92e5af · b92e5af
1 parent a792397
commit b92e5af
Show file tree

Hide file tree

Showing 4 changed files with 15 additions and 29 deletions.
diff --git a/cspell.json b/cspell.json
@@ -4,6 +4,7 @@
   "language": "en",
   "words": [
     "Alboe",
+    "appliable",
     "bitauth",
     "bitjson",
     "cimg",
@@ -32,8 +33,8 @@
     "transpiled",
     "typedoc",
     "untracked",
-    "WCME",
     "Wcme",
+    "WCME",
     "webex",
     "webrtc"
   ],

diff --git a/src/device/device-management.ts b/src/device/device-management.ts
@@ -43,14 +43,10 @@ export type AudioDeviceConstraints = Pick<
   | 'suppressLocalAudioPlayback'
 >;
 
-export type VideoDeviceConstraints = {
-  deviceId?: ConstrainDOMString;
-  width?: ConstrainULong;
-  height?: ConstrainULong;
-  aspectRatio?: ConstrainDouble;
-  frameRate?: ConstrainDouble;
-  facingMode?: ConstrainDOMString;
-};
+export type VideoDeviceConstraints = Pick<
+  MediaTrackConstraints,
+  'aspectRatio' | 'deviceId' | 'facingMode' | 'frameRate' | 'height' | 'width'
+>;
 
 /**
  * Creates a camera stream. Please note that the constraint params in second getUserMedia call would NOT take effect when:

diff --git a/src/media/local-audio-stream.ts b/src/media/local-audio-stream.ts
@@ -1,20 +1,10 @@
 import { logger } from '../util/logger';
 import { LocalStream, LocalStreamEventNames } from './local-stream';
 
-// TODO: for applyConstraints, we only support things which can be changed on the
-// track itself.  This would not include 'deviceId', and maybe more of these values.
-// Might need to define one AudioConstraints for use with getUserMedia, and refine
-// it even further for applyConstraints here.
-export type AudioConstraints = Pick<
+// These are the audio constraints that can be applied via applyConstraints.
+export type AppliableAudioConstraints = Pick<
   MediaTrackConstraints,
-  | 'autoGainControl'
-  | 'channelCount'
-  | 'deviceId'
-  | 'echoCancellation'
-  | 'noiseSuppression'
-  | 'sampleRate'
-  | 'sampleSize'
-  | 'suppressLocalAudioPlayback'
+  'autoGainControl' | 'echoCancellation' | 'noiseSuppression' | 'suppressLocalAudioPlayback'
 >;
 
 /**
@@ -27,7 +17,7 @@ export class LocalAudioStream extends LocalStream {
    * @param constraints - The constraints to apply.
    * @returns A promise which resolves when the constraints have been successfully applied.
    */
-  async applyConstraints(constraints?: AudioConstraints): Promise<void> {
+  async applyConstraints(constraints?: AppliableAudioConstraints): Promise<void> {
     logger.log(`Applying constraints to local track:`, constraints);
     return this.inputTrack.applyConstraints(constraints).then(() => {
       this[LocalStreamEventNames.ConstraintsChange].emit();

diff --git a/src/media/local-video-stream.ts b/src/media/local-video-stream.ts
@@ -1,18 +1,17 @@
 import { logger } from '../util/logger';
 import { LocalStream, LocalStreamEventNames } from './local-stream';
 
-// TODO: see note on AudioConstraints in local-audio-stream
-export type VideoConstraints = Partial<
-  Pick<MediaTrackConstraints, 'aspectRatio' | 'facingMode' | 'frameRate' | 'height' | 'width'>
+// These are the video constraints that can be applied via applyConstraints.
+export type AppliableVideoConstraints = Pick<
+  MediaTrackConstraints,
+  'aspectRatio' | 'frameRate' | 'height' | 'width'
 >;
 
 /**
  * See https://developer.mozilla.org/en-US/docs/Web/API/MediaStreamTrack/contentHint.
  */
 export type VideoContentHint = 'motion' | 'detail' | 'text' | '';
 
-// TODO: content hint api/type should move here
-
 /**
  * A video LocalStream.
  */
@@ -23,7 +22,7 @@ export class LocalVideoStream extends LocalStream {
    * @param constraints - The constraints to apply.
    * @returns A promise which resolves when the constraints have been successfully applied.
    */
-  async applyConstraints(constraints?: VideoConstraints): Promise<void> {
+  async applyConstraints(constraints?: AppliableVideoConstraints): Promise<void> {
     logger.log(`Applying constraints to local track:`, constraints);
     return this.inputTrack.applyConstraints(constraints).then(() => {
       this[LocalStreamEventNames.ConstraintsChange].emit();