Class: Twilio::TwiML::SsmlW

Inherits:
TwiML
  • Object
show all
Defined in:
lib/twilio-ruby/twiml/voice_response.rb

Overview

Improving Pronunciation by Specifying Parts of Speech in <Say>

Instance Attribute Summary

Attributes inherited from TwiML

#name

Instance Method Summary collapse

Methods inherited from TwiML

#add_child, #add_text, #append, #comment, to_lower_camel_case, #to_s, #xml

Constructor Details

#initialize(words: nil, **keyword_args) {|_self| ... } ⇒ SsmlW

Returns a new instance of SsmlW.

Yields:

  • (_self)

Yield Parameters:


647
648
649
650
651
652
# File 'lib/twilio-ruby/twiml/voice_response.rb', line 647

def initialize(words: nil, **keyword_args)
  super(**keyword_args)
  @name = 'w'
  @value = words unless words.nil?
  yield(self) if block_given?
end

Instance Method Details

#break(strength: nil, time: nil, **keyword_args) ⇒ Object

Create a new <Break> element

strength

Set a pause based on strength

time

Set a pause to a specific length of time in seconds or milliseconds, available values: [number]s, [number]ms

keyword_args

additional attributes


659
660
661
# File 'lib/twilio-ruby/twiml/voice_response.rb', line 659

def break(strength: nil, time: nil, **keyword_args)
  append(SsmlBreak.new(strength: strength, time: time, **keyword_args))
end

#emphasis(words: nil, level: nil, **keyword_args) {|emphasis| ... } ⇒ Object

Create a new <Emphasis> element

words

Words to emphasize

level

Specify the degree of emphasis

keyword_args

additional attributes

Yields:


668
669
670
671
672
673
# File 'lib/twilio-ruby/twiml/voice_response.rb', line 668

def emphasis(words: nil, level: nil, **keyword_args)
  emphasis = SsmlEmphasis.new(words: words, level: level, **keyword_args)

  yield(emphasis) if block_given?
  append(emphasis)
end

#phoneme(words, alphabet: nil, ph: nil, **keyword_args) ⇒ Object

Create a new <Phoneme> element

words

Words to speak

alphabet

Specify the phonetic alphabet

ph

Specifiy the phonetic symbols for pronunciation

keyword_args

additional attributes


681
682
683
# File 'lib/twilio-ruby/twiml/voice_response.rb', line 681

def phoneme(words, alphabet: nil, ph: nil, **keyword_args)
  append(SsmlPhoneme.new(words, alphabet: alphabet, ph: ph, **keyword_args))
end

#prosody(words: nil, volume: nil, rate: nil, pitch: nil, **keyword_args) {|prosody| ... } ⇒ Object

Create a new <Prosody> element

words

Words to speak

volume

Specify the volume, available values: default, silent, x-soft, soft, medium, loud, x-loud, +ndB, -ndB

rate

Specify the rate, available values: x-slow, slow, medium, fast, x-fast, n%

pitch

Specify the pitch, available values: default, x-low, low, medium, high, x-high, +n%, -n%

keyword_args

additional attributes

Yields:


692
693
694
695
696
697
# File 'lib/twilio-ruby/twiml/voice_response.rb', line 692

def prosody(words: nil, volume: nil, rate: nil, pitch: nil, **keyword_args)
  prosody = SsmlProsody.new(words: words, volume: volume, rate: rate, pitch: pitch, **keyword_args)

  yield(prosody) if block_given?
  append(prosody)
end

#say_as(words, interpretAs: nil, role: nil, **keyword_args) ⇒ Object

Create a new <Say-As> element

words

Words to be interpreted

interpretAs

Specify the type of words are spoken

role

Specify the format of the date when interpret-as is set to date

keyword_args

additional attributes


705
706
707
# File 'lib/twilio-ruby/twiml/voice_response.rb', line 705

def say_as(words, interpretAs: nil, role: nil, **keyword_args)
  append(SsmlSayAs.new(words, interpretAs: interpretAs, role: role, **keyword_args))
end

#sub(words, aliasAttribute: nil, **keyword_args) ⇒ Object

Create a new <Sub> element

words

Words to be substituted

aliasAttribute

Substitute a different word (or pronunciation) for selected text such as an acronym or abbreviation

keyword_args

additional attributes


714
715
716
# File 'lib/twilio-ruby/twiml/voice_response.rb', line 714

def sub(words, aliasAttribute: nil, **keyword_args)
  append(SsmlSub.new(words, aliasAttribute: aliasAttribute, **keyword_args))
end