TopLevelVoiceConfig

TopLevelVoiceConfig = { accent?: string; modelType?: "expressive"; name: VoiceKey | CustomVoiceRef; pacing?: string; style: string; } | { accent?: never; modelType?: Exclude<ModelType, "expressive">; name: VoiceKey | CustomVoiceRef; pacing?: number; style?: never; }

Defined in: cue.ts:217

Top-level voice configuration shared across all languages. seed is not allowed here — use per-language voice overrides instead.

Use style for expressive synthesis, or modelType for an explicit model choice. style and modelType are mutually exclusive. Expressive synthesis and style prompts require the Business tier.

Union Members

Type Literal

{ accent?: string; modelType?: "expressive"; name: VoiceKey | CustomVoiceRef; pacing?: string; style: string; }

accent?

optional accent?: string

Accent description for expressive synthesis. The more specific, the better — e.g. 'Southern American English' or 'Received Pronunciation British'. Omitted from the prompt when not set — the voice uses its natural default.

modelType?

optional modelType?: "expressive"

Can be omitted when style is set — expressive is implied. Business tier only.

name

name: VoiceKey | CustomVoiceRef

pacing?

optional pacing?: string

Pacing description for expressive synthesis. Describes the overall speed and tempo — e.g. 'Measured and deliberate' or 'Brisk and energetic'.

style

style: string

Speaking style prompt for expressive synthesis. Business tier only. Implies expressive model type.

---

Type Literal

{ accent?: never; modelType?: Exclude<ModelType, "expressive">; name: VoiceKey | CustomVoiceRef; pacing?: number; style?: never; }

accent?

optional accent?: never

modelType?

optional modelType?: Exclude<ModelType, "expressive">

TTS model type — modelTypes.expressive or modelTypes.consistent. Defaults to consistent.

name

name: VoiceKey | CustomVoiceRef

pacing?

optional pacing?: number

Speaking rate for consistent synthesis. Valid range: 0.25 to 2.

style?

optional style?: never