centrafuse::Plugins Namespace Reference

The Main Plugin Namespace. More...

Namespaces
namespace	Bluetooth
	Bluetooth namespace.
Classes
class	CFControls
	Centrafuse CFControls. More...
class	CFDialog
	The main plugin dialog class. More...
class	CFNavPlugin
class	CFPlugin
class	CFSetupButton
	Settings button enumeration. More...
class	CFSetupHandlerParams
	Interface Setup control class. More...
interface	ICFInterfaceSetup
	The main interface setup/settings interface, for custom settings. More...
class	CFSetup
	The main plugin setup/settings class. More...
class	CFTools
	Centrafuse CFTools. More...
class	ConfigReader
	Configuration reader. More...
class	Effect
	Helper class used to define the parameters of a transition. More...
class	LanguageReader
	Language reader. More...
class	CFControlDesc
	Centrafuse control description class for use in certain API calls. More...
class	SkinReader
	Skin reader. More...
class	Win32
	Win32 system methods. More...
class	CFDialogParams
	Flags for CF_displayDialog(). More...
class	CFDialogResults
	Dialog results for CF_displayDialog(). More...
struct	MixerDeviceInput
	Mixer device input. More...
interface	ICFMixer
interface	ICFRadio
interface	ICFTts
	Voice Recognition and TTS interface. More...
interface	ICFVoice
	Centrafuse Voice Recognition Interface. More...
Enumerations
enum	CFNavInfo {   Altitude = 0,   Azimuth = 1,   Direction = 2,   ETA = 3,   ETR = 4,   HouseNumber = 5,   Latitude = 6,   LockedSatellites = 7,   Longitude = 8,   RemainingDistance = 9,   Speed = 10,   Street = 11,   City = 12,   Zip = 13,   DestCity = 14,   DestHouseNumber = 15,   DestAltitude = 16,   DestLatitude = 17,   DestLongitude = 18,   DestStreet = 19,   DestZip = 20,   NextTurn = 21,   InRoute = 22 }
enum	CFSetupHandlerRequest
	Interface Setup request types. More...
enum	TextCases {   Default = 1,   LowerCase = 2,   UpperCase = 3,   TitleCase = 4 }
	Text Cases. More...
enum	CF_AudioStatus
enum	CF_AudioAction
	Audio action. More...
enum	CF_ConfigSettings {   MusicPath = 1,   VideoPath = 2,   Skin = 3,   DaySkin = 4,   NightSkin = 5,   Width = 7,   Height = 8,   OSKLayout = 9,   CrossFadeTime = 10,   RadioDevice = 11,   RadioLine = 13,   RadioTuningStep = 14,   VFDDevice = 15,   DVDDisplay = 16,   VideoDisplay = 17,   VisualizationDisplay = 18,   StartupSection = 19,   ScrollDelay = 20,   AMRadioRange = 21,   FMRadioRange = 22,   XPosition = 23,   YPosition = 24,   Language = 25,   GPSComPort = 26,   GPSBaudRate = 28,   GPSProtocol = 34,   GPSDisplay = 39,   GPSVoicePrompts = 40,   GPSPOIPhonePrefix = 41,   GPSNavSoundLevel = 42,   AttMuteLevel = 43,   RearScreenSoundCard = 44,   RearScreenDisplay = 45,   ClickSoundLevel = 46,   PicturePath = 47 }
	System configuration settings. More...
enum	CF_ConfigFlags {   AutoPlay = 1,   OnTop = 2,   StartupAudio = 3,   HideCursor = 4,   Speech = 5,   VFD = 6,   CoverArt = 7,   Fullscreen = 8,   ClickSounds = 9,   Normalize = 10,   CrossFade = 11,   TrackSort = 12,   RadioMute = 13,   Shell = 14,   StartupSound = 15,   MediaAdded = 16,   NightSkinFlag = 17,   MetricFlag = 18,   SingleClickFlag = 19,   CarInMotion = 20,   GPSFullscreen = 21,   GPSEnableVoice = 23,   GPSAttMute = 29,   GPSSetNavSoundLevel = 30,   EnhancedGraphics = 32,   PhoneEnabled = 33,   PositionCountDown = 34,   AttMute = 35,   PreScan = 36,   AutoFullScreenVideo = 37,   EQ = 38,   MetricSpeedFlag = 39,   Vista = 40,   NoLimit = 41,   RearScreenEnabled = 42,   GPSRearUserRoutes = 44 }
	System configuration flags. More...
