tts-narrator
Advanced tools
Generate narration with Text-To-Speech technology
This may be neededo on MacOS for avoiding illegal hardware instruction issue: npm install speaker --mpg123-backend=openal
USAGE
$ tts-narrator [FILE]
ARGUMENTS
FILE path to the script file (.yml)
OPTIONS
-d, --debug output debug information
-h, --help show CLI help
-i, --interactive wait for key press before start
playing next paragraph
-k, --subscription-key=subscription-key Azure Speech service subscription
key
-o, --overwrite always overwrite previously
generated audio files
-p, --[no-]play play generated audio
-r, --region=region region of the text-to-speech
service
-s, --service=azure text-to-speech service to use
-v, --version show CLI version
--chapters=chapters list of chapters to process,
examples: "1-10,13,15", "4-"
--dry-run don't try to generate or play
audio
--sections=sections list of sections to process,
examples: "1-10,13,15", "5-"
--ssml display generated SSML
--subscription-key-env=subscription-key-env Name of the environment variable
that holds the subscription key
EXAMPLE
tts-narrator myscript.yml --play --interactive --service azure
--subscription-key-env SUBSCRIPTION_KEY --region australiaeast
tts-narrator
▸ getAudioFileDuration(filePath): Promise<number>
| Name | Type |
|---|---|
filePath | string |
Promise<number>
▸ loadScript(scriptFilePath): Promise<NarrationScript>
| Name | Type |
|---|---|
scriptFilePath | string |
Promise<NarrationScript>
▸ playMp3File(filePath): Promise<void>
| Name | Type |
|---|---|
filePath | string |
Promise<void>
▸ saveScript(script): Promise<void>
| Name | Type |
|---|---|
script | NarrationScript |
Promise<void>
▸ saveScript(script, scriptFilePath): Promise<void>
| Name | Type |
|---|---|
script | Script |
scriptFilePath | string |
Promise<void>
tts-narrator / AzureTtsService
↳ AzureTtsService
• new AzureTtsService()
▸ Protected buildSpeakStartTag(voiceSettings): string
| Name | Type |
|---|---|
voiceSettings | VoiceSettings |
string
BaseTtsService.buildSpeakStartTag
▸ generateAudio(ssml, options): Promise<any>
| Name | Type |
|---|---|
ssml | string |
options | AzureAudioGenerationOptions |
Promise<any>
▸ generateSSML(paragraph): Promise<string>
| Name | Type |
|---|---|
paragraph | NarrationParagraph |
Promise<string>
▸ Protected generateSsmlWithoutValidation(paragraph): Object
| Name | Type |
|---|---|
paragraph | NarrationParagraph |
Object
| Name | Type |
|---|---|
lineOffset | number |
ssml | string |
BaseTtsService.generateSsmlWithoutValidation
▸ Protected validateXML(xml, lineOffset): void
| Name | Type |
|---|---|
xml | string |
lineOffset | number |
void
tts-narrator / BaseTtsService
BaseTtsService
• new BaseTtsService()
▸ Protected buildSpeakStartTag(voiceSettings): string
| Name | Type |
|---|---|
voiceSettings | VoiceSettings |
string
▸ generateAudio(_ssml, _options): Promise<void>
| Name | Type |
|---|---|
_ssml | string |
_options | AudioGenerationOptions |
Promise<void>
▸ generateSSML(paragraph): Promise<string>
| Name | Type |
|---|---|
paragraph | NarrationParagraph |
Promise<string>
▸ Protected generateSsmlWithoutValidation(paragraph): Object
| Name | Type |
|---|---|
paragraph | NarrationParagraph |
Object
| Name | Type |
|---|---|
lineOffset | number |
ssml | string |
▸ Protected validateXML(xml, lineOffset): void
| Name | Type |
|---|---|
xml | string |
lineOffset | number |
void
tts-narrator / NarrationChapter
• new NarrationChapter(chapter, index, script)
| Name | Type |
|---|---|
chapter | Chapter |
index | number |
script | NarrationScript |
• Protected chapter: Chapter
• index: number
• script: NarrationScript
• sections: NarrationSection[]
• get key(): string
string
▸ getSectionByKey(key): undefined | NarrationSection
| Name | Type |
|---|---|
key | string |
undefined | NarrationSection
tts-narrator / NarrationParagraph
• new NarrationParagraph(paragraph, index, section, chapter, script)
| Name | Type |
|---|---|
paragraph | Paragraph |
index | number |
section | NarrationSection |
chapter | NarrationChapter |
script | NarrationScript |
• chapter: NarrationChapter
• index: number
• Protected paragraph: Paragraph
• script: NarrationScript
• section: NarrationSection
• get key(): string
string
• get settings(): VoiceSettings
• get text(): string
string
tts-narrator / NarrationScript
• new NarrationScript(script, scriptFilePath)
| Name | Type |
|---|---|
script | Script |
scriptFilePath | string |
• chapters: NarrationChapter[]
• Protected script: Script
• scriptFilePath: string
• get settings(): ScriptSettings
▸ export(): Script
▸ getChapterByKey(key): undefined | NarrationChapter
| Name | Type |
|---|---|
key | string |
undefined | NarrationChapter
tts-narrator / NarrationSection
• new NarrationSection(section, index, chapter, script)
| Name | Type |
|---|---|
section | Section |
index | number |
chapter | NarrationChapter |
script | NarrationScript |
• chapter: NarrationChapter
• index: number
• paragraphs: NarrationParagraph[]
• script: NarrationScript
• Protected section: Section
• get key(): string
string
tts-narrator / AudioGenerationOptions
AudioGenerationOptions
• outputFilePath: string
tts-narrator / AzureAudioGenerationOptions
↳ AzureAudioGenerationOptions
• outputFilePath: string
AudioGenerationOptions.outputFilePath
• Optional serviceRegion: string
• Optional subscriptionKey: string
tts-narrator / NarrationScriptFile / Chapter
NarrationScriptFile.Chapter
• Optional key: string
• sections: Section[]
tts-narrator / NarrationScriptFile / Paragraph
NarrationScriptFile.Paragraph
• Optional key: string
• Optional settings: VoiceSettings
• text: string
tts-narrator / NarrationScriptFile / Script
NarrationScriptFile.Script
• chapters: Chapter[]
• settings: ScriptSettings
tts-narrator / NarrationScriptFile / Section
NarrationScriptFile.Section
• Optional key: string
• paragraphs: Paragraph[]
tts-narrator / ScriptSettings
• Optional voice: VoiceSettings
tts-narrator / TtsService
▸ generateAudio(ssml, options): Promise<void>
| Name | Type |
|---|---|
ssml | string |
options | AudioGenerationOptions |
Promise<void>
▸ generateSSML(paragraph): Promise<string>
| Name | Type |
|---|---|
paragraph | NarrationParagraph |
Promise<string>
tts-narrator / VoiceSettings
• Optional language: string
• Optional name: string
tts-narrator / NarrationScriptFile
FAQs
Generate narration with Text-To-Speech technology
The npm package tts-narrator receives a total of 47 weekly downloads. As such, tts-narrator popularity was classified as not popular.
We found that tts-narrator demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 0 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
NIST's new password guidelines remove periodic changes and special character requirements, focusing on longer, more secure passwords for better authentication practices.
Security News
A record 2,709 developers participated in the 2024 Ruby on Rails Community Survey, revealing key tools, practices, and trends shaping the Rails ecosystem.
Security News
In 2023, data breaches surged 78% from zero-day and supply chain attacks, but developers are still buried under alerts that are unable to prevent these threats.