opensips-js 0.1.10 → 0.1.12

package/dist/index.d.ts

@@ -69,9 +69,15 @@ declare class AudioModule {
     private metricConfig;
     private activeStreamValue;
     private initialStreamValue;
+    private noiseReduction;
+    private vadSessions;
+    private vadSessionsState;
+    private vadIntervals;
+    private vadMrsIntervals;
     private VUMeter;
     managedAudioContext: ManagedAudioContext;
     constructor(context: OpenSIPSJS);
+    private processVADConfiguration;
     get sipOptions(): {
         mediaConstraints: {
             video: boolean;
@@ -81,6 +87,12 @@ declare class AudioModule {
                 deviceId: {
                     exact: string;
                 };
+                echoCancellation: boolean;
+                echoCancellationType: string;
+                noiseSuppression: boolean;
+                autoGainControl: boolean;
+                sampleRate: number;
+                latency: number;
             };
             video: boolean;
         };
@@ -128,6 +140,12 @@ declare class AudioModule {
             deviceId: {
                 exact: string;
             };
+            echoCancellation: boolean;
+            echoCancellationType: string;
+            noiseSuppression: boolean;
+            autoGainControl: boolean;
+            sampleRate: number;
+            latency: number;
         };
         video: boolean;
     };
@@ -164,6 +182,7 @@ declare class AudioModule {
     private updateCallStatus;
     private removeCallStatus;
     private addRoom;
+    private setupActiveStream;
     private getActiveStream;
     setMicrophone(dId: string): Promise<void>;
     private setActiveStream;
@@ -172,6 +191,13 @@ declare class AudioModule {
     private deleteRoomIfEmpty;
     private checkInitialized;
     private muteReconfigure;
+    /**
+     * Monitors background noise while user is not speaking.
+     * Calls `onNoiseDetected()` or `onNoiseStop()` when mode should switch.
+     */
+    private startNoiseMonitor;
+    private processVAD;
+    private stopSessionVad;
     private roomReconfigure;
     private doConference;
     private processCallerMute;
@@ -333,6 +359,8 @@ declare type changeIsMutedListener = (value: boolean) => void
 
 declare type changeMuteWhenJoinListener = (value: boolean) => void
 
+declare type changeNoiseReductionStateListener = (event: NoiseReductionStateEventType) => void
+
 declare type changeVideoStateListener = (state: boolean) => void
 
 declare type ChangeVolumeEventType = {
@@ -746,6 +774,21 @@ declare interface MSRPSessionExtended extends MSRPSession_2 {
 
 declare type MSRPSessionListener = IncomingMSRPSessionListener | OutgoingMSRPSessionListener;
 
+declare type NoiseReductionMode = 'disabled' | 'enabled' | 'dynamic'
+
+declare interface NoiseReductionOptions {
+    mode: NoiseReductionMode,
+    vadConfig?: Partial<VADOptions>
+    noiseThreshold?: number
+    checkEveryMs?: number
+    noiseCheckInterval?: number
+}
+
+declare type NoiseReductionStateEventType = {
+    sessionId: string
+    enabled: boolean
+}
+
 declare type OnTransportCallback = (parsed: object, message: string) => void
 
 declare interface OpenSIPSEventMap extends UAEventMap {
@@ -776,6 +819,7 @@ declare interface OpenSIPSEventMap extends UAEventMap {
     changeCallTime: changeCallTimeListener
     changeCallMetrics: changeCallMetricsListener
     changeCallVolume: changeCallVolumeListener
+    changeNoiseReductionState: changeNoiseReductionStateListener
     newMSRPMessage: MSRPMessageListener
     newMSRPSession: MSRPSessionListener
     // JANUS
@@ -932,6 +976,7 @@ declare interface TriggerListenerOptions {
 declare type UAConfigurationExtended = UAConfiguration & {
     reconnectionAttemptsLimit?: number
     overrideUserAgent?: (userAgent: string) => string
+    noiseReductionOptions?: NoiseReductionOptions
     onTransportCallback?: OnTransportCallback
 }
 
@@ -1022,6 +1067,14 @@ declare interface UAExtendedInterface_2 extends UA {
 
 declare type updateRoomListener = (value: RoomChangeEmitType) => void
 
+declare interface VADOptions {
+    model: 'v5' | 'legacy'
+    positiveSpeechThreshold: number
+    negativeSpeechThreshold: number
+    minSpeechFrames: number
+    preSpeechPadFrames: number
+}
+
 declare interface VideoConferenceJoinOptions {
     eventHandlers: Array<unknown>;
     extraHeaders: Array<string>;