enum	CF_Dialogs {   ImportCD = 1,   FileBrowser = 2,   TagReader = 3,   LibraryImport = 4,   OkBox = 5,   OSK = 6,   SysInfo = 7,   YesNo = 8,   NumberPad = 9,   DateTime = 10,   Time = 11,   Copier = 12,   OkBoxBig = 13 }
	Available dialogs. More...
enum	CF_AudioLevels {   BAND1 = 1,   BAND2 = 2,   BAND3 = 3,   BAND4 = 4,   BAND5 = 5,   BAND6 = 6,   BAND7 = 7,   BAND8 = 8,   BAND9 = 9,   BAND10 = 10,   BALANCE = 11,   BASS = 12,   TREBLE = 13,   VOLUME = 14,   WAVVOLUME = 15 }
	Available audio levels. More...
enum	CF_MixerDevices {   NONE = 0,   MAIN = 1,   REAR = 2,   SUB = 3,   WAVE = 4,   LINE = 5,   CD = 6,   MIC = 7,   LINEIN = 8,   CDIN = 9,   AUX = 10,   SPDIF = 11 }
	Available mixer devices. More...
enum	CF_Actions {   MAINMENU = 1,   MEDIA = 2,   RADIO = 3,   DVD = 5,   TOOLS = 7,   MIXER = 8,   VISUAL = 9,   VOLUMEUP = 10,   VOLUMEDOWN = 11,   MUTE = 12,   UNMUTE = 13,   SHUFFLE = 14,   PREVSONG = 15,   PLAYPAUSE = 16,   NEXTSONG = 18,   CONNECT = 19,   DISCONNECT = 20,   TOGGLEVOICE = 21,   PRESET1 = 22,   PRESET2 = 23,   PRESET3 = 24,   PRESET4 = 25,   PRESET5 = 26,   ENTERTEXT = 27,   ALBUM = 28,   ARTIST = 29,   GENRE = 30,   VIDEO = 31,   EXIT = 100,   HIBERNATE = 101,   STANDBY = 102,   RESTART = 103,   SHUTDOWN = 104,   CLICKSOUND = 105,   MUTEAUDIO = 106,   UNMUTEAUDIO = 107,   SETTINGS = 108,   DIM = 109,   EXTAPPCLOSE = 110,   PRESET6 = 111,   PRESET7 = 112,   PRESET8 = 113,   GPS = 114,   NAV = 114,   PHONE = 115,   SHOWINFO = 116,   HIDEINFO = 117,   EXITMENU = 118,   FULLSCREENTOGGLE = 119,   CANCELROUTE = 120,   ZOOMIN = 121,   ZOOMOUT = 122,   NAVMENU = 123,   VIEWMENU = 124,   MINIMIZE = 125,   ATT = 126,   DISABLEATT = 127,   MUSIC = 128,   VIDEOS = 129,   IPOD = 131,   CALL = 132,   DIAL = 133,   BEEPSOUND = 140,   CHANGESKIN = 150,   REARSCREENCTRL = 160,   NOWPLAYING = 164,   TRACKDETAILS = 165,   USERLOGIN = 170,   DATETIME = 994,   NESTEDMENU = 995,   WEBLINK = 996,   EXTERNALAPP = 997,   PLUGIN = 998,   NOTHING = 999 }
enum	CF_PlayControl {   PLAYPAUSE = 0,   REWIND = 1,   FASTFORWARD = 2 }
	Enumerates play controls, the play/pause button, and the ffwd and rwd buttons. More...
enum	CF_ButtonState {   Down = 0,   HoldTimeExp,   Click,   HoldClick }
	Skin button state. More...
enum	CF_CMLTextItems {   MainTitle = 0,   MediaPosition,   MediaMode,   MediaDuration,   MediaArtist,   MediaAlbum,   MediaTitle,   MediaStation,   MediaSource }
	Available text items. More...
