Declared in STMediaParams_doc.h

Overview

This struct describes the Speech Synthesizer voice parameters. Default value of all parameters are nil. One or multiple of the parameters may not specified. STMediaRunner module will select a voice that best matches the parameters specified. If none are specified, or if the parameters specified do not result in the target voice to be selected then a default one will be selected by the Speeh Synthesizer engine.
For Apple SS, voice to be selected needs to be already loaded on a user’s device. For example, for an iphone, need to navigate through setting menus and download specific voices if not already downloaded and available: Settings–>Accessibility–>(Spoken Content OR Read & Speak)–>Voices, then select language then voice name to download.

A STSSVoiceParams object is created as follows:

let STSSVoiceParams = STSSVoiceParams()

Tasks

  •   identifier

    The speech synthesizer voice ID. Voice ID applies only to Apple SS. An example of a voice ID:com.apple.ttsbundle.Samantha.

           property
  •   name

    The voice name to be selected by the speech synthesizer. Example for Apple SS: Samantha.
    For Apple SS, to find all voices on an apple mobile device, navigate to Settings–>Accessibility–>(Spoken Content OR Read & Speak)–>Voices and download the desired voice if not already downloaded.

           property
  •   language

    The language the voice can speak. Apple SS supports many languages throught the selection of the voice. Example: “en-us” for american english.

           property
  •   gender

    The gender of the voice to be selected by the speech synthesizer. options are “male” or “female”.

           property
  •   quality

    The quality of the voice. For Apple SS. Options are: “standard”, “enhanced” and “premium”.

           property

Properties

gender

var gender: String?

Discussion

The gender of the voice to be selected by the speech synthesizer. options are “male” or “female”.

Declared In

STMediaParams_doc.h

identifier

var identifier: String?

Discussion

The speech synthesizer voice ID. Voice ID applies only to Apple SS. An example of a voice ID:com.apple.ttsbundle.Samantha.

Declared In

STMediaParams_doc.h

language

var language: String?

Discussion

The language the voice can speak. Apple SS supports many languages throught the selection of the voice. Example: “en-us” for american english.

Declared In

STMediaParams_doc.h

name

var name: String?

Discussion

The voice name to be selected by the speech synthesizer. Example for Apple SS: Samantha.
For Apple SS, to find all voices on an apple mobile device, navigate to Settings–>Accessibility–>(Spoken Content OR Read & Speak)–>Voices and download the desired voice if not already downloaded.

Declared In

STMediaParams_doc.h

quality

var quality: String?

Discussion

The quality of the voice. For Apple SS. Options are: “standard”, “enhanced” and “premium”.

Declared In

STMediaParams_doc.h