STSSEngineState

Represents the lifecycle state of a speech-synthesis engine.

Overview

This value reports the state of the speech-synthesis engine. It describes engine readiness or lifecycle, not the completion of an individual spoken prompt.

public enum STSSEngineState: String, Sendable {
    case notValid
    case idle
    case starting
    case active
    case stopping
}

Use STMediaRunner.getSSEngineState(_:) to query an engine. When the audio player is not initialized, getSSEngineState(_:) returns .notValid.

Cases

• .notValid — Not valid option.
• .idle — Idle option.
• .starting — Starting option.
• .active — Active option.
• .stopping — Stopping option.

Swift example

let selection: STSSEngineState = .notValid

Where this type is used

• STMediaRunner.getSSEngineState

See Also

• STSSVoiceParams
• STMediaEventType