Centrafuse Logo Flux Logo


Package centrafuse.Plugins

The Main Plugin Namespace. More...


Classes

class  CFControls
 Centrafuse CFControls. More...
class  CFDialog
 The main plugin dialog class. All plugin dialogs need to inherit from this class. More...
class  CFPlugin
 The main plugin class. All plugins need to inherit from this class. More...
class  CFSetup
 The main plugin setup class. All plugin setups need to inherit from this class. More...
class  CFTools
 Centrafuse CFTools. More...
class  cfvis
 Visualization. More...
class  ConfigReader
 Configuration reader. More...
struct  MixerDeviceInput
 Mixer device input. More...
interface  ICFRadio
 Radio interface. More...
interface  IPlugin
 Plugin interface. More...
class  LanguageReader
 Language reader. More...
class  SkinReader
 Skin reader. More...
class  InvalidVolumeException
 Invalid Volume Exception. More...
class  InvalidVolumeTypeException
 Invalid Volume Type Exception. More...
class  VolumeAccessException
 Volume Access Exception. More...
class  vinfo
 Presents information about a volume. More...
class  Win32
 Win32 system methods. More...

Enumerations

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 = 27,
  GPSHomeHouse = 28,
  GPSHomeStreet = 29,
  GPSHomeLatitude = 30,
  GPSHomeLongitude = 31,
  GPSProtocol = 32,
  GPSFontSize = 33,
  GPSMapLabels = 34,
  GPSNotification = 35,
  GPSPOIRadius = 36,
  GPSDisplay = 37,
  GPSVoicePrompts = 38,
  GPSPOIPhonePrefix = 39
}
 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,
  GPSAutozoom = 22,
  GPSEnableVoice = 23,
  GPSRotateInfo = 24,
  GPSAvoidUTurns = 25,
  GPSAutoToggleDayNight = 26,
  GPSAutoSwitch = 27,
  GPSAutoShowTurnByTurn = 28,
  EnhancedGraphics = 29
}
 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
}
 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
}
 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_TextItems {
  MainTitle = 1,
  Position = 2,
  Time = 11,
  Date = 4,
  Mode = 6,
  CurrentArtist = 9,
  CurrentAlbum = 10,
  CurrentTitle = 11,
  CurrentTrackNumber = 12,
  CurrentFileName = 13
}
 Available text items. 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,
  PLAY = 16,
  PAUSE = 17,
  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,
  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,
  PICTURES = 130,
  IPOD = 131,
  CALL = 132,
  DIAL = 133,
  CHANGESKIN = 150,
  WEBLINK = 996,
  EXTERNALAPP = 997,
  PLUGIN = 998,
  NOTHING = 999
}
enum  CF_GPSInfo {
  LATITUDE = 1,
  LONGITUDE = 2,
  DIRECTION = 3,
  SPEED = 4,
  HOUSENUMBER = 5,
  ALTITUDE = 6,
  STREET = 7,
  AZIMUTH = 8,
  LOCKEDSATELLITES = 9,
  ETR = 10,
  ETA = 11,
  REMAININGDISTANCE = 12,
  CITY = 13,
  ZIP = 14,
  DESTLATITUDE = 15,
  DESTLONGITUDE = 16,
  DESTHOUSENUMBER = 17,
  DESTSTREET = 18,
  DESTCITY = 19,
  DESTZIP = 20,
  NEXTTURN = 21
}
 GPS information flags. 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  VolumeTypes {
  Unknown = 0x0,
  Invalid,
  Removable,
  Fixed,
  Remote,
  CDROM,
  RAMDisk
}
 Volume Types. More...
enum  VolumeFlags {
  Unknown = 0x0,
  CaseSensitive = 0x00000001,
  Compressed = 0x00008000,
  PersistentACLS = 0x00000008,
  PreservesCase = 0x00000002,
  ReadOnly = 0x00080000,
  SupportsEncryption = 0x00020000,
  SupportsFileCompression = 0x00000010,
  SupportsNamedStreams = 0x00040000,
  SupportsObjectIDs = 0x00010000,
  SupportsQuotas = 0x00000020,
  SupportsReparsePoints = 0x00000080,
  SupportsSparseFiles = 0x00000040,
  SupportsUnicodeOnVolume = 0x00000004
}
 Volume Flags. More...


