SpeechTilesAndamento Docs
Get started
Docs›Sdk›Stmediarunner›Types›Stssvoiceparams
SDK Reference · Type

STSSVoiceParams

Describes criteria for identifying or selecting a speech-synthesis voice.

Overview

Describe the criteria used to find or select a speech-synthesis voice. Language, gender, quality, and other supported attributes help narrow candidates, but the actual list depends on the voices installed on the device.

public struct STSSVoiceParams: Sendable {
    public var identifier: String?
    public var name: String?
    public var language: String?
    public var gender: STVoiceGender?
    public var quality: STVoiceQuality?
}

All properties are optional, allowing the same type to represent a fully identified installed voice or a broader voice-selection request.

Selection behavior

selectSSVoice(_:ssEngine:) evaluates supplied criteria in a defined priority order. Exact identifier and name matches take precedence, followed by combinations of gender, language, and quality. This allows exact voice selection when available without requiring applications to hard-code one installed voice for every device.

Properties

  • identifier — Declared as String.
  • name — Declared as String.
  • language — Declared as String.
  • gender — Declared as STVoiceGender.
  • quality — Declared as STVoiceQuality.

Where this type is used

See Also