ssml

package
v0.0.0-...-2ebb6ce Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Sep 18, 2021 License: MIT Imports: 2 Imported by: 0

Documentation

Overview

Package ssml provides functions to simplify working with SSML speech. https://developer.amazon.com/en-US/docs/alexa/custom-skills/speech-synthesis-markup-language-ssml-reference.html#incompatible-tags

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func Break 

func Break(strength BreakStrength, time string) string

Break adds a break to speech. only use `strength` or `time`, not both. time in `ms` or `s` - may not exceed 10s.

func P 

func P(text string) string

P wraps text in a paragraph.

func Phoneme 

func Phoneme(alphabet PhonemeAlphabet, ph, text string) string

Phoneme pronounces the given text based on the provided alphabet and characters. <phoneme alphabet="ipa" ph="pɪˈkɑːn">pecan</phoneme>.

func Prosody 

func Prosody(rate ProsodyRate, pitch ProsodyPitch, volume ProsodyVolume, text string) string

Prosody modifies the volume, pitch, and rate of the tagged speech.

func S 

func S(text string) string

S wraps text in a sentence.

func SayAs 

func SayAs(interpretAs SayAsInterpretAs, format, text string) string

SayAs instructs the voice to "read" the text in a specific way. <say-as interpret-as="cardinal">12345</say-as>.

func Speak 

func Speak(text string) string

Speak wraps text in <speak> tags.

func Sub 

func Sub(alias, text string) string

Sub provides an alias for the voice (e.g. how to pronounce abbreviations) for the text. <sub alias="aluminum">Al</sub> <sub alias="if I remember correctly">IIRC</sub>.

func UseAudio 

func UseAudio(src string) string

UseAudio uses an URL for an MP3 file to play. https://developer.amazon.com/en-US/docs/alexa/custom-skills/speech-synthesis-markup-language-ssml-reference.html#audio <audio src="soundbank://soundlibrary/transportation/amzn_sfx_car_accelerate_01" />.

func UseDomain 

func UseDomain(domain AmazonDomain, text string) string

UseDomain uses a specific domain of speech.

func UseEffect 

func UseEffect(effect AmazonEffect, text string) string

UseEffect wraps text in an effect.

func UseEmotion 

func UseEmotion(name AmazonEmotion, intensity AmazonEmotionIntensity, text string) string

UseEmotion wraps the text in an emotion tag.

func UseEmphasis 

func UseEmphasis(level EmphasisLevel, text string) string

UseEmphasis adds emphasis to the give text.

func UseLang 

func UseLang(language, text string) string

UseLang speaks given text in the specified language.

func UseVoice 

func UseVoice(voice PollyVoice, text string) string

UseVoice wraps text in tags using a specific voice.

func UseVoiceLang 

func UseVoiceLang(voice PollyVoice, language, text string) string

UseVoiceLang wraps text in tags using a specific voice and language.

func W 

func W(role AmazonRole, text string) string

W wraps text for a customized pronunciation. <w role="amazon:VB">read</w> Similar to say-as, this tag customizes the pronunciation of words by specifying the word's part of speech.

Types

type AmazonDomain 

type AmazonDomain string

AmazonDomain is the domain of speech (news, music, ...). https://developer.amazon.com/en-US/docs/alexa/custom-skills/speech-synthesis-markup-language-ssml-reference.html#amazon-domain 

const (
	AmazonDomainConversational AmazonDomain = "conversational" //nolint:revive
	AmazonDomainLong           AmazonDomain = "long-form"
	AmazonDomainMusic          AmazonDomain = "music"
	AmazonDomainNews           AmazonDomain = "news"
	AmazonDomainFun            AmazonDomain = "fun"
)

type AmazonEffect 

type AmazonEffect string

AmazonEffect is a speech effect. 

const (
	// AmazonEffectWhispered lowers the voice to be whispering.
	AmazonEffectWhispered AmazonEffect = "whispered"
)

type AmazonEmotion 

type AmazonEmotion string

AmazonEmotion adds emotion to speech. 

const (
	// EmotionExcited is an exiting voice.
	EmotionExcited AmazonEmotion = "excited"
	// EmotionDisappointed is a disappointed voice.
	EmotionDisappointed AmazonEmotion = "disappointed"
)

type AmazonEmotionIntensity 

type AmazonEmotionIntensity string

AmazonEmotionIntensity is the intensity of the emotion. 

const (
	EmotionIntensityLow    AmazonEmotionIntensity = "low" //nolint:revive
	EmotionIntensityMedium AmazonEmotionIntensity = "medium"
	EmotionIntensityHigh   AmazonEmotionIntensity = "high"
)

type AmazonRole 

type AmazonRole string

AmazonRole is a customized pronunciation of words. 

