Cisco Cisco Unified Customer Voice Portal 11.0(1) Developer's Guide

HAPTER

10:

MART

LUGINS

ISCO

CVP V

OICE

XML 3.1

Programmer

Guide

transcript (by making it

null

) would mean that if the audio file could not be found, the

application would prematurely end with an error.

The developer can throw a

SayItSmartException

in this method indicating the data passed to

the plugin could not be converted using the specified configuration. This would most likely end
the call prematurely so the exception should be thrown only when the Say It Smart plugin cannot
do what it is supposed to do and is unable to recover.

convertToFiles()

is abstract, meaning every Say It Smart plugin must implement this method.

SayItSmartContent convertToTTS(Object data, String inputFormat,

String outputFormat, String fileset)

This is the execution method for converting data to a TTS string. The arguments are identical in
this method as the

convertToFiles()

method. Note that even though the fileset option

technically does not apply here, it is included in case the plugin does alter the TTS output based
on fileset information.

The method must still return a

SayItSmartContent

object since the plugin may still decide to

play back the TTS content with pauses at certain points. In this case, the filename value would be
set to

null

Note that

convertToTTS()

is not abstract,

SayItSmartBase

actually provides a default

implementation of this method. The default implementation simply calls the

converToFiles()

method, combines the TTS transcripts it receives and returns a new

SayItSmartContent

object

with just those transcripts and any pauses. The plugin need only provide its own implementation
of this method if the desired behavior is different.

The developer can throw a

SayItSmartException

in this method indicating the data passed to

Configuration Methods

SayItSmartDisplay getDisplayInformation()

This method is used to specify display information for CVP VoiceXML Studio to render this
plugin’s configuration. The

SayItSmartDisplay

object lists the plugin type, input formats,

output format, and filesets. Each type, input format, output format, and fileset must have a real
name, display name, and description. The relationship between the input formats, output formats,
and filesets are defined by the methods listed below.

This method throws a

SayItSmartException

if the

SayItSmartDisplay

object is not

configured correctly.