enum	CF_MixerType {   Recording = 0,   Playback = 1 }
	Mixer type, recording devices or playback devices. More...
enum	RADIO_DIRECTION {   UP = 0,   DOWN = 1 }
	Direction. More...
enum	RADIO_TUNE_BAND {   AM_LONG_BAND = 0,   AM_MEDIUM_BAND = 1,   FM_BAND = 2 }
	Tune bands. More...
enum	CFVrEnumResponse {   Yes = 0,   No = 1,   Home = 2,   Work = 3,   Cell = 4,   Cancel = 5,   Invalid = 999 }
	Voice interface question/response values. More...
enum	CFVrGrammarType {   General = 0,   Phonebook = 1,   Albums = 2,   Artists = 3,   Genre = 4,   Songs = 5 }
	Voice interface grammar types. More...
Functions
delegate void	CFSetupHandler (ref object value)
	Click Handler delegate for settings button click implementations.
delegate void	AudioCmpltHandler ()
	Audio complete Handler.
delegate void	CFTtsCompleteHandler ()
	Delegate type for receiving recognition events for when TTS has completed.
delegate void	CFVrCompleteHandler (bool success, CF_Actions action, string querytext)
	Delegate type for receiving recognition events from the voice recognition module.

---

Detailed Description

The Main Plugin Namespace.

---

Enumeration Type Documentation

enum CF_Actions

Available system actions.

All system actions are used in conjunction with CF_systemCommand(). Command specific parameters that can be used with each command are listed below where applicable.

Enumerator:

