ssmlverifier's Introduction

SSMLVerifier

SSMLVerifier will verify that a given input is valid SSML. It is based of a javascript implementation found here: https://github.com/gsdriver/ssml-check

WIP

This is a WIP project. Here is the current state of the implementation:

Amazon tags:

amazon:domain
amazon:effect
amazon:emotion
lang
phoneme
voice
w

Google tags:

par
seq
media
desc

Basic usage

The basic usage looks like this:

const string testSsml = "<speak>Hello <break strength='weak' time='1s'/> World!</speak>";
var verifier = new Verifer();
var errors = verifier.Verify(testSsml);
if(errors.Count() == 0)
{
   Console.WriteLine("SSML is valid!");
}
else
{
   foreach(var error in errors)
   {
      Console.WriteLine(error.Error);
   }
}

But I'd recommend you to use the second parameter aswell, which sets the target platform.

verifier.Verify(testSsml, SsmlPlatform.Amazon);
// or ...
verifier.Verify(testSsml, SsmlPlatform.Google);

This way you are able to use platform specific tags like Amazon's lang-tag

// lang is an amazon-specific tag
const string testSsml = "<speak>Hello <lang xml:lang='de-DE'>Welt</lang></speak>";
var verifier = new Verifer();
// this will fail, because lang is a Amazon-specific tag
var result = verifier.Verify(testSsml, SsmlPlatform.Google);

ssmlverifier's People

Contributors

Stargazers

Watchers

ssmlverifier's Issues

media implementation

Verifier.GetValidTags should be the responsibilty of each tag-strategy

Remove the Verifier.GetValidTags method and make it a responsibility of each tag-strategy.

desc implementation

prosody implementation

say-as format validation

Bit complex, differs depending on the interpret-as value.

time-attribute needs to be validated

A validator for the time-attribute needs to be right.

See the occurances:
todo:
break -> time
audio -> clipBegin
audio -> clipEnd
audio -> repeatDur
done:
media -> repeatdur
media -> fadeInDur
media -> fadeOutDur