centrafuse.Plugins.ICFRadio Interface Reference

Radio interface. More...

List of all members.

Public Member Functions
bool	InitializeRadio ()
	Initialize radio.
void	ShutdownRadio ()
	Shutdown radio.
void	Mute ()
	Mute radio.
void	UnMute ()
	UnMute radio.
void	StandbyRadio (int currentFreq)
	Radio Standby, function runs when system goes into standby.
bool	ResumeRadio (int currentFreq)
	Radio Resume, function runs when system resumes from standby.
int	TuneFreq (int Freq)
	Tune frequency.
int	SeekFreq (RADIO_DIRECTION searchDirection, int currentFreq)
	Seek.
bool	SetTuneBand (RADIO_TUNE_BAND Band)
	Set tune band.
int	GetStation ()
	Get current station.
string	GetRDSInformation ()
	Get RDS information.
bool	StereoLockSupport ()
	Indicates whether the radio supports a stereo lock flag. This is used for seeking, when seek functions are not available, to know when the radio has locked onto a station. If you have working seek functions, return false.
bool	StereoLock ()
	Indicates whether the radio is locked onto a station, by knowing if it has a stereo lock.
Properties
string	RadioDevice [get]
	Radio device.

---

Detailed Description

Radio interface.

---

Member Function Documentation

string centrafuse.Plugins.ICFRadio.GetRDSInformation

(

)

Get RDS information.

Returns:

Returns RDS information, return null if RDS is not supported.

int centrafuse.Plugins.ICFRadio.GetStation

(

)

Get current station.

Returns:

Returns current station, return -1 if get current station is not supported.

This method is used to show the station scrolling as you seek. When using asynchronous seek methods this will be used to determine when it has locked onto a station and show the seek while in progress.

bool centrafuse.Plugins.ICFRadio.InitializeRadio

(

)

Initialize radio.

Returns:

Returns if initialization is successful.

void centrafuse.Plugins.ICFRadio.Mute

(

)

Mute radio.

bool centrafuse.Plugins.ICFRadio.ResumeRadio

(

int

currentFreq

)

Radio Resume, function runs when system resumes from standby.

int centrafuse.Plugins.ICFRadio.SeekFreq	(	RADIO_DIRECTION	searchDirection,
		int	currentFreq
	)

Seek.

Returns:

Returns radio frequency, returns -1 if seek not available.

Return -2 if you are using asynchronous seeking methods.

bool centrafuse.Plugins.ICFRadio.SetTuneBand

(

RADIO_TUNE_BAND

Band

)

Set tune band.

Returns:

Return false if multiple bands not supported.

void centrafuse.Plugins.ICFRadio.ShutdownRadio

(

)

Shutdown radio.

void centrafuse.Plugins.ICFRadio.StandbyRadio

(

int

currentFreq

)

Radio Standby, function runs when system goes into standby.

bool centrafuse.Plugins.ICFRadio.StereoLock

(

)

Indicates whether the radio is locked onto a station, by knowing if it has a stereo lock.

Returns:

Returns whether the radio is locked onto a station, by knowing if it has a stereo lock.

bool centrafuse.Plugins.ICFRadio.StereoLockSupport

(

)

Indicates whether the radio supports a stereo lock flag. This is used for seeking, when seek functions are not available, to know when the radio has locked onto a station. If you have working seek functions, return false.

Returns:

Returns whether the radio supports a stereo lock flag.

int centrafuse.Plugins.ICFRadio.TuneFreq

(

int

Freq

)

Tune frequency.

Returns:

Returns radio frequency.

void centrafuse.Plugins.ICFRadio.UnMute

(

)

UnMute radio.

---

Property Documentation

string centrafuse.Plugins.ICFRadio.RadioDevice [get]

Radio device.

---

The documentation for this interface was generated from the following file:

• ICFRadio.cs