ICFTts Interface Reference

Voice Recognition and TTS interface. More...

Inherits centrafuse::Plugins::ICFInterfaceSetup.

Collaboration diagram for ICFTts:

Public Member Functions
bool	Init ()
	Load TTS.
void	Cleanup ()
	Close TTS, clean up all resources.
bool	Start (string text, bool synchronous)
	Use TTS to speak.
void	Stop ()
	Close TTS, clean up all resources.
void	CF_setupReadSettings (int page, bool advanced, CFSetupHandler[] buttonHandlers, string[] buttonLabels, string[] buttonValues)
	Custom settings setup.
void	CF_setupExitSettings (bool save)
	Save currently loaded custom settings to file.
void	CF_setupReloadSharedSettings ()
	Reload Centrafuse shared settings.
Properties
int	numBasicSetupPages `[get]`
	Number of settings pages in Basic Settings..
int	numAdvancedSetupPages `[get]`
	Number of settings pages in Advanced Settings..
Events
CFTtsCompleteHandler	TtsComplete
	Event fires when TTS has finished.

Detailed Description

Voice Recognition and TTS interface.

Overview

Voice modules compiled for Centrafuse reference the CFPlugin dll, included in this SDK in the root directory. The CFPlugin dll provides the developer with all of the necessary interfaces and classes to create functional pieces to work in conjunction with Centrafuse software. For example, popular plugins that already exist are SkinBrowser, LogoDashboard, and FileSync. Satellite Radio is also implemented in CF as a plugin. Radio support is added through use of a plugin. Basically anything a developer can imagine can be added to CF.

Inheritance and ICFTts

Centrafuse Radio Modules are (Microsoft termed) "Class libraries", built from projects in .NET that produce a dll library object that Centrafuse can load at runtime. These dll's must expose at least 1 form which inherits from ICFTts, available through the Centrafuse Plugin Interface Dll, cfplugin.dll, which must be referenced by plugin's project.

Your tts interface will always inherit the ICFTts interface.

The TTS Module constructor

Your tts module dll will of course contain a constructor, whether or not you choose to implement one is up to you. Your constructor is called when your radio module dll is loaded into memory, keep in mind that initialization of Centrafuse HAS NOT completed yet. To be sure that Centrafuse initialization is complete when you initialize your plugin, wait until your CF_pluginInit() override is called, which is directly following Centrafuse initialization. In the following example, just some simple flags are set, and the call to a function that will create a plugin config.xml file if it doesn't exist.

Member Function Documentation

void CF_setupExitSettings ( bool save ) [inherited]

Save currently loaded custom settings to file.

Interface shall build the setup for any custom settings that may be required, and shall implement a Save() routine to handle when the SAVE button is clicked by user. Settings should not be saved to file until this function is called by Centrafuse.

void CF_setupReadSettings	(	int	page,
		bool	advanced,
		CFSetupHandler[]	buttonHandlers,
		string[]	buttonLabels,
		string[]	buttonValues
	)			`[inherited]`

Custom settings setup.

Interface shall build the setup for any custom settings that may be required.

void CF_setupReloadSharedSettings ( ) [inherited]

Reload Centrafuse shared settings.

Interface shall build the setup for any custom settings that may be required, and shall implement a Reload() routine to handle when the SAVE button is clicked by user for the Shared settings. All shared settings should be reloaded when this function is called by Centrafuse.

void Cleanup ( )

Close TTS, clean up all resources.

bool Init ( )

Load TTS.

bool Start	(	string	text,
		bool	synchronous
	)

Use TTS to speak.

Parameters:

	text	The text to speak
	synchronous	Whether call shall block or not block.

void Stop ( )

Close TTS, clean up all resources.

Property Documentation

int numAdvancedSetupPages [get, inherited]

Number of settings pages in Advanced Settings..

int numBasicSetupPages [get, inherited]

Number of settings pages in Basic Settings..

Event Documentation

CFTtsCompleteHandler TtsComplete

Event fires when TTS has finished.