Options
All
  • Public
  • Public/Protected
  • All
Menu

Class IrisNoiseCancellation

Class responsible for managing Iris Voice Isolation functionalities.

Hierarchy

  • IrisNoiseCancellation

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

  • Creates an instance of the IrisVoiceIsolation service.

    example
    const irisVoiceIsolationService = new IrisVoiceIsolation('/path/to/audioWorklet.js');

    Parameters

    • audioWorkletPath: string

    Returns IrisNoiseCancellation

Properties

Private Optional audioCode

audioCode?: any

Optional audioElement

audioElement?: HTMLAudioElement

Private Optional call

call?: any

config

config: IrisOptions = ...

credentials

credentials: { key: string; team: string; user: string } = ...

Type declaration

  • key: string
  • team: string
  • user: string

Private inCall

inCall: boolean = false

Private iris

iris: IrisSetup

Private irisLoaded

irisLoaded: boolean = false

Private Optional localStream

localStream?: MediaStream

Private logger

logger: Logger = ...

onCallStatusChanged

onCallStatusChanged: Subject<CXoneVoiceCall>

onConnectionStatusChanged

onConnectionStatusChanged: Subject<CXoneVoiceConnection>

Private Optional remoteStream

remoteStream?: MediaStream

Accessors

micProcessing

  • set micProcessing(value: boolean): void

  • Enables or disables microphone processing for noise cancellation.

    example
    irisNCService.micProcessing = true;

    Parameters

    • value: boolean

    Returns void

mixLevelMic

  • set mixLevelMic(value: number): void

  • Sets the microphone mix level for noise cancellation in the Iris service.

    example
    irisNCService.mixLevelMic = 30;

    Parameters

    • value: number

    Returns void

mixLevelSpeaker

  • set mixLevelSpeaker(value: number): void

  • Sets the speaker mix level for noise cancellation in the Iris service.

    example
    irisNCService.mixLevelSpeaker = 30;

    Parameters

    • value: number

    Returns void

speakerProcessing

  • set speakerProcessing(value: boolean): void

  • Enables or disables speaker processing for noise cancellation.

    example
    irisNCService.speakerProcessing = true;

    Parameters

    • value: boolean

    Returns void

Methods

connect

  • connect(): void

  • Establishes connections for both sending and receiving audio streams using Iris Voice Isolation.

    example
    irisService.connect();

    Returns void

connectLocal

  • connectLocal(): void

  • Establishes a connection to a remote audio stream and processes it for playback.

    example
    connectLocal();

    Returns void

connectRemote

  • connectRemote(): void

  • Establishes a connection to a remote audio stream and processes it for playback.

    example
    connectRemote()

    Returns void

disconnect

  • disconnect(): void

  • Disconnects the Iris Voice Isolation service from the current call.

    example
    disconnect()

    Returns void

init

  • init(): Promise<void>

  • Initializes the Iris Voice Isolation service.

    example
    const irisService = new IrisVoiceIsolation();
    await irisService.init();

    Returns Promise<void>

Generated using TypeDoc