Class IrisSetup

constructor

• new IrisSetup(options?: IrisOptions): IrisSetup

  Create a new instance of the class and set options.

  Parameters

  • Optionaloptions: IrisOptions

    The setup config object

  Returns IrisSetup

  Example

  const iris = new IrisSetup({
     analyticsReportingInterval: INTERVAL,
     audioWorkletPath: PATH_TO_IRIS_AUDIO_WORKLET,
     key: key,
     license: license,
     team: TEAM_ID,
     company: COMPANY_ID,
     user: USER_ID,
     loggingLevel: 1,
     numStreams: 1,
   });
  Copy

analyticsData

audioCtx

contexts

irisNode

options

processedReceiveStreamElement

receiveNode

receiveStreamElement

parameters

• get parameters(): undefined | { [key: number]: IrisProcessors }[]

  Get the parameters object.

  Returns undefined | { [key: number]: IrisProcessors }[]

cleanup

• cleanup(): void

  Call the cleanup function on the IRIS instance and free up memory.

  Returns void

  Example

  iris.cleanup();
  Copy

connectMediaElement

• connectMediaElement(
      element: HTMLMediaElement | HTMLAudioElement,
      node: IrisNodeValues,
  ): MediaStreamAudioDestinationNode

  Connect a media or audio element to the IRIS node.

  Parameters

  • element: HTMLMediaElement | HTMLAudioElement

    The setup config object.
  • node: IrisNodeValues

    The node leg to connect to.

  Returns MediaStreamAudioDestinationNode

  streamDest - The media stream destiantion node.

  Example

  const audioCtx = new AudioContext();
  const audioElement = document.querySelector<HTMLAudioElement>('audio');
  const processedNode = iris.connectMediaElement(audioElement, 'send');
  processedNode.connect(audioCtx.destination);
  Copy

connectReceiveStream

• connectReceiveStream(stream: MediaStream): MediaStream

  Connect the receive stream (usually microphone) to the processing chain.

  Parameters

  • stream: MediaStream

    A media stream (usually/presumably webrtc endpoint).

  Returns MediaStream

  processedStream - The processed media stream.

  Example

  rtcPeerConnection.ontrack = (e: MediaStreamTrack) => {
      const remoteStream = e.streams[0];
      iris.connectReceiveStream(remoteStream);
  }
  Copy

connectSendStream

• connectSendStream(stream: MediaStream): MediaStream

  Connect the send stream (usually microphone) to the processing chain.

  Parameters

  • stream: MediaStream

    A media stream (usually/presumably microphone).

  Returns MediaStream

  streamDest - The processed media stream.

  Example

  navigator.mediaDevices
     .getUserMedia(constraints)
     .then((stream) => iris.connectStream(audioElement, 'send');
  Copy

crossFade

• crossFade(val: number, node: IrisNodeValues): void

  Cross fade between processed and unprocessed streams.

  Parameters

  • val: number

    mix value between 0 and 1.
  • node: IrisNodeValues

    send or receive?

  Returns void

  Example

  iris.crossFade(0.8, 'send');
  Copy

disconnect

• disconnect(): void

  Disconnect the IRIS node from the Web Audio graph.

  Returns void

  Example

  iris.disconnect();
  Copy

init

• init(audioCtx: AudioContext): Promise<boolean>

  Asynchronous method to initialise the SDK with an Audio Context.

  Parameters

  • audioCtx: AudioContext

    The setup config object

  Returns Promise<boolean>

  Promise boolean

  Example

  await iris.init();
  Copy

setAudioWorkletParameter

• setAudioWorkletParameter(
      contextId: string,
      paramId: string | number,
      value: string | number | boolean,
  ): void

  Set parameter of a processor in the audio worklet.

  Parameters

  • contextId: string

    the unique ID of the created IRIS audio context.
  • paramId: string | number

    the unique ID of the processor parameter.
  • value: string | number | boolean

    the new value

  Returns void

  Example

  iris.setAudioWorkletParameter('123456', 12345, true);
  Copy

setMixLevelMic

• setMixLevelMic(val: number): void

  Set the wet/dry mix for the processed 'send' (microphone) stream.

  Parameters

  • val: number

    mix value between 0 and 1.

  Returns void

  Example

  iris.setMixLevelMic(0.8);
  Copy

setMixLevelSpeaker

• setMixLevelSpeaker(val: number): void

  Set the wet/dry mix for the processed 'receive' (speaker) stream.

  Parameters

  • val: number

    mix value between 0 and 1.

  Returns void

  Example

  iris.setMixLevelSpeaker(0.8);
  Copy

start

• start(): void

  Initialise IRIS for the start of a call/audio playback.

  Returns void

  Example

  iris.start();
  Copy

stop

• stop(): void

  Stop processing. Should be called at hangup or at the end of a call.

  Returns void

  Example

  iris.stop();
  Copy

toggleNoiseAnalytics

• toggleNoiseAnalytics(value: boolean, logInterval?: number): void

  Toggle noise analytics on or off.

  Parameters

  • value: boolean

    on or off.
  • OptionallogInterval: number

    how often should we report new data?

  Returns void

  Example

  iris.crossFade(0.8, 'send');
  Copy