const (
	// AmazonRoleVB interprets the word as a verb (present simple).
	AmazonRoleVB AmazonRole = "amazon:VB"
	// AmazonRoleVBD interprets the word as a past participle.
	AmazonRoleVBD AmazonRole = "amazon:VBD"
	// AmazonRoleNN interprets the word as a noun.
	AmazonRoleNN AmazonRole = "amazon:NN"
	// AmazonRoleSense1 uses the non-default sense of the word.
	// For example, the noun "bass" is pronounced differently depending on meaning.
	// The "default" meaning is the lowest part of the musical range. The alternate sense
	// (which is still a noun) is a freshwater fish. Specifying
	// <speak><w role="amazon:SENSE_1">bass</w>"</speak> renders the non-default
	// pronunciation (freshwater fish).
	AmazonRoleSense1 AmazonRole = "amazon:SENSE-1"
)

type BreakStrength 

type BreakStrength string

BreakStrength is one way to define the length of a break. 

const (
	BreakStrengthNone  BreakStrength = "none" //nolint:revive
	BreakStrengthXWeak BreakStrength = "x-weak"
	BreakStrengthWeak  BreakStrength = "weak"
	// BreakStrengthMedium is the default.
	BreakStrengthMedium  BreakStrength = "medium"
	BreakStrengthStrong  BreakStrength = "strong"
	BreakStrengthXStrong BreakStrength = "x-strong"
)

type EmphasisLevel 

type EmphasisLevel string

EmphasisLevel is the level of emphasis. 

const (
	// EmphasisLevelStrong is louder and slower.
	EmphasisLevelStrong EmphasisLevel = "strong"
	// EmphasisLevelModerate is the default emphasis if no level is given.
	EmphasisLevelModerate EmphasisLevel = "moderate"
	// EmphasisLevelReduced is softer and faster.
	EmphasisLevelReduced EmphasisLevel = "reduced"
)

type PhonemeAlphabet 

type PhonemeAlphabet string

PhonemeAlphabet is the alphabet to interpret the `ph` parameter with. https://developer.amazon.com/en-US/docs/alexa/custom-skills/speech-synthesis-markup-language-ssml-reference.html#phoneme 

const (
	// PhonemeAlphabetIPA is the International Phonetic Alphabet (IPA).
	PhonemeAlphabetIPA PhonemeAlphabet = "ipa"
	// PhonemeAlphabetXSampa the Extended Speech Assessment Methods Phonetic Alphabet (X-SAMPA).
	PhonemeAlphabetXSampa PhonemeAlphabet = "x-sampa"
)

type PollyVoice 

type PollyVoice string

PollyVoice defines the voice name for speech. 

const (
	// US : Ivy, Joanna, Joey, Justin, Kendra, Kimberly, Matthew, Salli.
	USVoiceIvy      PollyVoice = "Ivy"
	USVoiceJoanna   PollyVoice = "Joanna"
	USVoiceJustin   PollyVoice = "Justin"
	USVoiceKendra   PollyVoice = "Kendra"
	USVoiceKimberly PollyVoice = "Kimberly"
	USVoiceMatthew  PollyVoice = "Matthew"
	USVoiceSalli    PollyVoice = "Salli"
	// AU : Nicole, Russell.
	AUVoiceNicole PollyVoice = "Nicole"
	AUVoiceRussel PollyVoice = "Russel"
	// GB : Amy, Brian, Emma.
	GBVoiceAmy   PollyVoice = "Amy"
	GBVoiceBrian PollyVoice = "Brian"
	GBVoiceEmma  PollyVoice = "Emma"
	// IN : Aditi, Raveena.
	INVoiceAditi   PollyVoice = "Aditi"
	INVoiceRaveena PollyVoice = "Raveena"
	// CA : Chantal.
	CAVoiceChantal PollyVoice = "Chantal"
	// FR : Celine, Lea, Mathieu.
	FRVoiceCeline  PollyVoice = "Celine"
	FRVoiceLea     PollyVoice = "Lea"
	FRVoiceMathieu PollyVoice = "Mathieu"
	// DE : Hans, Marlene, Vicki.
	DEVoiceHans    PollyVoice = "Hans"
	DEVoiceMarlene PollyVoice = "Marlene"
	DEVoiceVicki   PollyVoice = "Vicki"
	// HI : Aditi.
	HIVoiceAditi PollyVoice = "Aditi"
	// IT : Carla, Giorgio, Bianca.
	ITVoiceCarla   PollyVoice = "Carla"
	ITVoiceGiorgio PollyVoice = "Giorgio"
	ITVoiceBianca  PollyVoice = "Bianca"
	// JP : Mizuki, Takumi.
	JPVoiceMizuki PollyVoice = "Mitzuki"
	JPVoiceTakumi PollyVoice = "Takumi"
	// BR : Vitoria, Camila, Ricardo.
	BRVoiceVitoria PollyVoice = "Vitoria"
	BRVoiceCamila  PollyVoice = "Camila"
	BRVoiceRicardo PollyVoice = "Ricardo"
	// es-US : Penelope, Lupe, Miguel.
	EsUSVoicePenelope PollyVoice = "Penelope"
	EsUSVoiceLupe     PollyVoice = "Lupe"
	EsUSVoiceMiguel   PollyVoice = "Miguel"
	// ES : Conchita, Enrique, Lucia.
	ESVoiceConchita PollyVoice = "Conchita"
	ESVoiceEnrique  PollyVoice = "Enrique"
	ESVoiceLucia    PollyVoice = "Lucia"
	// MX : Mia.
	MXVoiceMia PollyVoice = "Mia"
)

