PlayHTVoice

interface PlayHTVoice : PlayHTVoiceProperties(source)

Properties

Link copied to clipboard
abstract var customVoiceId: String

This enables specifying a voice that doesn't already exist as an PlayHTVoiceIdType enum.

Link copied to clipboard

An emotion to be applied to the speech.

Link copied to clipboard
abstract var fillerInjectionEnabled: Boolean?

This determines whether fillers are injected into the model output before inputting it into the voice provider.
Default `false` because you can achieve better results with prompting the model.

Link copied to clipboard
abstract var speed: Double

This is the speed multiplier that will be used.

Link copied to clipboard
abstract var styleGuidance: Double

A number between 1 and 30. Use lower numbers to to reduce how strong your chosen emotion will be. Higher numbers will create a very emotional performance.

Link copied to clipboard
abstract var temperature: Double

A floating point number between 0, exclusive, and 2, inclusive. If equal to null or not provided, the model's default temperature will be used. The temperature parameter controls variance. Lower temperatures result in more predictable results, higher temperatures allow each run to vary more, so the voice may sound less like the baseline voice.

Link copied to clipboard
abstract var textGuidance: Double

A number between 1 and 2. This number influences how closely the generated speech adheres to the input text. Use lower values to create more fluid speech, but with a higher chance of deviating from the input text. Higher numbers will make the generated speech more accurate to the input text, ensuring that the words spoken align closely with the provided text.

Link copied to clipboard
abstract var voiceGuidance: Double

A number between 1 and 6. Use lower numbers to reduce how unique your chosen voice will be compared to other voices.

Link copied to clipboard

This is the provider-specific ID that will be used.

Functions

Link copied to clipboard
abstract fun chunkPlan(block: ChunkPlan.() -> Unit)

This is the chunk plan for controlling how the model output is split into chunks before being sent to the voice provider for generation.