Socket
Socket
Sign inDemoInstall

tts-narrator

Package Overview
Dependencies
Maintainers
1
Versions
27
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

tts-narrator

Generate narration with Text-To-Speech technology


Version published
Weekly downloads
47
increased by95.83%
Maintainers
1
Weekly downloads
 
Created
Source

tts-narrator

Generate narration with Text-To-Speech technology

API

tts-narrator

tts-narrator

Table of contents

Modules

Classes

tts-narrator / azure-tts-service / AzureTtsService

Class: AzureTtsService

azure-tts-service.AzureTtsService

Hierarchy
Table of contents
Constructors
Methods
Constructors
constructor

new AzureTtsService()

Inherited from

BaseTtsService.constructor

Methods
generateAudio

generateAudio(ssml, options): Promise<any>

Parameters
NameType
ssmlstring
optionsAzureAudioGenerationOptions
Returns

Promise<any>

Overrides

BaseTtsService.generateAudio


generateSSML

generateSSML(paragraph): Promise<string>

Parameters
NameType
paragraphNarrationParagraph
Returns

Promise<string>

Inherited from

BaseTtsService.generateSSML


generateSsmlWithoutValidation

Protected generateSsmlWithoutValidation(paragraph): Object

Parameters
NameType
paragraphNarrationParagraph
Returns

Object

NameType
lineOffsetnumber
ssmlstring
Inherited from

BaseTtsService.generateSsmlWithoutValidation


validateXML

Protected validateXML(xml, lineOffset): void

Parameters
NameType
xmlstring
lineOffsetnumber
Returns

void

Inherited from

BaseTtsService.validateXML

tts-narrator / narration-script / NarrationChapter

Class: NarrationChapter

narration-script.NarrationChapter

Implements
Table of contents
Constructors
Properties
Accessors
Methods
Constructors
constructor

new NarrationChapter(chapter, script)

Parameters
NameType
chapterChapter
scriptNarrationScript
Properties
chapter

Protected chapter: Chapter


script

script: NarrationScript


sections

sections: NarrationSection[]

Implementation of

Chapter.sections

Accessors
key

get key(): string

Returns

string

Implementation of

Chapter.key

Methods
getSectionByKey

getSectionByKey(key): undefined | NarrationSection

Parameters
NameType
keystring
Returns

undefined | NarrationSection

tts-narrator / narration-script / NarrationParagraph

Class: NarrationParagraph

narration-script.NarrationParagraph

Implements
Table of contents
Constructors
Properties
Accessors
Constructors
constructor

new NarrationParagraph(paragraph, section, chapter, script)

Parameters
NameType
paragraphParagraph
sectionNarrationSection
chapterNarrationChapter
scriptNarrationScript
Properties
chapter

chapter: NarrationChapter


paragraph

Protected paragraph: Paragraph


script

script: NarrationScript


section

section: NarrationSection

Accessors
settings

get settings(): VoiceSettings

Returns

VoiceSettings

Implementation of

Paragraph.settings


text

get text(): string

Returns

string

Implementation of

Paragraph.text

tts-narrator / narration-script / NarrationScript

Class: NarrationScript

narration-script.NarrationScript

Implements
Table of contents
Constructors
Properties
Accessors
Methods
Constructors
constructor

new NarrationScript(script, scriptFilePath)

Parameters
NameType
scriptScript
scriptFilePathstring
Properties
chapters

chapters: NarrationChapter[]

Implementation of

Script.chapters


script

Protected script: Script


scriptFilePath

scriptFilePath: string

Accessors
settings

get settings(): ScriptSettings

Returns

ScriptSettings

Implementation of

Script.settings

Methods
export

export(): Script

Returns

Script


getChapterByKey

getChapterByKey(key): undefined | NarrationChapter

Parameters
NameType
keystring
Returns

undefined | NarrationChapter

tts-narrator / narration-script / NarrationSection

Class: NarrationSection

narration-script.NarrationSection

Implements
Table of contents
Constructors
Properties
Accessors
Constructors
constructor

new NarrationSection(section, chapter, script)

Parameters
NameType
sectionSection
chapterNarrationChapter
scriptNarrationScript
Properties
chapter

chapter: NarrationChapter


paragraphs

paragraphs: NarrationParagraph[]

Implementation of

Section.paragraphs


script

script: NarrationScript


section

Protected section: Section

Accessors
key

get key(): string

Returns

string

Implementation of

Section.key

tts-narrator / tts-service / BaseTtsService

Class: BaseTtsService

tts-service.BaseTtsService

Hierarchy
Implements
Table of contents
Constructors
Methods
Constructors
constructor

new BaseTtsService()

Methods
generateAudio

generateAudio(_ssml, _options): Promise<void>

Parameters
NameType
_ssmlstring
_optionsAudioGenerationOptions
Returns

Promise<void>

Implementation of

TtsService.generateAudio


generateSSML

generateSSML(paragraph): Promise<string>