https://developer.amazon.com/en-US/docs/alexa/custom-skills/speech-synthesis-markup-language-ssml-reference.html#supported-voices

type ProsodyPitch 

type ProsodyPitch string

ProsodyPitch defines the pitch of the voice. Can be provided in %: positiv is higher, negative lower. 

const (
	ProsodyPitchXLow   ProsodyPitch = "x-low" //nolint:revive
	ProsodyPitchLow    ProsodyPitch = "low"
	ProsodyPitchMedium ProsodyPitch = "medium"
	ProsodyPitchHigh   ProsodyPitch = "high"
	ProsodyPitchXHigh  ProsodyPitch = "x-high"
)

type ProsodyRate 

type ProsodyRate string

ProsodyRate defines the speed of the voice. Can be provided in %: 100% is normal speed. 

const (
	ProsodyRateXSlow  ProsodyRate = "x-slow" //nolint:revive
	ProsodyRateSlow   ProsodyRate = "slow"
	ProsodyRateMedium ProsodyRate = "medium"
	ProsodyRateFast   ProsodyRate = "fast"
	ProsodyRateXFast  ProsodyRate = "x-fast"
)

type ProsodyVolume 

type ProsodyVolume string

ProsodyVolume defines the volume of the voice. Can be provided in +/-dB, e.g. "+2dB". 

const (
	ProsodyVolumeSilent ProsodyVolume = "silent" //nolint:revive
	ProsodyVolumeXSoft  ProsodyVolume = "x-soft"
	ProsodyVolumeSoft   ProsodyVolume = "soft"
	ProsodyVolumeMedium ProsodyVolume = "medium"
	ProsodyVolumeLoud   ProsodyVolume = "loud"
	ProsodyVolumeXLoud  ProsodyVolume = "x-loud"
)

type SayAsInterpretAs 

type SayAsInterpretAs string

SayAsInterpretAs is the type of pronunciation. 

const (
	// SayAsInterpretAsCharacters spells out each letter.
	SayAsInterpretAsCharacters SayAsInterpretAs = "characters"
	// SayAsInterpretAsCardinal interprets the value as a cardinal number.
	SayAsInterpretAsCardinal SayAsInterpretAs = "cardinal"
	// SayAsInterpretAsOrdinal interprets the value as an ordinal number.
	SayAsInterpretAsOrdinal SayAsInterpretAs = "ordinal"
	// SayAsInterpretAsDigits spells each digit separately.
	SayAsInterpretAsDigits SayAsInterpretAs = "digits"
	// SayAsInterpretAsFraction interprets the value as a fraction. This works for 3/20 as well as 1+1/2.
	SayAsInterpretAsFraction SayAsInterpretAs = "fraction"
	// SayAsInterpretAsUnit interprets a value as a measurement. Either a number or fraction followed by a unit or just a unit.
	SayAsInterpretAsUnit SayAsInterpretAs = "unit"
	// SayAsInterpretAsDate interprets the value as a date. Specify the format with the format attribute.
	SayAsInterpretAsDate SayAsInterpretAs = "date"
	// SayAsInterpretAsTime interprets a value such as 1'21" as duration in minutes and seconds.
	SayAsInterpretAsTime SayAsInterpretAs = "time"
	// SayAsInterpretAsTelephone interprets a value as a 7-digit or 10-digit telephone number.
	// This can also handle extensions (for example, 2025551212x345).
	SayAsInterpretAsTelephone SayAsInterpretAs = "telephone"
	// SayAsInterpretAsAddress interprets a value as part of street address.
	SayAsInterpretAsAddress SayAsInterpretAs = "address"
	// SayAsInterpretAsInterjection interprets the value as an interjection.
	// Alexa speaks the text in a more expressive voice. For optimal results, only use the supported interjections
	// and surround each speechcon with a pause. For example: <say-as interpret-as="interjection">Wow.</say-as>.
	// Speechcons are supported for the languages listed below.
	// https://developer.amazon.com/en-US/docs/alexa/custom-skills/speech-synthesis-markup-language-ssml-reference.html#supported-speechcons
	SayAsInterpretAsInterjection SayAsInterpretAs = "interjection"
	// SayAsInterpretAsExpletive "Bleeps" out the content inside the tag.
	SayAsInterpretAsExpletive SayAsInterpretAs = "expletive"
)

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.