Skip to main content

VoiceProfile

ug-js-sdk


ug-js-sdk / VoiceProfile

Interface: VoiceProfile

Defined in: types/index.ts:102

Voice profile parameters for TTS providers (ElevenLabs and Deepdub).

Properties

provider?

optional provider: "elevenlabs" | "deepdub"

Defined in: types/index.ts:104

TTS provider to use. Defaults to "elevenlabs" if not specified.


voice_id?

optional voice_id: string

Defined in: types/index.ts:107

The voice ID to use for synthesis, or undefined for default


speed?

optional speed: number

Defined in: types/index.ts:111

Speaking speed, range: 0.7 - 1.2 (undefined for default)


stability?

optional stability: number

Defined in: types/index.ts:113

Stability, range: 0.0 - 1.0 (undefined for default)


similarity_boost?

optional similarity_boost: number

Defined in: types/index.ts:115

Similarity boost, range: 0.0 - 1.0 (undefined for default)


deepdub_model?

optional deepdub_model: "dd-etts-1.1" | "dd-etts-2.5"

Defined in: types/index.ts:119

Deepdub model to use: "dd-etts-1.1" or "dd-etts-2.5"


deepdub_tempo?

optional deepdub_tempo: number

Defined in: types/index.ts:121

Deepdub tempo/speed, range: 0.0 - 2.0


deepdub_variance?

optional deepdub_variance: number

Defined in: types/index.ts:123

Deepdub variance/expressiveness, range: 0.0 - 1.0


deepdub_locale?

optional deepdub_locale: string

Defined in: types/index.ts:125

Deepdub output locale (e.g., "en-US", "es-ES") - can differ from voice's native locale


deepdub_accent_base_locale?

optional deepdub_accent_base_locale: string

Defined in: types/index.ts:129

Base accent locale for accent blending


deepdub_accent_locale?

optional deepdub_accent_locale: string

Defined in: types/index.ts:131

Target accent locale for accent blending


deepdub_accent_ratio?

optional deepdub_accent_ratio: number

Defined in: types/index.ts:133

Accent blend ratio, range: 0.0 - 1.0


deepdub_clean_audio?

optional deepdub_clean_audio: boolean

Defined in: types/index.ts:137

Enable Deepdub audio post-processing