Detailed Description

The Main Plugin Namespace.

Enumeration Type Documentation

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.

PLAY  Play current selection.

PAUSE  Pause current song.

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.

UNMUTEAUDIO  Unmutes audio.

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.

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.

PICTURES  Load pictures 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.
CHANGESKIN  Loads change skin page.

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.

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.

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.

GPSAutozoom  GPS Autozoom.

GPSEnableVoice  GPS Enable Voice.

GPSRotateInfo  GPS Rotate Info.

GPSAvoidUTurns  GPS Avoid UTurns.

GPSAutoToggleDayNight  GPS Auto Toggle Day/Night.

GPSAutoSwitch  GPS AutoSwitch.

GPSAutoShowTurnByTurn  GPS Auto Show Turn By Turn.

EnhancedGraphics  Enhanced Graphics flag.

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.

GPSHomeHouse  GPS Home House.

GPSHomeStreet  GPS Home Street.

GPSHomeLatitude  GPS Home Latitude.

GPSHomeLongitude  GPS Home Longitude.

GPSProtocol  GPS Protocol, 1 = SiRF / 2 = NMEA.

GPSFontSize  GPS Font Size, 0 = Normal / 1 = Large.

GPSMapLabels  GPS Map Labels, 0 = Normal / 1 = Large.

GPSNotification  GPS Notification, 0 = No Visual Notification / 1 = Verbal/Visual Notification / 3 = Sign/Visual Notification.

GPSPOIRadius  GPS POI Radius.

GPSDisplay  GPS Display.

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.

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.

Time text.

GPS information flags.

Enumerator:
LATITUDE  Current latitude.

LONGITUDE  Current longitude.

DIRECTION  Direction.

SPEED  Speed.

HOUSENUMBER  Current house number.

ALTITUDE  Altitude.

STREET  Current street.

AZIMUTH  Azimuth.

LOCKEDSATELLITES  Locked Satellites.

ETR  Estimate time remaining to current route.

ETA  Estimate time of arrival to current route.

REMAININGDISTANCE  Remaining distance in current route.

CITY  Current city.

ZIP  Current zip.

DESTLATITUDE  Destination latitude.

DESTLONGITUDE  Destination longitude.

DESTHOUSENUMBER  Destination house number.

DESTSTREET  Destination street.

DESTCITY  Destination city.

DESTZIP  Destination zip.

NEXTTURN  Next turn.

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.

Available text items.

Enumerator:
MainTitle  Main title text.

Position  Position text.

Time  Time dialog.

Time text.

Date  Date text.

Mode  Mode text.

CurrentArtist  Current artist text.

CurrentAlbum  Current album text.

CurrentTitle  Current title text.

CurrentTrackNumber  Current track number text.

CurrentFileName  Current file name text.

Direction.

Enumerator:
UP  Up.

DOWN  Down.

Tune bands.

Enumerator:
AM_LONG_BAND  AM Long Band.

AM_MEDIUM_BAND  AM Medium Band.

FM_BAND  FM.

Volume Flags.

Enumerator:
Unknown  The drive type cannot be determined.

Volume Flag.

CaseSensitive  Volume Flag.

Compressed  Volume Flag.

PersistentACLS  Volume Flag.

PreservesCase  Volume Flag.

ReadOnly  Volume Flag.

SupportsEncryption  Volume Flag.

SupportsFileCompression  Volume Flag.

SupportsNamedStreams  Volume Flag.

SupportsObjectIDs  Volume Flag.

SupportsQuotas  Volume Flag.

SupportsReparsePoints  Volume Flag.

SupportsSparseFiles  Volume Flag.

SupportsUnicodeOnVolume  Volume Flag.

Volume Types.

Enumerator:
Unknown  The drive type cannot be determined.

Volume Flag.

Invalid  The root path is invalid. For example, no volume is mounted at the path.

Removable  The disk can be removed from the drive.

Fixed  The disk cannot be removed from the drive.

Remote  The drive is a remote (network) drive.

CDROM  The drive is a CD-ROM drive.

RAMDisk  The drive is a RAM disk.





Copyright © 2008 Flux Media, Inc. (U.S. Copyright Registration Number: TXu-1-239-794) Flux Logo