Namespace ivrToolkit.Core.Interfaces

Interfaces

IFileHandler

This interface is used to inject the Regular File handler or one that can be used for unit testing.

IIvrBaseLine

This interface provides methods to control the selected IVR plugin. It is primarily used by the ivrToolkit.Core.Util.LineWrapper class.

IIvrLine

This interface exposes the main methods used to control the selected plugin.

IIvrLineManagement

The purpose of this interface is to define functionality that will be called from another thread like the LineManager

IIvrPlugin

Defines the common methods for different plugin implementations.

ILineManager

The LineManager keeps track of the lines in use.

IPlayMethods

Defines a collection of methods for playing audio to the person on the call.

IPromptMethods

This interface defines the different prompt methods that are available through the line.

A prompt is a file/message to play followed by asking for digits. A multiTryPrompt is one that will repeat x number of times until you get what you expect.

IScript

A script block is a unit of code that does one particular job. It is used by the script manager to navigate through your menu options.

IScriptManager

A collection of common methods used by the implementations.

A caching mechanism for TTS. TTS generated will be stored as a wav file so that future calls will not have to call the TTS process again. Two files are created. A wav file and a text file. The wav file contains the TTS wav stream and the text contains the text message.

In order to skip TTS generation, the wav file must exist and the text in the text file must match the text message.

If a wav file path is not specified, no caching will happen and TTS will run every time.

ITextToSpeechCacheFactory

Used to generate an instance of ITextToSpeechCache. This provides a way of caching Text to speech as a wav file so that later use will not have to rerun the TTS process.

// example:
var ttsCache = ttsCacheFactory.Create(text, wavFileName);

You can then pass ttsCache to PlayFile or PlayTextToSpeech

ITextToSpeechFactory

Factory to used to generate text-to-speech engines. Passed into the LineManager LineManager