Declared in STMediaParams_doc.h

Overview

This struct describes the parameters for voice activity detection.

A STVADParams object can be created as follows:

let stVADParams = STVADParams()

Tasks

  •   enableVAD

    This parameter instructs audio recording to enable or disable vaoice acitivity detection for audio recording. Default: true.

           property
  •   vadSensitivity

    This parameter specifies the voice activity detection sensitivity. valid values are :“verylow”, “low”, “moderate”, and “high : default: "low”.

           property
  •   vadMinSpeechToDetectMs

    This parameter specifies the minimum duration of speech in audio in milliseconds for voice activity detector to transition to speech state. Default: 0, which means only internal parameters for VAD sensitivity will be used.

           property
  •   vadMinSilenceToDetectMs

    This parameter specifies the minimum duration of silence in audio in milliseconds for voice activity detector to transition to silence state. Default: 0, which means only internal parameters for VAD sensitivity will be used.

           property
  •   recordAudioWithNoSpeechActivity

    This parameter instructs audio recording to enable or disable audio recording for audio that does not contain speech energy. Default: true.

           property
  •   preVADAudioFileName

    The file path name URL to record audio before Voice Activity Detector processes the audio. This is an optional parameter to record all audio received in a separate file regardless whether the parameter m_bRecordAudioWithNoSpeechActivity is enabled or not. Default: nil

           property

Properties

enableVAD

var enableVAD: Bool = true

Discussion

This parameter instructs audio recording to enable or disable vaoice acitivity detection for audio recording. Default: true.

Declared In

STMediaParams_doc.h

preVADAudioFileName

var preVADAudioFileName: String?

Discussion

The file path name URL to record audio before Voice Activity Detector processes the audio. This is an optional parameter to record all audio received in a separate file regardless whether the parameter m_bRecordAudioWithNoSpeechActivity is enabled or not. Default: nil

Declared In

STMediaParams_doc.h

recordAudioWithNoSpeechActivity

var recordAudioWithNoSpeechActivity: Bool = true

Discussion

This parameter instructs audio recording to enable or disable audio recording for audio that does not contain speech energy. Default: true.

Declared In

STMediaParams_doc.h

vadMinSilenceToDetectMs

var vadMinSilenceToDetectMs: Int32 = 0

Discussion

This parameter specifies the minimum duration of silence in audio in milliseconds for voice activity detector to transition to silence state. Default: 0, which means only internal parameters for VAD sensitivity will be used.

Declared In

STMediaParams_doc.h

vadMinSpeechToDetectMs

var vadMinSpeechToDetectMs: Int32 = 0

Discussion

This parameter specifies the minimum duration of speech in audio in milliseconds for voice activity detector to transition to speech state. Default: 0, which means only internal parameters for VAD sensitivity will be used.

Declared In

STMediaParams_doc.h

vadSensitivity

var vadSensitivity:STVADSensitivity? = .low

Discussion

This parameter specifies the voice activity detection sensitivity. valid values are :“verylow”, “low”, “moderate”, and “high : default: "low”.

Declared In

STMediaParams_doc.h