twilio-video 2.22.2 → 2.24.1

package/tsdef/AudioProcessor.d.ts

@@ -0,0 +1,65 @@
+import { NoiseCancellationVendor } from './types';
+
+export interface AudioProcessor {
+  /**
+   * @property {NoiseCancellationVendor} vendor
+   */
+  vendor: NoiseCancellationVendor;
+
+  /**
+   * connects and cleans given stream
+   * @returns {MediaStreamTrack} clean track
+   */
+  connect: (sourceTrack: MediaStreamTrack) => MediaStreamTrack
+
+  /**
+   * checks if AudioProcessor is currently enabled
+   * @returns {boolean} true if audio processor is enabled.
+   */
+  isEnabled: () => boolean;
+
+  /**
+   * checks if AudioProcessor is initialized (not destroyed)
+   * @returns {boolean} true if audio processor is initialized.
+   */
+  isInitialized(): boolean;
+
+  /**
+   * checks if AudioProcessor is connected to a stream
+   * @returns {boolean} true if a stream is connected.
+   */
+  isConnected(): boolean;
+
+  /**
+   * enables noise cancellation.
+   * @returns {void}
+   */
+  enable: () => void;
+
+  /**
+   * disables noise cancellation.
+   * @returns {void}
+   */
+  disable: () => void;
+
+  /**
+   * stops processing previously connected stream
+   * @returns {void}
+   */
+  disconnect: () => void;
+
+  /**
+   * destroys the processor freeing up any resources
+   * @returns {void}
+   */
+  destroy:() => void;
+
+  /**
+   * enables/disables logging
+   * @param {boolean} [enable] - Specify true to enable logging
+   * @returns {void}
+   */
+  setLogging:(enable: boolean) => void;
+}
+
+

package/tsdef/LocalAudioTrack.d.ts

@@ -1,5 +1,6 @@
 import { AudioTrack } from './AudioTrack';
 import { LocalTrackOptions } from './LocalTrackOptions';
+import { NoiseCancellation } from './types';
 import { Track } from './Track';
 
 export class LocalAudioTrack extends AudioTrack {
@@ -7,6 +8,7 @@ export class LocalAudioTrack extends AudioTrack {
 
   id: Track.ID;
   isStopped: boolean;
+  noiseCancellation?: NoiseCancellation;
 
   disable(): this;
   enable(enabled?: boolean): this;

package/tsdef/LocalTrackOptions.d.ts

@@ -4,7 +4,7 @@ export interface LocalTrackOptions {
   /**
    * @deprecated
    */
-    logLevel: LogLevel | LogLevels;
+    logLevel?: LogLevel | LogLevels;
     name?: string;
     workaroundWebKitBug1208516?: boolean
   }

package/tsdef/index.d.ts

@@ -1,4 +1,5 @@
-import { CancelablePromise, ConnectOptions, CreateLocalTrackOptions, CreateLocalTracksOptions, LocalTrack } from './types';
+
+import { CancelablePromise, ConnectOptions, CreateLocalAudioTrackOptions, CreateLocalTrackOptions, CreateLocalTracksOptions, LocalTrack } from './types';
 import { PreflightOptions, PreflightTestReport } from './PreflightTypes';
 import { LocalAudioTrack } from './LocalAudioTrack';
 import { LocalVideoTrack } from './LocalVideoTrack';
@@ -11,7 +12,7 @@ export const isSupported: boolean;
 export const version:string;
 export const Logger: Log.RootLogger;
 export function connect(token: string, options?: ConnectOptions): CancelablePromise<Room>;
-export function createLocalAudioTrack(options?: CreateLocalTrackOptions): Promise<LocalAudioTrack>;
+export function createLocalAudioTrack(options?: CreateLocalTracksOptions|CreateLocalAudioTrackOptions): Promise<LocalAudioTrack>;
 export function createLocalTracks(options?: CreateLocalTracksOptions): Promise<LocalTrack[]>;
 export function createLocalVideoTrack(options?: CreateLocalTrackOptions): Promise<LocalVideoTrack>;
 export function runPreflight(token: string, options?: PreflightOptions): PreflightTest;
@@ -55,6 +56,7 @@ export {
   DataTrack,
   DataTrackPublication,
   EncodingParameters,
+  CreateLocalAudioTrackOptions,
   LocalAudioTrackStats,
   LocalTrack,
   LocalTrackPublishOptions,
@@ -72,6 +74,9 @@ export {
   NetworkQualitySendOrRecvStats,
   NetworkQualityStats,
   NetworkQualityVerbosity,
+  NoiseCancellation,
+  NoiseCancellationOptions,
+  NoiseCancellationVendor,
   OpusCodecSettings,
   RemoteAudioTrackStats,
   RemoteTrack,

package/tsdef/types.d.ts

@@ -166,8 +166,29 @@ export interface CreateLocalTrackOptions extends MediaTrackConstraints {
   workaroundWebKitBug1208516?: boolean;
 }
 
+
+export type NoiseCancellationVendor = 'krisp' | 'rnnoise';
+
+export interface NoiseCancellation {
+  readonly vendor: NoiseCancellationVendor;
+  readonly sourceTrack: MediaStreamTrack;
+  readonly isEnabled: boolean;
+
+  enable: () => Promise<void>;
+  disable: () => Promise<void>;
+}
+
+export interface NoiseCancellationOptions {
+  sdkAssetsPath: string;
+  vendor: NoiseCancellationVendor;
+}
+
+export interface CreateLocalAudioTrackOptions extends CreateLocalTrackOptions {
+  noiseCancellationOptions?: NoiseCancellationOptions;
+}
+
 export interface ConnectOptions {
-  audio?: boolean | CreateLocalTrackOptions;
+  audio?: boolean | CreateLocalTrackOptions| CreateLocalAudioTrackOptions;
   automaticSubscription?: boolean;
   bandwidthProfile?: BandwidthProfileOptions;
   dominantSpeaker?: boolean;
@@ -205,7 +226,7 @@ export interface ConnectOptions {
 }
 
 export interface CreateLocalTracksOptions {
-  audio?: boolean | CreateLocalTrackOptions;
+  audio?: boolean | CreateLocalTrackOptions | CreateLocalAudioTrackOptions;
   /**
    * @deprecated
    */