ssml-document
Advanced tools
Readme
Follow the W3C SSML (Speech Synthesis Markup Language) specification to build SSML documents that meet the requirements of all major voice service providers.
遵循 W3C SSML（语音合成标记语言）规范，构建符合大部分语音/数字人服务提供商要求的 SSML 文档。
Currently supports the generation of SSML documents for these service providers: Microsoft Azure / Aliyun / Tencent Cloud / Google Cloud / Amazon AWS / GuijiAI / Tencent YunXiaoWei / XMOV / Microsoft XiaoBing / Sensetime / Eta ...
当前支持生成这些服务商的SSML文档： 微软云 / 阿里云 / 腾讯云 / 谷歌云 / 亚马逊云 / 火山云 / 硅基智能 / 腾讯云小微 / XMOV魔珐科技 / 微软小冰 / 商汤科技 / 艾塔 ...
Every month we check the development documents of these service providers to ensure that the library is not out of date.
每月我们会检查这些服务商的开发文档，以确保本库不会过时。
npm i ssml-document --save
Build microsoft-azure SSML:
构建微软云语音SSML：
const { Document, ServiceProvider } = require("ssml-document");
const doc = new Document();
const ssml = doc
.voice("zh-CN-XiaoxiaoNeural")
.prosody({ rate: 1.2, pitch: 1.1 })
.say("Hello World")
.pause(500)
.say("GO GO GO")
.sayAs("123456", { interpretAs: "digits" })
.up()
.up()
.render({
pretty: true, //format SSML
provider: ServiceProvider.Microsoft
});
console.log(ssml);
/*
<?xml version="1.0"?>
<speak version="1.0" xmlns="http://www.w3.org/2001/10/synthesis" xmlns:mstts="https://www.w3.org/2001/mstts">
<voice name="zh-CN-XiaoxiaoNeural">
<prosody pitch="110%" rate="120%">
Hello World
<break time="500ms"/>
GO GO GO
<say-as interpret-as="digits">123456</say-as>
</prosody>
</voice>
</speak>
*/
Build aliyun SSML:
构建阿里云语音SSML：
const { Document, ServiceProvider } = require("ssml-document");
const doc = new Document();
const ssml = doc
.voice("aixia")
.prosody({ rate: 1.2, pitch: 1.1 })
.say("我的身高")
.phoneme("长", {
alphabet: "py",
ph: "zhǎng" //or zhang3
})
.say("高了")
.s("欢迎来到")
.sub("W3C", "万维网")
.up()
.up()
.up()
.render({ pretty: true, provider: ServiceProvider.Aliyun });
console.log(ssml);
/*
<speak voice="aixia" rate="100" pitch="50">
我的身高
<phoneme alphabet="py" ph="zhang3">长</phoneme>
高了
<s>
欢迎来到
<sub alias="万维网">W3C</sub>
</s>
</speak>
*/
Build aggregated SSML for storage or transport:
构建用于存储或传输的聚合SSML：
const { Document } = require("ssml-document");
const doc = new Document();
const ssml = doc
.voice("aixia")
.say("Hello World")
.break(2000)
.say("Bye")
.up()
.render({ pretty: true }); //no provider
console.log(ssml);
/*
<?xml version="1.0"?>
<speak version="1.0" xmlns="http://www.w3.org/2001/10/synthesis">
<voice name="aixia">
Hello World
<break time="2s"/>
Bye
</voice>
</speak>
*/
Support for marking expected voice service providers in aggregated SSML:
支持在聚合SSML中标记期望的语音服务商：
const { Document } = require("ssml-document");
//Frontend code:
//前端代码：
const doc = new Document({ provider: ServiceProvider.Aliyun });
const ssml = doc
.voice("aida")
.say("Hello World")
.up()
.render({ pretty: true }); //no provider
console.log(ssml);
/*
<?xml version="1.0"?>
<speak provider="aliyun" version="1.0" xmlns="http://www.w3.org/2001/10/synthesis">
<voice name="aida">Hello World</voice>
</speak>
*/
//Backend code:
//后端代码：
const doc2 = Document.parse(ssml);
console.log(doc2.provider); //aliyun
const ssml2 = doc2.render({ provider: doc2.provider }); //build aliyun SSML
console.log(ssml2);
//<speak voice="aida">Hello World</speak>
Get speech rate, pitch, volume and speaker parameters.
获取语音语速、语调、音量以及发音人参数
const { Document } = require("ssml-document");
const doc = new Document();
doc.voice("aixia")
.prosody({ rate: 1.2, pitch: 1.1 })
.say("Example Text");
console.log(doc.rate, doc.pitch, doc.volume, doc.speaker);
//1.2 1.1 100 aixia
Building SSML based on elements:
基于元素构建SSML：
const { Document, ServiceProvider, elements } = require("ssml-document");
const { Prosody, Paragraph } = elements;
const doc = new Document();
const prosody = new Prosody({ rate: 1.2, pitch: 1.1 });
const p = new Paragraph();
p.appendChild("Hello World");
prosody.appendChild(p);
doc.appendChild(prosody);
const ssml = doc.render({ provider: ServiceProvider.Amazon });
console.log(ssml);
//<speak><prosody pitch="110%" rate="120%"><p>Hello World</p></prosody></speak>
Setting the compile attribute for tags enables JavaScript syntax expression evaluation:
给标签设置compile属性启用JavaScript语法表达式求值:
const { Document } = require("ssml-document");
const aggregationSSML = '<?xml version="1.0"?>\
<speak compile="true" version="1.0" xmlns="http://www.w3.org/2001/10/synthesis">\
<voice name="aixia">\
Master, {{[\"today is a beautiful day\",\"have a good day from now\",\"the weather is not bad today\"][parseInt(Math.random() * 3)]}}.\
<break time="500"/>\
The current time is {{time}}.\
</voice>\
</speak>';
const date = new Date();
const doc = Document.parse(aggregationSSML, {
dataset: {
time: date.getHours() + ":" + date.getMinutes()
}
});
const ssml = doc.render({
provider: doc.provider,
pretty: true
});
console.log(ssml);
/*
<?xml version="1.0"?>
<speak version="1.0" xmlns="http://www.w3.org/2001/10/synthesis">
<voice name="aixia">
Master, have a good day from now.
<break time="500ms"/>
The current time is 22:48.
</voice>
</speak>
*/
Setting for/if/elif/else attributes for tags can also implement loops and conditional divergence. 给标签设置 for/if/elif/else 属性还能够实现循环和条件分歧。
const { Document } = require("ssml-document");
const aggregationSSML = '<?xml version="1.0"?>\
<speak compile="true" version="1.0" xmlns="http://www.w3.org/2001/10/synthesis">\
<voice name="aixia">\
<s if="{{Math.random() > 0.5}}" for="{{s1}}">{{item}}<break time="100"></s>\
<s else="true" for="{{s2}}">{{item}}<break time="100"></s>\
</voice>\
</speak>';
const doc = Document.parse(aggregationSSML, {
dataset: {
s1: ["Oh", "my", "god"],
s2: ["Holy", "crap"]
}
});
const ssml = doc.render({
provider: doc.provider,
pretty: true
});
console.log(ssml);
/*
<?xml version="1.0"?>
<speak version="1.0" xmlns="http://www.w3.org/2001/10/synthesis">
<voice name="aixia">
<s>
Holy
<break time="100ms"/>
</s>
<s>
crap
<break time="100ms"/>
</s>
</voice>
</speak>
*/
Tag: speak
Support: w3c / microsoft / aliyun / tencent / google / amazon
Tag: voice
Support: w3c / microsoft / google
Tag: prosody
Support: w3c / microsoft / google / amazon
Tag: p
Support: w3c / microsoft / aliyun / google / amazon
Tag: s
Support: w3c / microsoft / aliyun / google / amazon
Tag: w
Support: w3c / aliyun / google / amazon
Tag: break
Support: w3c / microsoft / aliyun / tencent / google / amazon / yunXiaoWei
Tag: phoneme
Support: w3c / microsoft / aliyun / tencent / google / amazon / yunXiaoWei
Tag: say-as
Support: w3c / microsoft / aliyun / tencent / google / amazon
Tag: sub
Support: w3c / aliyun / tencent / google / amazon
Tag: audio
Support: w3c / microsoft / aliyun* / google
Tag: background-audio / backgroundAudio / backgroundaudio
Support: microsoft / aliyun*
Tag: express-as
Support: microsoft / aliyun* / amazon*
Tag: emotion
Support: microsoft* / aliyun / amazon*
Tag: effect
Support: aliyun* / amazon
Tag: emphasis
Support: w3c / microsoft / google / amazon
Tag: lang
Support: w3c / microsoft / google
Tag: mark
Support: w3c / google / amazon
Tag: bookmark
Support: microsoft
Tag: seq
Support: microsoft
Tag: par
Support: w3c / google
Tag: seq
Support: w3c / google
Tag: lexicon
Support: w3c / microsoft
Tag: auto-breaths
Support: amazon
Tag: silence
Support: microsoft
FAQs
SSML document building parser for multiple service providers
The npm package ssml-document receives a total of 8 weekly downloads. As such, ssml-document popularity was classified as not popular.
We found that ssml-document demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 2 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
As cyber threats become more autonomous, AI-powered defenses are crucial for businesses to stay ahead of attackers who can exploit software vulnerabilities at scale.
Security News
UnitedHealth Group disclosed that the ransomware attack on Change Healthcare compromised protected health information for millions in the U.S., with estimated costs to the company expected to reach $1 billion.
Security News
GitHub is susceptible to a CDN flaw that allows attackers to host malware on any public repository.