feat: add API for virtual background (#5)

Co-authored-by: Bryce Tham <btham@cisco.com>
webex · Oct 20, 2023 · 2af7dd1 · 2af7dd1
1 parent ab282ba
commit 2af7dd1
Show file tree

Hide file tree

Showing 2 changed files with 23 additions and 4 deletions.
diff --git a/src/web-capabilities.spec.ts b/src/web-capabilities.spec.ts
@@ -13,38 +13,42 @@ const mockCpuInfo = (cpuInfo: CpuInfo) => {
 
 describe('WebCapabilities', () => {
   it('should get correct capabilities for a machine with unknown CPU information', () => {
-    expect.assertions(3);
+    expect.assertions(4);
 
     mockCpuInfo({});
 
     expect(WebCapabilities.isCapableOfBackgroundNoiseRemoval()).toBe(CapabilityState.UNKNOWN);
+    expect(WebCapabilities.isCapableOfVirtualBackground()).toBe(CapabilityState.UNKNOWN);
     expect(WebCapabilities.isCapableOfReceiving1080pVideo()).toBe(CapabilityState.UNKNOWN);
     expect(WebCapabilities.isCapableOfSending1080pVideo()).toBe(CapabilityState.UNKNOWN);
   });
   it('should get correct capabilities for a 1-core machine', () => {
-    expect.assertions(3);
+    expect.assertions(4);
 
     mockCpuInfo({ numLogicalCores: 1 });
 
     expect(WebCapabilities.isCapableOfBackgroundNoiseRemoval()).toBe(CapabilityState.NOT_CAPABLE);
+    expect(WebCapabilities.isCapableOfVirtualBackground()).toBe(CapabilityState.NOT_CAPABLE);
     expect(WebCapabilities.isCapableOfReceiving1080pVideo()).toBe(CapabilityState.NOT_CAPABLE);
     expect(WebCapabilities.isCapableOfSending1080pVideo()).toBe(CapabilityState.NOT_CAPABLE);
   });
   it('should get correct capabilities for a 2-core machine', () => {
-    expect.assertions(3);
+    expect.assertions(4);
 
     mockCpuInfo({ numLogicalCores: 2 });
 
     expect(WebCapabilities.isCapableOfBackgroundNoiseRemoval()).toBe(CapabilityState.CAPABLE);
+    expect(WebCapabilities.isCapableOfVirtualBackground()).toBe(CapabilityState.CAPABLE);
     expect(WebCapabilities.isCapableOfReceiving1080pVideo()).toBe(CapabilityState.CAPABLE);
     expect(WebCapabilities.isCapableOfSending1080pVideo()).toBe(CapabilityState.NOT_CAPABLE);
   });
   it('should get correct capabilities for a 8-core machine', () => {
-    expect.assertions(3);
+    expect.assertions(4);
 
     mockCpuInfo({ numLogicalCores: 8 });
 
     expect(WebCapabilities.isCapableOfBackgroundNoiseRemoval()).toBe(CapabilityState.CAPABLE);
+    expect(WebCapabilities.isCapableOfVirtualBackground()).toBe(CapabilityState.CAPABLE);
     expect(WebCapabilities.isCapableOfReceiving1080pVideo()).toBe(CapabilityState.CAPABLE);
     expect(WebCapabilities.isCapableOfSending1080pVideo()).toBe(CapabilityState.CAPABLE);
   });

diff --git a/src/web-capabilities.ts b/src/web-capabilities.ts
@@ -33,6 +33,21 @@ export class WebCapabilities {
     return CapabilityState.CAPABLE;
   }
 
+  /**
+   * Checks whether the machine is capable of virtual background.
+   *
+   * @returns A {@link CapabilityState}.
+   */
+  static isCapableOfVirtualBackground(): CapabilityState {
+    if (WebCapabilities.cpuInfo.numLogicalCores === undefined) {
+      return CapabilityState.UNKNOWN;
+    }
+    if (WebCapabilities.cpuInfo.numLogicalCores < 2) {
+      return CapabilityState.NOT_CAPABLE;
+    }
+    return CapabilityState.CAPABLE;
+  }
+
   /**
    * Checks whether the machine is capable of receiving 1080p video.
    *