MAINMENU	Load main menu.
MEDIA	Load media.
RADIO	Load radio.
DVD	Load DVD.
TOOLS	Load CFTools.
MIXER	Load mixer.
VISUAL	Load visualization.
VOLUMEUP	Increase volume. Parameters: param1  [optional] "NODIALOG". Do not display the volume dialog.
VOLUMEDOWN	Decrease volume. Parameters: param1  [optional] "NODIALOG". Do not display the volume dialog.
MUTE	Mute volume.
UNMUTE	Unmute volume.
SHUFFLE	Toggle shuffle modes.
PREVSONG	Load previous song.
PLAYPAUSE	Play/pause toggle current selection.
NEXTSONG	Load next song.
CONNECT	Dial default internet connection. Parameters: param1  [optional] "NODIALOG". Do not display a dialog to user if connection fails.
DISCONNECT	Disconnect default internet connection.
TOGGLEVOICE	Start voice recognition.
PRESET1	Load radio preset 1.
PRESET2	Load radio preset 2.
PRESET3	Load radio preset 3.
PRESET4	Load radio preset 4.
PRESET5	Load radio preset 5.
ENTERTEXT	Enter text. Parameters: param1  Text to enter into focused input window.
ALBUM	Load album. Parameters: param1  Album name.
ARTIST	Load artist. Parameters: param1  Artist name.
GENRE	Load genre. Parameters: param1  Genre name.
VIDEO	Load video. Parameters: param1  Video Name/Path.
EXIT	System exit. Parameters: param1  [optional] "NODIALOG". Do not display a dialog to user confirming action.
HIBERNATE	System hibernate. Parameters: param1  [optional] "NODIALOG". Do not display a dialog to user confirming action.
STANDBY	System standby. Parameters: param1  [optional] "NODIALOG". Do not display a dialog to user confirming action.
RESTART	System restart. Parameters: param1  [optional] "NODIALOG". Do not display a dialog to user confirming action.
SHUTDOWN	System shutdown. Parameters: param1  [optional] "NODIALOG". Do not display a dialog to user confirming action.
CLICKSOUND	Perform click sound.
MUTEAUDIO	Mutes all audio. Parameters: param1  [optional] "STOPBUFFER". Forces buffered audio to stop recording.
UNMUTEAUDIO	Unmutes audio. Parameters: param1  [optional] "STOPBUFFER". Forces buffered audio to restart.
SETTINGS	Load settings.
DIM	Dim screen.
EXTAPPCLOSE	Restarts audio if CF_pluginPauseAudioFlag is set. Parameters: param1  [optional] "TRUE" or "FALSE". "TRUE" if app control should be closed when screen is closed. param2  [optional] "FALSE". "FALSE" if previous location should not be shown.
PRESET6	Load radio preset 6.
PRESET7	Load radio preset 7.
PRESET8	Load radio preset 8.
GPS	Load GPS.
NAV	Load Navigation.
PHONE	Load PHONE.
SHOWINFO	Display information dialog. Parameters: param2  Text to display. param2  [optional] "AUTOHIDE" or "DISPLAY". AUTOHIDE: autoclose the info dialog after 3 seconds. DISPLAY: display the dialog on the display specified by param3. param3  [optional] Display Number. If using "DISPLAY" for param2, param3 will indicate the display number. param4  [optional] "AUTOHIDE". If using "DISPLAY" in param2, will autoclose the info dialog after 3 seconds.
HIDEINFO	Hide information dialog.
EXITMENU	Exit menu.
FULLSCREENTOGGLE	Toggle fullscreen.
CANCELROUTE	Cancel navigation route.
ZOOMIN	Zoom in.
ZOOMOUT	Zoom out.
NAVMENU	Navigation menu.
VIEWMENU	View menu.
MINIMIZE	Minimize.
ATT	ATT.
DISABLEATT	Disable ATT.
MUSIC	Load music in my library.
VIDEOS	Load videos in my library.
IPOD	Load iPod in my library.
CALL	Call phone contact. Parameters: param1  Contact ID to dial. Deprecated: Will be implemented when phonebook sync is realized
DIAL	Dial phone number. Parameters: param1  Phone number to dial.
BEEPSOUND	Plays beep sound.
CHANGESKIN	Loads change skin page.
REARSCREENCTRL	Loads change skin page.
NOWPLAYING	Show current now playing source screen.
TRACKDETAILS	Show track details dialog.
USERLOGIN	Show Centrafuse user login dialog.
DATETIME	Load date/time edit dialog. Parameters: param1  Nested Menu Name. The display name.
NESTEDMENU	Load nested menu. Parameters: param1  Nested Menu Name. The display name.
WEBLINK	Loads web link.
EXTERNALAPP	Loads external application. Parameters: param1  Window display name of external application.
PLUGIN	Load plugin. Parameters: param1  Plugin Name. The plugin display name. To open the plugin, param 2, 3, and 4 shall not be used. param2  [optional] Plugin Command. Tell the plugin specified by param1 to execute this command. param3  [optional] Plugin Command Param1. Additional/Optional param for the command sent in param2. param4  [optional] Plugin Command Param2. Additional/Optional param for the command sent in param2.
NOTHING	Do nothing.

enum CF_AudioAction

Audio action.

enum CF_AudioLevels

Available audio levels.

Enumerator:

BAND1	Equalizer band 1.
BAND2	Equalizer band 2.
BAND3	Equalizer band 3.
BAND4	Equalizer band 4.
BAND5	Equalizer band 5.
BAND6	Equalizer band 6.
BAND7	Equalizer band 7.
BAND8	Equalizer band 8.
BAND9	Equalizer band 9.
BAND10	Equalizer band 10.
BALANCE	Audio balance.
BASS	Audio bass.
TREBLE	Audio treble.
VOLUME	Audio volume (Windows Volume) (0 - 65535).
WAVVOLUME	WAV Audio volume (Windows XP Volume) (0 - 65535).

enum CF_AudioStatus

Audio status.

enum CF_ButtonState

Skin button state.

Enumerator:

Down	DOWN button state.
HoldTimeExp	HOLD (DOWN) button state, button was held for [holdtime]+ seconds, but has not been released yet.
Click	CLICK (UP) button state.
HoldClick	CLICK (UP) button state, button was held for [holdtime]+ seconds.

enum CF_CMLTextItems

Available text items.

Enumerator:

MainTitle	Main title text (main and track details).
MediaPosition	Position text (track details).
MediaMode	Mode text (track details).
MediaDuration	Duration text (track details).
MediaArtist	Current artist text.
MediaAlbum	Current album text.
MediaTitle	Current title text.
MediaStation	Current station text.
MediaSource	Current source text.

