ConfigData. AudioCfg

Stores the audio streaming client-side settings.

Members

_monitoringMode :number

Type:
  • number

_sampleRate :number

Type:
  • number

enableAEC :boolean

Enables audio echo cancellation.

Browsers treat this setting as a preference, and might not honor it.

Type:
  • boolean
Default Value
  • true

enableAGC :boolean

Enables automatic gain control.

Browsers treat this setting as a preference, and might not honor it.

Type:
  • boolean
Default Value
  • true

enableNS :boolean

Enables noise suppression.

Browsers treat this setting as a preference, and might not honor it.

Type:
  • boolean
Default Value
  • true

exposeOutgoingFrames :boolean

Enables exposing to the application the audio frames captured for the outgoing audio stream of the current client, through the SFSAudioEvent.OUTGOING_FRAME event.

This can be useful, for example, to analyze the voice of the current user on the client side.

Captured audio is delivered as 32-bit floating point PCM samples, after the audio signal processing performed by the browser (see enableAEC, enableNS and enableAGC) and before encoding; check the AudioFrame.samples description for the effects of audio processing on the signal.

Type:
  • boolean
Default Value
  • false

monitorInLevel :boolean

Enables measuring level (in dB) of each incoming audio packet.
Type:
  • boolean
Default Value
  • false

monitorOutLevel :boolean

Enables measuring level (in dB) of each outgoing audio packet.
Type:
  • boolean
Default Value
  • false

monitoringMode :number

When audio level monitoring is enabled, sets measuring mode (peak or RMS).
Type:
  • number
Default Value
See
  • monitorInLevel
  • monitorOutLevel

sampleRate :number

Sets the sample rate for audio capture and playback.
Type:
  • number
Default Value