Declared in STMediaParams_doc.h

Overview

This struct describes the parameters for audio recording .

A STAudioRecordParams object can be created as follows:

let stAudioRecordParams = STAudioRecordParams()

Tasks

  •   saveAudioParams

    The interface containing the save audio parameters.

           property
  •   recordPlayPromptParams

    The interface containing the params that control audio playback which may be executing during audio recording.

           property
  •   notificationMs

    The bookmark timestamp in milliseconds when client will be notified when audio recording at that timestamp is reached. Default: 0 reflects no bookmark is set.

           property
  •   audioRecordControlParams

    The interface containing the parameters which control and stop audio recording as defined in STAudioRecordControlParams. Default: nil.

           property
  •   vadParams

    The interface containing the parameters which control the voice activity detector per audio recording requirements. Default: nil.

           property

Properties

audioRecordControlParams

var audioRecordControlParams: STAudioRecordControlParams?

Discussion

The interface containing the parameters which control and stop audio recording as defined in STAudioRecordControlParams. Default: nil.

Declared In

STMediaParams_doc.h

notificationMs

var notificationMs: Int32 = 0

Discussion

The bookmark timestamp in milliseconds when client will be notified when audio recording at that timestamp is reached. Default: 0 reflects no bookmark is set.

Declared In

STMediaParams_doc.h

recordPlayPromptParams

recordPlayPromptParams:STRecordPlayPromptParams = STRecordPlayPromptParams()

Discussion

The interface containing the params that control audio playback which may be executing during audio recording.

Declared In

STMediaParams_doc.h

saveAudioParams

var saveAudioParams:STSaveAudioParams = STSaveAudioParams()

Discussion

The interface containing the save audio parameters.

Declared In

STMediaParams_doc.h

vadParams

var vadParams: STVADParams?

Discussion

The interface containing the parameters which control the voice activity detector per audio recording requirements. Default: nil.

Declared In

STMediaParams_doc.h