enum CF_ConfigFlags

System configuration flags.

Enumerator:

AutoPlay	AutoPlay discs when inserted.
OnTop	Display application ontop.
StartupAudio	Play audio on startup.
HideCursor	Hide system cursor.
Speech	Enable speech recognition.
VFD	Enable VFD.
CoverArt	Display cover art.
Fullscreen	Display application fullscreen.
ClickSounds	Enable click sounds.
Normalize	Enable normalization.
CrossFade	Enable cross fading.
TrackSort	Sort using track number.
RadioMute	Mute radio on exit.
Shell	Run application as system shell.
StartupSound	Play startup sound.
MediaAdded	Media added flag.
NightSkinFlag	Night skin flag.
MetricFlag	Metric flag.
SingleClickFlag	Single Click flag.
CarInMotion	Car in motion.
GPSFullscreen	GPS Fullscreen.
GPSEnableVoice	GPS Enable Voice.
GPSAttMute	GPS ATT Mute.
GPSSetNavSoundLevel	Allow navigation voice to set sound level.
EnhancedGraphics	Enhanced Graphics flag.
PhoneEnabled	Is phone enabled.
PositionCountDown	Music position label counts down.
AttMute	Attenuation mute.
PreScan	Pre scan songs before loading.
AutoFullScreenVideo	Auto full screen videos when played.
EQ	Auto full screen videos when played.
MetricSpeedFlag	Metric flag.
Vista	Vista flag.
NoLimit	NoLimit flag (passed on CF command line only).
RearScreenEnabled	Flag indicating whether rear screen is currently enabled.
GPSRearUserRoutes	GPS ATT Mute.

enum CF_ConfigSettings

System configuration settings.

Enumerator:

MusicPath	Path to music folder.
VideoPath	Path to video folder.
Skin	Current skin.
DaySkin	Current day skin.
NightSkin	Current night skin.
Width	Application width.
Height	Application height.
OSKLayout	Keyboard layout.
CrossFadeTime	Cross fade time.
RadioDevice	Radio device.
RadioLine	Radio mixer line.
RadioTuningStep	Radio tuning step.
VFDDevice	VFD device.
DVDDisplay	DVD display monitor.
VideoDisplay	Video display monitor.
VisualizationDisplay	Visualization display monitor.
StartupSection	Startup section.
ScrollDelay	Main title scroll delay.
AMRadioRange	AM Radio range.
FMRadioRange	FM Radio range.
XPosition	X Position.
YPosition	Y Position.
Language	Language.
GPSComPort	GPS Com Port.
GPSBaudRate	GPS Baud Rate.
GPSProtocol	GPS Protocol, 1 = SiRF / 2 = NMEA.
GPSDisplay	GPS secondary display number.
GPSVoicePrompts	GPS Voice Prompts. This is a | delimited list. 1 = Over Speed Limit, 2 = Route Recalculation, 4 = Low Signal, 8 = GPS Not Found, 16 = Drive Carefully.
GPSPOIPhonePrefix	GPS POI Phone Prefix.
GPSNavSoundLevel	GPS navigation voice sound level.
AttMuteLevel	Sound level for attenuation.
RearScreenSoundCard	Soundcard used for rear screen zone.
RearScreenDisplay	Display used for rear screen zone.
ClickSoundLevel	ClickSound level.
PicturePath	Path to picture folder.

enum CF_Dialogs

Available dialogs.

Enumerator:

ImportCD	Import CD dialog.
FileBrowser	File browser dialog.
TagReader	Tag reader dialog.
LibraryImport	Library import dialog.
OkBox	Ok box dialog.
OSK	OSK dialog.
SysInfo	System information dialog.
YesNo	Yes/No dialog.
NumberPad	Number pad dialog.
DateTime	Date Time dialog.
Time	Time dialog.
Copier	Copy file/folder dialog.
OkBoxBig	Ok box dialog, big size (taller).

enum CF_MixerDevices

Available mixer devices.

Deprecated:

Replaced by new Volume/Audio API where device indexes must now be used

See also:

CF_setMixerLevel(), CF_getMixerLevel()

