Declared in STMediaParams_doc.h

Overview

This struct describes the parameters for saving recorded audio and utternaces.

A STSaveAudioParams object can be created as follows:

let stSaveAudioParams = STSaveAudioParams()

Tasks

  •   fileType

    The recording audio file type. Options are “wav”, “caf” and “m4a”. Default value: “wav”.

           property
  •   fileBaseName

    This parameter specifies the file base name saving speech recognition audio utterances.

           property
  •   filePath

    This parameter specifies the file path for saving speech recognition audio utterances.

           property
  •   audioFormat

    The audio format of the recorded audio. If not specified, the audio format of the recorded audio is the audio format of the source audio.

           property
  •   requestID

    This parameter specifies a requestor ID that is included in the file base name for saving speech recognition audio utterances.

           property
  •   logTimeStamp

    This parameter specifies whether or not to include a time stamp in the file base name for saving speech recognition audio utterances. Default: false.

           property

Properties

audioFormat

var STAudioFormat: STAudioFormat?

Discussion

The audio format of the recorded audio. If not specified, the audio format of the recorded audio is the audio format of the source audio.

Declared In

STMediaParams_doc.h

fileBaseName

var fileBaseName: String = ""

Discussion

This parameter specifies the file base name saving speech recognition audio utterances.

Declared In

STMediaParams_doc.h

filePath

var filePath: String = ""

Discussion

This parameter specifies the file path for saving speech recognition audio utterances.

Declared In

STMediaParams_doc.h

fileType

var fileType: String = "wav"

Discussion

The recording audio file type. Options are “wav”, “caf” and “m4a”. Default value: “wav”.

Declared In

STMediaParams_doc.h

logTimeStamp

var logTimeStamp: Bool = false

Discussion

This parameter specifies whether or not to include a time stamp in the file base name for saving speech recognition audio utterances. Default: false.

Declared In

STMediaParams_doc.h

requestID

var requestID: String = ""

Discussion

This parameter specifies a requestor ID that is included in the file base name for saving speech recognition audio utterances.

Declared In

STMediaParams_doc.h