Collapse all Symbian^3 Product Developer Library

CRadioPlayerUtility::CBody Class Reference

class CRadioPlayerUtility::CBody : public CBase

This class encapsulates the implementation body of CRadioPlayerUtility interface.

Radio_Utility.lib

Since: S60 3.2

Inherits from

CRadioPlayerUtility::CBody
- CBase

Public Member Functions
	~CBody()
void	Close()
TAny *	CustomInterface(TUid)
TInt	GetBalance(TInt &, TInt &)
TInt	GetMaxVolume(TInt &)
TInt	GetVolume(TInt &)
TBool	IsMute()
TInt	Mute(TBool)
CBody *	NewL(RRadioSession &, MRadioPlayerObserver &)
void	Play()
void	PlayerState(TPlayerState &)
TInt	SetBalance(TInt, TInt)
TInt	SetVolume(TInt)
TInt	SetVolumeRamp(const TTimeIntervalMicroSeconds &)
void	Stop()

Private Member Functions
	CBody()
void	ConstructL()

Inherited Functions
	CBase::CBase()
	CBase::Delete(CBase *)
	CBase::Extension_(TUint,TAny &,TAny )
	CBase::operator new(TUint)
	CBase::operator new(TUint,TAny *)
	CBase::operator new(TUint,TLeave)
	CBase::operator new(TUint,TLeave,TUint)
	CBase::operator new(TUint,TUint)
	CBase::~CBase()

Private Attributes
MRadioPlayerObserver *	iRadioPlayerUtilityClient
RRadioSession *	iRadioSession

Constructor & Destructor Documentation

CBody()

CBody

(

)

[private]

~CBody()

~CBody

(

)

Member Functions Documentation

Close()

void

(

)

Close the radio player and free all memory allocated. Any ongoing playing activity will be stopped if no other clients need it.

Since: S60 3.2

ConstructL()

void

ConstructL

(

)

[private]

CustomInterface(TUid)

TAny *

CustomInterface

(

TUid

InterfaceId

)

Retrieves a custom interface to the device. (Used by Audio Enhancement)

Since: S60 3.2

Parameters

TUid InterfaceId

GetBalance(TInt &, TInt &)

TInt	GetBalance	(	TInt &	aLeftPercentage,
			TInt &	aRightPercentage
		)	const

Get the speaker balance set for playing.

Since: S60 3.2

Parameters

TInt & aLeftPercentage	On return contains left speaker volume perecentage. This can be any value from zero to 100. Zero value means left speaker is muted.
TInt & aRightPercentage	On return contains right speaker volume perecentage. This can be any value from zero to 100. Zero value means right speaker is muted.

GetMaxVolume(TInt &)

TInt

GetMaxVolume

(

TInt &

aMaxVolume

)

const

Get the maximum volume supported by the device. Volume range from 0 to max. Setting volume to zero will mute the speakers.

Since: S60 3.2

Parameters

TInt & aMaxVolume

On return contains the maximum volume supported.

GetVolume(TInt &)

TInt

GetVolume

(

TInt &

aVolume

)

const

Get the current volume.

Since: S60 3.2

Parameters

TInt & aVolume

On return contains the current volume.

IsMute()

TBool

IsMute

(

)

Find out if the audio is muted or not.

Since: S60 3.2

Mute(TBool)

TInt

Mute

(

TBool

aMute

)

Mutes or unmutes radio playback.

Since: S60 3.2

Parameters

TBool aMute

ETrue to mute the audio, EFalse to unmute it.

NewL(RRadioSession &, MRadioPlayerObserver &)

CBody *	NewL	(	RRadioSession &	aRadioSession,
			MRadioPlayerObserver &	aObserver
		)	[static]

Parameters

RRadioSession & aRadioSession
MRadioPlayerObserver & aObserver

Play()

void

Play

(

)

Asynchronous request to start playing the radio.

User must be ready to receive callback method MrpoStateChange. If radio plays successfully, the user will receive callback method MrpoStateChange with ERadioPlayerPlaying and KErrNone. If a problem is encountered, user will receive callback MrpoStateChange with ERadioPlayerIdle with an error code.

Since: S60 3.2

MRadioPlayerObserver::MrpoStateChange

PlayerState(TPlayerState &)

void

PlayerState

(

TPlayerState &

aPlayerState

)

const

Retrieve the current state of the player. If the radio is already playing, client should simply retrieve current settings such as volume, etc.

Since: S60 3.2

Parameters

TPlayerState & aPlayerState

SetBalance(TInt, TInt)

TInt	SetBalance	(	TInt	aLeftPercentage,
			TInt	aRightPercentage
		)

Set the speaker balance for playing.

Since: S60 3.2

Parameters

TInt aLeftPercentage	Left speaker volume percentage. This can be any value from zero to 100. Setting a zero value mutes the sound on left speaker.
TInt aRightPercentage	Right speaker volume percentage. This can be any value from zero to 100. Setting a zero value mutes the sound on right speaker.

SetVolume(TInt)

TInt

SetVolume

(

TInt

aVolume

)

Set the volume to the specified level. This can be any value from zero to max returned by GetMaxVolume.

Since: S60 3.2

Parameters

TInt aVolume

The volume level to set.

SetVolumeRamp(const TTimeIntervalMicroSeconds &)

TInt

SetVolumeRamp

(

const TTimeIntervalMicroSeconds &

aRampInterval

)

Set a volume ramp. Must be called before Play.

Since: S60 3.2

Parameters

const TTimeIntervalMicroSeconds & aRampInterval

The time interval over which the volume should be increased from zero to the current volume setting.

Stop()

void

Stop

(

)

Asynchronous request to stop the radio.

This will stop radio for all client applications playing the radio. If the application wishes to terminate without disrupting the radio playback (in case of multiple active applications running), the application should terminate without issuing Stop. User must be ready to receive callback method MrpoStateChange.

Since: S60 3.2

MRadioPlayerObserver::MrpoStateChange

Member Data Documentation

MRadioPlayerObserver * iRadioPlayerUtilityClient

MRadioPlayerObserver *

iRadioPlayerUtilityClient

[private]

RRadioSession * iRadioSession

RRadioSession *

iRadioSession

[private]