Enumerator:

NONE	No mixer channel.
MAIN	Mixer Main channel.
REAR	Mixer Rear channel.
SUB	Mixer Sub channel.
WAVE	Mixer Wave channel.
LINE	Mixer Line channel.
CD	Mixer CD channel.
MIC	Mixer Microphone channel.
LINEIN	Mixer Line in channel.
CDIN	Mixer CD in channel.
AUX	Mixer Auxiliary channel.
SPDIF	Mixer SPDIF channel.

enum CF_MixerType

Mixer type, recording devices or playback devices.

Enumerator:

Recording	Recording device.
Playback	Playback device.

enum CF_PlayControl

Enumerates play controls, the play/pause button, and the ffwd and rwd buttons.

Enumerator:

PLAYPAUSE	Play/pause button.
REWIND	Rewind button.
FASTFORWARD	FastForward button.

enum CFNavInfo

Enumerator:

Altitude	Altitude.
Azimuth	Azimuth.
Direction	Direction.
ETA	Estimate time of arrival to current route.
ETR	Estimate time remaining to current route.
HouseNumber	Current house number.
Latitude	Current latitude.
LockedSatellites	Locked Satellites.
Longitude	Current longitude.
RemainingDistance	Remaining distance in current route.
Speed	Speed.
Street	Current street.
City	Current city.
Zip	Current zip.
DestCity	Destination city.
DestHouseNumber	Destination longitude.
DestAltitude	Destination latitude.
DestLatitude	Destination latitude.
DestLongitude	Destination longitude.
DestStreet	Destination street.
DestZip	Destination zip.
NextTurn	Next turn.
InRoute	Next turn.

enum CFSetupHandlerRequest

Interface Setup request types.

enum CFVrEnumResponse

Voice interface question/response values.

Used by the GetEnumResponse() function for allowing Centrafuse to "ask" user a question, i.e. "Yes or No", and get a valid response of "Yes", or "No", or if neither, "Invalid". Centrafuse will also ask the question "Home, Work, Cell, or Cancel", or "Home, Cell, or Cancel", etc, when making a handsfree phone call by way of voice recognition command, and expecting to receive a "Home", "Work", "Cell", or "Cancel" response, or if not any, the "Invalid" response.

Enumerator:

Yes	Yes value.
No	No value.
Home	Home value.
Work	Work value.
Cell	Cell value.
Cancel	Cancel value.
Invalid	Invalid value.

enum CFVrGrammarType

Voice interface grammar types.

Used by the CreateGrammar() function for loading different dynamic grammars, and the general cf command grammar.

Enumerator:

General	The general CF command grammar, static, or optionally created at runtime.
Phonebook	Phonebook dynamic grammar, created at runtime.
Albums	Albums dynamic grammar, created at runtime.
Artists	Artists dynamic grammar, created at runtime.
Genre	Genre dynamic grammar, created at runtime.
Songs	Songs dynamic grammar, created at runtime.

enum RADIO_DIRECTION

Direction.

Enumerator:

UP	Up.
DOWN	Down.

enum RADIO_TUNE_BAND

Tune bands.

Enumerator:

AM_LONG_BAND	AM Long Band.
AM_MEDIUM_BAND	AM Medium Band.
FM_BAND	FM.

enum TextCases

Text Cases.

Enumerator:

Default	Default Case.
LowerCase	Lower Case.
UpperCase	Upper Case.
TitleCase	Title Case.

---

Function Documentation

delegate void centrafuse::Plugins::AudioCmpltHandler

(

)

Audio complete Handler.

delegate void centrafuse::Plugins::CFSetupHandler

(

ref object

value

)

Click Handler delegate for settings button click implementations.

delegate void centrafuse::Plugins::CFTtsCompleteHandler

(

)

Delegate type for receiving recognition events for when TTS has completed.

At least one callback should be registered for application if using asynchronous Start() calls.

delegate void centrafuse::Plugins::CFVrCompleteHandler	(	bool	success,
		CF_Actions	action,
		string	querytext
	)

Delegate type for receiving recognition events from the voice recognition module.

At least one callback should be registered for application.