Declared in STMediaParams_doc.h

Overview

This struct describes the parameters for recording the sythesized audio to a file.

A STSSRecordParams object can be created as follows:

let stSSRecordParams = STSSRecordParams()

Tasks

  •   enable

    Enable recording snynthesized audio to a file. Default value: false.

           property
  •   offlineMode

    Offline mode. If true then synthesized audio is not played to a device. Default value: false.

           property
  •   recordInsertedSilence

    Enables recording inserted silence that is controlled by STSSPlayParams. If true then recorded synthesized audio will contain any silences configured in STSSPlayParams. Default value: false.

           property
  •   fileType

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

           property
  •   baseFileName

    The file base name. “.” followed by file type is appended to file base name. If not specified then “RecordSS_

           property
  •   fileURLPath

    The file URL path location where the file will be saved. File URL path location must be specified.

           property
  •   audioFormat

    The audio format of the recorded synthesized audio. If not specified, the audio format of the recorded audio is the audio format generated by the Speech Synthesis voice.

           property

Properties

audioFormat

var audioFormat: STAudioFormat?

Discussion

The audio format of the recorded synthesized audio. If not specified, the audio format of the recorded audio is the audio format generated by the Speech Synthesis voice.

Declared In

STMediaParams_doc.h

baseFileName

var baseFileName: String = ""

Discussion

The file base name. “.” followed by file type is appended to file base name. If not specified then “RecordSS_

Declared In

STMediaParams_doc.h

enable

var enable: Bool = false

Discussion

Enable recording snynthesized audio to a file. Default value: false.

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

fileURLPath

var fileURLPath: String = ""

Discussion

The file URL path location where the file will be saved. File URL path location must be specified.

Declared In

STMediaParams_doc.h

offlineMode

var offlineMode: Bool = false

Discussion

Offline mode. If true then synthesized audio is not played to a device. Default value: false.

Declared In

STMediaParams_doc.h

recordInsertedSilence

var recordInsertedSilence: Bool = false

Discussion

Enables recording inserted silence that is controlled by STSSPlayParams. If true then recorded synthesized audio will contain any silences configured in STSSPlayParams. Default value: false.

Declared In

STMediaParams_doc.h