voices
constvoices:object
Defined in: voices.ts:65
Type Declaration
Section titled “Type Declaration”Adrian
Section titled “Adrian”
readonlyAdrian:"Adrian"='Adrian'
Male — Clear — Direct and structured, ideal for straightforward explanations.
readonlyAria:"Aria"='Aria'
Female — Soft — A calm and soothing voice that reassures users and reduces friction.
readonlyAva:"Ava"='Ava'
Female — Bright — Fresh and optimistic, bringing clarity and positivity.
readonlyClara:"Clara"='Clara'
Female — Bright — Cheerful and energetic, uplifting the user experience.
Daniel
Section titled “Daniel”
readonlyDaniel:"Daniel"='Daniel'
Male — Informative — Clear and educational, focused on delivering useful information.
readonlyElena:"Elena"='Elena'
Female — Smooth — Graceful and composed, maintaining a consistent flow of communication.
elevenlabs
Section titled “elevenlabs”
readonlyelevenlabs: {(ref):`elevenlabs:${string}`; (ref):CustomVoiceRef; } =elevenlabsVoice
Call Signature
Section titled “Call Signature”(
ref):`elevenlabs:${string}`
Named voices available for the narration voice (renderOptions.narration).
Built-in voices share one public catalog across supported languages. Most work everywhere; when a language has a smaller built-in subset, TypeScript narrows the allowed names for that language automatically.
Set a default and override per language with voices:
video.renderOptions({ narration: { voice: { name: voices.Aria } } })ElevenLabs voices are passed by provider voice id, or cloned from a local
audio/video sample, both via voices.elevenlabs(...):
video.renderOptions({ narration: { voice: { name: voices.elevenlabs({ voiceId: 'tMvyQtpCVQ0DkixuYm6J' }) }, voices: { fi: { name: voices.elevenlabs({ path: './my-voice.mp3' }) }, }, },})Parameters
Section titled “Parameters”voiceId
Section titled “voiceId”string
Returns
Section titled “Returns”`elevenlabs:${string}`
Call Signature
Section titled “Call Signature”(
ref):CustomVoiceRef
Named voices available for the narration voice (renderOptions.narration).
Built-in voices share one public catalog across supported languages. Most work everywhere; when a language has a smaller built-in subset, TypeScript narrows the allowed names for that language automatically.
Set a default and override per language with voices:
video.renderOptions({ narration: { voice: { name: voices.Aria } } })ElevenLabs voices are passed by provider voice id, or cloned from a local
audio/video sample, both via voices.elevenlabs(...):
video.renderOptions({ narration: { voice: { name: voices.elevenlabs({ voiceId: 'tMvyQtpCVQ0DkixuYm6J' }) }, voices: { fi: { name: voices.elevenlabs({ path: './my-voice.mp3' }) }, }, },})Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”
readonlyEmma:"Emma"='Emma'
Female — Youthful — Playful and fresh, appealing to a modern and dynamic audience.
readonlyEthan:"Ethan"='Ethan'
Male — Friendly — Warm and approachable, making interactions feel personal and welcoming.
readonlyEvan:"Evan"='Evan'
Male — Easy-going — Casual and relaxed, reducing stress in interactions.
readonlyGrace:"Grace"='Grace'
Female — Gentle — Soft and caring, ideal for sensitive or supportive contexts.
Hassan
Section titled “Hassan”
readonlyHassan:"Hassan"='Hassan'
Male — Knowledgeable — Insightful and reliable, conveying expertise and confidence.
Helena
Section titled “Helena”
readonlyHelena:"Helena"='Helena'
Female — Mature — Experienced and composed, conveying trust and authority.
Isabella
Section titled “Isabella”
readonlyIsabella:"Isabella"='Isabella'
Female — Forward — Proactive and confident, driving users toward action.
Julian
Section titled “Julian”
readonlyJulian:"Julian"='Julian'
Male — Smooth — Polished and fluid, ideal for seamless and premium experiences.
readonlyLayla:"Layla"='Layla'
Female — Warm — Kind and empathetic, building trust and comfort.
readonlyLeo:"Leo"='Leo'
Male — Excitable — High-energy and enthusiastic, great for engagement and motivation.
readonlyLily:"Lily"='Lily'
Female — Breezy — Light and effortless, creating a relaxed and easygoing interaction.
Marcus
Section titled “Marcus”
readonlyMarcus:"Marcus"='Marcus'
Male — Firm — Confident and directive, suited for clear guidance and authority.
readonlyMax:"Max"='Max'
Male — Upbeat — Energetic and lively, keeping interactions engaging and quick.
readonlyMaya:"Maya"='Maya'
Female — Easy-going — Relaxed and flexible, reducing pressure during interactions.
readonlyMiles:"Miles"='Miles'
Male — Firm — Grounded and assertive, ensuring clarity and direction.
readonlyNoah:"Noah"='Noah'
Male — Breathy — Soft and intimate, creating a close and attentive feel.
readonlyNora:"Nora"='Nora'
Female — Firm — Strong and decisive, helping users stay on track.
readonlyOmar:"Omar"='Omar'
Male — Informative — Detailed and explanatory, ideal for complex information delivery.
readonlyRyan:"Ryan"='Ryan'
Male — Lively — Dynamic and spirited, adding energy to user interactions.
readonlySam:"Sam"='Sam'
Male — Casual — Relaxed and informal, perfect for conversational experiences.
Sophie
Section titled “Sophie”
readonlySophie:"Sophie"='Sophie'
Female — Clear — Precise and easy to understand, minimizing confusion.
Thomas
Section titled “Thomas”
readonlyThomas:"Thomas"='Thomas'
Male — Even — Balanced and steady, providing a consistent user experience.
Victor
Section titled “Victor”
readonlyVictor:"Victor"='Victor'
Male — Gravelly — A deep, textured voice that conveys strength and seriousness.
readonlyZoe:"Zoe"='Zoe'
Female — Upbeat — Positive and motivating, encouraging continued interaction.