MRemConCoreApiTargetObserver Class Reference

#include <remconcoreapitargetobserver.h>

Link against: remconcoreapi.lib

class MRemConCoreApiTargetObserver

Public Member Functions
virtual IMPORT_C void	MrccatoCommand(TRemConCoreApiOperationId, TRemConCoreApiButtonAction)
virtual IMPORT_C void	MrccatoPlay(TRemConCoreApiPlaybackSpeed, TRemConCoreApiButtonAction)
virtual IMPORT_C void	MrccatoSelectAudioInputFunction(TUint8, TRemConCoreApiButtonAction)
virtual IMPORT_C void	MrccatoSelectAvInputFunction(TUint8, TRemConCoreApiButtonAction)
virtual IMPORT_C void	MrccatoSelectDiskFunction(TUint, TRemConCoreApiButtonAction)
virtual IMPORT_C void	MrccatoTuneFunction(TBool, TUint, TUint, TRemConCoreApiButtonAction)

Detailed Description

Clients must implement this interface in order to instantiate objects of type CRemConCoreApiTarget. This interface passes incoming commands from RemCon to the client. In order to minimise the number of virtual functions the client has to implement, (a) they aren't pure, and (b) most commands are presented via 'Command' with an operation ID. Commands which are associated with command-specific data come instead through specific methods, e.g. 'Play', which comes with a play speed. Incoming commands are given to client via the MRemConCoreApiTargetObserver mixin. Having received a command, the client is obliged to send a response. A client can only have one send outstanding at any time. If commands come in quickly, the client is responsible for queueing its responses to them. Note that each command delivered to a target involves memory allocated in the servers heap, which is only released on client closure or when a response is sent.

Member Function Documentation

MrccatoCommand ( TRemConCoreApiOperationId, TRemConCoreApiButtonAction )

IMPORT_C void	MrccatoCommand	(	TRemConCoreApiOperationId	aOperationId,
			TRemConCoreApiButtonAction	aButtonAct
		)	[virtual]

A command has been received.

Parameters
aOperationId	The operation ID of the command.
aButtonAct	The button action associated with the command.

MrccatoPlay ( TRemConCoreApiPlaybackSpeed, TRemConCoreApiButtonAction )

IMPORT_C void	MrccatoPlay	(	TRemConCoreApiPlaybackSpeed	aSpeed,
			TRemConCoreApiButtonAction	aButtonAct
		)	[virtual]

A 'play' command has been received.

Parameters
aSpeed	The playback speed.
aButtonAct	The button action associated with the command.

MrccatoSelectAudioInputFunction ( TUint8, TRemConCoreApiButtonAction )

IMPORT_C void	MrccatoSelectAudioInputFunction	(	TUint8	aAudioInputSignalNumber,
			TRemConCoreApiButtonAction	aButtonAct
		)	[virtual]

A 'select audio input function' has been received.

Parameters
aAudioInputSignalNumber	The audio input.
aButtonAct	The button action associated with the command.

MrccatoSelectAvInputFunction ( TUint8, TRemConCoreApiButtonAction )

IMPORT_C void	MrccatoSelectAvInputFunction	(	TUint8	aAvInputSignalNumber,
			TRemConCoreApiButtonAction	aButtonAct
		)	[virtual]

A 'select AV input function' has been received.

Parameters
aAvInputSignalNumber	The AV input.
aButtonAct	The button action associated with the command.

MrccatoSelectDiskFunction ( TUint, TRemConCoreApiButtonAction )

IMPORT_C void	MrccatoSelectDiskFunction	(	TUint	aDisk,
			TRemConCoreApiButtonAction	aButtonAct
		)	[virtual]

A 'select disk function' has been received.

Parameters
aDisk	The disk.
aButtonAct	The button action associated with the command.

MrccatoTuneFunction ( TBool, TUint, TUint, TRemConCoreApiButtonAction )

IMPORT_C void	MrccatoTuneFunction	(	TBool	aTwoPart,
			TUint	aMajorChannel,
			TUint	aMinorChannel,
			TRemConCoreApiButtonAction	aButtonAct
		)	[virtual]

A 'tune function' command has been received.

Parameters
aTwoPart	If EFalse, only aMajorChannel is to be used. Otherwise, both aMajorChannel and aMinorChannel are to be used.
aMajorChannel	The major channel number.
aMinorChannel	The minor channel number.
aButtonAct	The button action associated with the command.