hwrmhaptics/examples/hapticstestapp/inc/hapticstestasyncplaysender.h
author hgs
Fri, 08 Oct 2010 14:33:25 +0300
changeset 76 cb32bcc88bad
permissions -rw-r--r--
201039
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
76
hgs
parents:
diff changeset
     1
/*
hgs
parents:
diff changeset
     2
* Copyright (c) 2008 Nokia Corporation and/or its subsidiary(-ies). 
hgs
parents:
diff changeset
     3
* All rights reserved.
hgs
parents:
diff changeset
     4
* This component and the accompanying materials are made available
hgs
parents:
diff changeset
     5
* under the terms of the License "Symbian Foundation License v1.0"
hgs
parents:
diff changeset
     6
* which accompanies this distribution, and is available
hgs
parents:
diff changeset
     7
* at the URL "http://www.symbianfoundation.org/legal/sfl-v10.html".
hgs
parents:
diff changeset
     8
*
hgs
parents:
diff changeset
     9
* Initial Contributors:
hgs
parents:
diff changeset
    10
* Nokia Corporation - initial contribution.
hgs
parents:
diff changeset
    11
*
hgs
parents:
diff changeset
    12
* Contributors:
hgs
parents:
diff changeset
    13
*
hgs
parents:
diff changeset
    14
* Description:  Definition for asynchronous play commands sender object.
hgs
parents:
diff changeset
    15
*
hgs
parents:
diff changeset
    16
*/
hgs
parents:
diff changeset
    17
hgs
parents:
diff changeset
    18
hgs
parents:
diff changeset
    19
#ifndef __HAPTICSTEST_ASYNCPLAYSENDER_H__
hgs
parents:
diff changeset
    20
#define __HAPTICSTEST_ASYNCPLAYSENDER_H__
hgs
parents:
diff changeset
    21
hgs
parents:
diff changeset
    22
#include <e32base.h>
hgs
parents:
diff changeset
    23
class CHapticsTestAppView;
hgs
parents:
diff changeset
    24
class CHapticsTestAppUi;
hgs
parents:
diff changeset
    25
hgs
parents:
diff changeset
    26
/**
hgs
parents:
diff changeset
    27
 * Active Object for sending async play methods
hgs
parents:
diff changeset
    28
 */
hgs
parents:
diff changeset
    29
class CHapticsTestAsyncPlaySender : public CActive
hgs
parents:
diff changeset
    30
    {
hgs
parents:
diff changeset
    31
public: 
hgs
parents:
diff changeset
    32
hgs
parents:
diff changeset
    33
    /**
hgs
parents:
diff changeset
    34
     * Constructor
hgs
parents:
diff changeset
    35
     *
hgs
parents:
diff changeset
    36
     * @param aUi   Pointer to the test appl UI object.
hgs
parents:
diff changeset
    37
     */
hgs
parents:
diff changeset
    38
    CHapticsTestAsyncPlaySender( CHapticsTestAppUi* aUi );
hgs
parents:
diff changeset
    39
                                 
hgs
parents:
diff changeset
    40
    /**
hgs
parents:
diff changeset
    41
     * Destructor
hgs
parents:
diff changeset
    42
     */
hgs
parents:
diff changeset
    43
    virtual ~CHapticsTestAsyncPlaySender();
hgs
parents:
diff changeset
    44
 
hgs
parents:
diff changeset
    45
    /**
hgs
parents:
diff changeset
    46
     * Method for fileHandle type playing of effects repeatedly in asynch mode
hgs
parents:
diff changeset
    47
     * 
hgs
parents:
diff changeset
    48
     * @param aHaptics Pointer to the haptics interface object.
hgs
parents:
diff changeset
    49
     * @param aFileHandle Handle for the effect data buffer from which to
hgs
parents:
diff changeset
    50
     *                    play the effects.
hgs
parents:
diff changeset
    51
     * @param aEffectIndex Index of the effect that is being played.
hgs
parents:
diff changeset
    52
     * @param aRepeat Number of repeats.
hgs
parents:
diff changeset
    53
     * @param aEffectHandle Out-parameter to which the handle for the played
hgs
parents:
diff changeset
    54
     *        effect is returned.
hgs
parents:
diff changeset
    55
     */
hgs
parents:
diff changeset
    56
    void PlayRepeat( CHWRMHaptics* aHaptics,
hgs
parents:
diff changeset
    57
                     TInt  aFileHandle,
hgs
parents:
diff changeset
    58
                     TInt aEffectIndex,
hgs
parents:
diff changeset
    59
                     TUint8 aRepeat,
hgs
parents:
diff changeset
    60
                     TInt& aEffectHandle );
hgs
parents:
diff changeset
    61
hgs
parents:
diff changeset
    62
    /**
hgs
parents:
diff changeset
    63
     * Method for fileHandle type playing of effects in asynch mode
hgs
parents:
diff changeset
    64
     * 
hgs
parents:
diff changeset
    65
     * @param aHaptics Pointer to the haptics interface object.
hgs
parents:
diff changeset
    66
     * @param aFileHandle Handle for the effect data buffer from which to
hgs
parents:
diff changeset
    67
     *                    play the effects.
hgs
parents:
diff changeset
    68
     * @param aEffectIndex Index of the effect that is being played.
hgs
parents:
diff changeset
    69
     * @param aEffectHandle Out-parameter to which the handle for the played
hgs
parents:
diff changeset
    70
     *        effect is returned.
hgs
parents:
diff changeset
    71
     */
hgs
parents:
diff changeset
    72
    void Play( CHWRMHaptics* aHaptics,
hgs
parents:
diff changeset
    73
               TInt  aFileHandle,
hgs
parents:
diff changeset
    74
               TInt aEffectIndex,
hgs
parents:
diff changeset
    75
               TInt& aEffectHandle );
hgs
parents:
diff changeset
    76
 
hgs
parents:
diff changeset
    77
public:
hgs
parents:
diff changeset
    78
hgs
parents:
diff changeset
    79
    /**
hgs
parents:
diff changeset
    80
     * From CActive
hgs
parents:
diff changeset
    81
     */
hgs
parents:
diff changeset
    82
    virtual void RunL();
hgs
parents:
diff changeset
    83
    
hgs
parents:
diff changeset
    84
    /**
hgs
parents:
diff changeset
    85
     * From CActive
hgs
parents:
diff changeset
    86
     */
hgs
parents:
diff changeset
    87
    virtual void DoCancel();
hgs
parents:
diff changeset
    88
hgs
parents:
diff changeset
    89
    /**
hgs
parents:
diff changeset
    90
     * From CActive
hgs
parents:
diff changeset
    91
     */
hgs
parents:
diff changeset
    92
    virtual TInt RunError( TInt aError ); 
hgs
parents:
diff changeset
    93
 
hgs
parents:
diff changeset
    94
private:
hgs
parents:
diff changeset
    95
hgs
parents:
diff changeset
    96
    /**
hgs
parents:
diff changeset
    97
     * Pointer to the application UI object.
hgs
parents:
diff changeset
    98
     * Not owned.
hgs
parents:
diff changeset
    99
     */
hgs
parents:
diff changeset
   100
    CHapticsTestAppUi* iUi;
hgs
parents:
diff changeset
   101
hgs
parents:
diff changeset
   102
    /**
hgs
parents:
diff changeset
   103
     * Index of the effect for which the play request was made.
hgs
parents:
diff changeset
   104
     */
hgs
parents:
diff changeset
   105
    TInt iIndex;
hgs
parents:
diff changeset
   106
    };
hgs
parents:
diff changeset
   107
hgs
parents:
diff changeset
   108
#endif // __HAPTICSTEST_ASYNCPLAYSENDER_H__
hgs
parents:
diff changeset
   109