internetradio2.0/commandchannelinc/irctrlcommand.h
changeset 14 896e9dbc5f19
parent 12 608f67c22514
child 15 065198191975
equal deleted inserted replaced
12:608f67c22514 14:896e9dbc5f19
     1 /*
       
     2 * Copyright (c) 2006-2007 Nokia Corporation and/or its subsidiary(-ies). 
       
     3 * All rights reserved.
       
     4 * This component and the accompanying materials are made available
       
     5 * under the terms of "Eclipse Public License v1.0"
       
     6 * which accompanies this distribution, and is available
       
     7 * at the URL "http://www.eclipse.org/legal/epl-v10.html".
       
     8 *
       
     9 * Initial Contributors:
       
    10 * Nokia Corporation - initial contribution.
       
    11 *
       
    12 * Contributors:
       
    13 *
       
    14 * Description:  ?Description
       
    15 *
       
    16 */
       
    17 
       
    18 
       
    19 #ifndef IRCTRLCOMMAND_H
       
    20 #define IRCTRLCOMMAND_H
       
    21 
       
    22 #include <e32cmn.h>
       
    23 
       
    24 #include "ircontrolparams.h"
       
    25 
       
    26 /**
       
    27 * Class is an abstract class which provides interfaces to pass commands
       
    28 * MCtrlCommand can pass a command and value to the inherited class
       
    29 * FetchVolume is meant for fetching the volume
       
    30 * DoAudioFadeOut is to activate Fade out fade in effect
       
    31 */
       
    32 class MIRCtrlCmdObserver
       
    33     {
       
    34 public:
       
    35     /**
       
    36      * Function : MCrtlCmdCommand
       
    37      * Function is pure virtual function which used to pass commands
       
    38      * @param TIRControlCommmand represents the commands,which determines 
       
    39      * what action to be taken
       
    40      * @param aValue represents any integer value if any, like buffering
       
    41      * percentage
       
    42      */
       
    43     virtual void MCtrlCommand( TIRControlCommmand aCommand, TInt aValue ) = 0;
       
    44 
       
    45     /**
       
    46      * Function : FetchVolume
       
    47      * Function is pure virtual function which sents Request to get the
       
    48      * current volume index
       
    49      * @return volume index
       
    50      */
       
    51     virtual TInt FetchVolume() = 0;
       
    52     
       
    53     /**
       
    54      * Function : DoAudioFadeOut
       
    55      * Function is pure virtual function, it is used to sent request start 
       
    56      * audio Fade Out
       
    57      */
       
    58     virtual void DoAudioFadeOut() = 0;
       
    59     /**
       
    60      * Function : PlayerChanged()
       
    61      * Function is pure virtual function, It notifies the Observer WhenEver
       
    62 	* Player Changed
       
    63      * audio Fade Out
       
    64      */
       
    65     virtual void PlayerChanged() = 0;
       
    66     };
       
    67 
       
    68 /**
       
    69 * Class is an abstract class which provides interfaces to fill the buffer
       
    70 * Request to fill the buffer is made through this interface
       
    71 */
       
    72 class MIRStreamFill
       
    73     {
       
    74 public:
       
    75     /**
       
    76      * Function: FilltheBuffer
       
    77      * function is pure virtual implementation of and is call to fill
       
    78      * the buffer 
       
    79      * @param reference to the buffer to be filled with data
       
    80      */
       
    81     virtual void FilltheBuffer(TDes8& aInputBuffer) = 0;
       
    82     };
       
    83     
       
    84 #endif //IRCTRLCOMMAND_H
       
    85