Parameters
NameType
paragraphNarrationParagraph
Returns

Promise<string>

Implementation of

TtsService.generateSSML


generateSsmlWithoutValidation

Protected generateSsmlWithoutValidation(paragraph): Object

Parameters
NameType
paragraphNarrationParagraph
Returns

Object

NameType
lineOffsetnumber
ssmlstring

validateXML

Protected validateXML(xml, lineOffset): void

Parameters
NameType
xmlstring
lineOffsetnumber
Returns

void

Interfaces

tts-narrator / azure-tts-service / AzureAudioGenerationOptions

Interface: AzureAudioGenerationOptions

azure-tts-service.AzureAudioGenerationOptions

Hierarchy
Table of contents
Properties
Properties
outputFilePath

outputFilePath: string

Inherited from

AudioGenerationOptions.outputFilePath


serviceRegion

Optional serviceRegion: string


subscriptionKey

Optional subscriptionKey: string

tts-narrator / narration-script / NarrationScriptFile / Chapter

Interface: Chapter

narration-script.NarrationScriptFile.Chapter

Implemented by
Table of contents
Properties
Properties
key

key: string


sections

sections: Section[]

tts-narrator / narration-script / NarrationScriptFile / Paragraph

Interface: Paragraph

narration-script.NarrationScriptFile.Paragraph

Implemented by
Table of contents
Properties
Properties
settings

Optional settings: VoiceSettings


text

text: string

tts-narrator / narration-script / NarrationScriptFile / Script

Interface: Script

narration-script.NarrationScriptFile.Script

Implemented by
Table of contents
Properties
Properties
chapters

chapters: Chapter[]


settings

settings: ScriptSettings

tts-narrator / narration-script / NarrationScriptFile / Section

Interface: Section

narration-script.NarrationScriptFile.Section

Implemented by
Table of contents
Properties
Properties
key

key: string


paragraphs

paragraphs: Paragraph[]

tts-narrator / narration-script / ScriptSettings

Interface: ScriptSettings

narration-script.ScriptSettings

Table of contents
Properties
Properties
voice

Optional voice: VoiceSettings

tts-narrator / narration-script / VoiceSettings

Interface: VoiceSettings

narration-script.VoiceSettings

Table of contents
Properties
Properties
language

Optional language: string


name

Optional name: string

tts-narrator / tts-service / AudioGenerationOptions

Interface: AudioGenerationOptions

tts-service.AudioGenerationOptions

Hierarchy
Table of contents
Properties
Properties
outputFilePath

outputFilePath: string

tts-narrator / tts-service / TtsService

Interface: TtsService

tts-service.TtsService

Implemented by
Table of contents
Methods
Methods
generateAudio

generateAudio(ssml, options): Promise<void>

Parameters
NameType
ssmlstring
optionsAudioGenerationOptions
Returns

Promise<void>


generateSSML

generateSSML(paragraph): Promise<string>

Parameters
NameType
paragraphNarrationParagraph
Returns

Promise<string>

Modules

tts-narrator / audio-utils

Module: audio-utils

Table of contents
Functions
Functions
getAudioFileDuration

getAudioFileDuration(filePath): Promise<number>

Parameters
NameType
filePathstring
Returns

Promise<number>


playMp3File

playMp3File(filePath): Promise<void>

Parameters
NameType
filePathstring
Returns

Promise<void>

tts-narrator / azure-tts-service

Module: azure-tts-service

Table of contents
Classes
Interfaces

tts-narrator / index

Module: index

Table of contents
References
References
NarrationChapter

Re-exports: NarrationChapter


NarrationParagraph

Re-exports: NarrationParagraph


NarrationScript

Re-exports: NarrationScript


NarrationScriptFile

Re-exports: NarrationScriptFile


NarrationSection

Re-exports: NarrationSection


ScriptSettings

Re-exports: ScriptSettings


VoiceSettings

Re-exports: VoiceSettings


loadScript

Re-exports: loadScript


saveScript

Re-exports: saveScript

tts-narrator / narration-script / NarrationScriptFile

Namespace: NarrationScriptFile

narration-script.NarrationScriptFile

Table of contents
Interfaces

tts-narrator / narration-script

Module: narration-script

Table of contents
Namespaces
Classes
Interfaces
Functions
Functions
loadScript

loadScript(scriptFilePath): Promise<NarrationScript>

Parameters
NameType
scriptFilePathstring
Returns

Promise<NarrationScript>


saveScript

saveScript(script): Promise<void>

Parameters
NameType
scriptNarrationScript
Returns

Promise<void>

saveScript(script, scriptFilePath): Promise<void>

Parameters
NameType
scriptScript
scriptFilePathstring
Returns

Promise<void>

tts-narrator / tts-service

Module: tts-service

Table of contents
Classes
Interfaces

Keywords

FAQs

Package last updated on 08 Sep 2021

Did you know?

Socket

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.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc