1.1 --- a/epoc32/include/remconcoreapitargetobserver.h Tue Nov 24 13:55:44 2009 +0000
1.2 +++ b/epoc32/include/remconcoreapitargetobserver.h Tue Mar 16 16:12:26 2010 +0000
1.3 @@ -1,1 +1,103 @@
1.4 -remconcoreapitargetobserver.h
1.5 +// Copyright (c) 2004-2009 Nokia Corporation and/or its subsidiary(-ies).
1.6 +// All rights reserved.
1.7 +// This component and the accompanying materials are made available
1.8 +// under the terms of the License "Symbian Foundation License v1.0" to Symbian Foundation members and "Symbian Foundation End User License Agreement v1.0" to non-members
1.9 +// which accompanies this distribution, and is available
1.10 +// at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
1.11 +//
1.12 +// Initial Contributors:
1.13 +// Nokia Corporation - initial contribution.
1.14 +//
1.15 +// Contributors:
1.16 +//
1.17 +// Description:
1.18 +//
1.19 +
1.20 +
1.21 +
1.22 +/**
1.23 + @file
1.24 + @publishedAll
1.25 + @released
1.26 +*/
1.27 +
1.28 +#ifndef REMCONCOREAPITARGETOBSERVER_H
1.29 +#define REMCONCOREAPITARGETOBSERVER_H
1.30 +
1.31 +#include <e32base.h>
1.32 +#include <remconcoreapi.h>
1.33 +
1.34 +/**
1.35 +Clients must implement this interface in order to instantiate objects of type
1.36 +CRemConCoreApiTarget. This interface passes incoming commands from RemCon to
1.37 +the client.
1.38 +In order to minimise the number of virtual functions the client has to
1.39 +implement, (a) they aren't pure, and (b) most commands are presented via
1.40 +'Command' with an operation ID.
1.41 +Commands which are associated with command-specific data come instead through
1.42 +specific methods, e.g. 'Play', which comes with a play speed.
1.43 +Incoming commands are given to client via the MRemConCoreApiTargetObserver mixin.
1.44 +Having received a command, the client is obliged to send a response.
1.45 +A client can only have one send outstanding at any time.
1.46 +If commands come in quickly, the client is responsible for queueing its responses to them.
1.47 +Note that each command delivered to a target involves memory allocated in the server’s heap,
1.48 +which is only released on client closure or when a response is sent.
1.49 +*/
1.50 +class MRemConCoreApiTargetObserver
1.51 + {
1.52 +public:
1.53 + /**
1.54 + A command has been received.
1.55 + @param aOperationId The operation ID of the command.
1.56 + @param aButtonAct The button action associated with the command.
1.57 + */
1.58 + virtual void MrccatoCommand(TRemConCoreApiOperationId aOperationId,
1.59 + TRemConCoreApiButtonAction aButtonAct);
1.60 +
1.61 + /**
1.62 + A 'play' command has been received.
1.63 + @param aSpeed The playback speed.
1.64 + @param aButtonAct The button action associated with the command.
1.65 + */
1.66 + virtual void MrccatoPlay(TRemConCoreApiPlaybackSpeed aSpeed,
1.67 + TRemConCoreApiButtonAction aButtonAct);
1.68 +
1.69 + /**
1.70 + A 'tune function' command has been received.
1.71 + @param aTwoPart If EFalse, only aMajorChannel is to be used. Otherwise,
1.72 + both aMajorChannel and aMinorChannel are to be used.
1.73 + @param aMajorChannel The major channel number.
1.74 + @param aMinorChannel The minor channel number.
1.75 + @param aButtonAct The button action associated with the command.
1.76 + */
1.77 + virtual void MrccatoTuneFunction(TBool aTwoPart,
1.78 + TUint aMajorChannel,
1.79 + TUint aMinorChannel,
1.80 + TRemConCoreApiButtonAction aButtonAct);
1.81 +
1.82 + /**
1.83 + A 'select disk function' has been received.
1.84 + @param aDisk The disk.
1.85 + @param aButtonAct The button action associated with the command.
1.86 + */
1.87 + virtual void MrccatoSelectDiskFunction(TUint aDisk,
1.88 + TRemConCoreApiButtonAction aButtonAct);
1.89 +
1.90 + /**
1.91 + A 'select AV input function' has been received.
1.92 + @param aAvInputSignalNumber The AV input.
1.93 + @param aButtonAct The button action associated with the command.
1.94 + */
1.95 + virtual void MrccatoSelectAvInputFunction(TUint8 aAvInputSignalNumber,
1.96 + TRemConCoreApiButtonAction aButtonAct);
1.97 +
1.98 + /**
1.99 + A 'select audio input function' has been received.
1.100 + @param aAudioInputSignalNumber The audio input.
1.101 + @param aButtonAct The button action associated with the command.
1.102 + */
1.103 + virtual void MrccatoSelectAudioInputFunction(TUint8 aAudioInputSignalNumber,
1.104 + TRemConCoreApiButtonAction aButtonAct);
1.105 + };
1.106 +
1.107 +#endif // REMCONCOREAPITARGETOBSERVER_H