1 /*

     2 * Copyright (c) 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:  Declaration of CSAnimTonePlugin class

    15 *

    16 */

    17 

    18 

    19 #ifndef SANIMTONEPLUGIN_H

    20 #define SANIMTONEPLUGIN_H

    21 

    22 #include <e32base.h>

    23 #include "sanimplugin.h"

    24 

    25 /**

    26 *  Base class for all Start-up Tone plug-in implementations.

    27 *  ECom interface UID for Start-up Tone Plug-in API is 0x2000B119.

    28 *

    29 *  @lib None

    30 *  @since S60 3.2

    31 */

    32 class CSAnimTonePlugin : public CSAnimPlugin

    33     {

    34 

    35 protected:

    36 

    37     /**

    38     * Constructor.

    39     *

    40     * @since S60 3.2

    41     */

    42     IMPORT_C CSAnimTonePlugin();

    43 

    44 public:

    45 

    46     /**

    47     * Set requested tone volume.

    48     *

    49     * @since S60 3.2

    50     *

    51     * @param aVolume Volume level to use.

    52     */

    53     IMPORT_C void SetVolume( const TInt aVolume );

    54 

    55     /**

    56     * Set requested volume ramp value.

    57     *

    58     * @since S60 3.2

    59     *

    60     * @param aVolumeRamp Volume ramp: the period over which the volume level is

    61     * to rise smoothly from nothing to the normal volume level.

    62     */

    63     IMPORT_C void SetVolumeRamp( const TTimeIntervalMicroSeconds& aVolumeRamp );

    64 

    65 private:

    66 

    67     /** Copy constructor. */

    68     CSAnimTonePlugin( const CSAnimTonePlugin& );

    69     /** Assignment operator. */

    70     CSAnimTonePlugin& operator=( const CSAnimTonePlugin& );

    71 

    72 protected: // data

    73 

    74     /** Volume level to use. */

    75     TInt iVolume;

    76 

    77     /**

    78     * Volume ramp: the period over which the volume level is to rise smoothly

    79     * from nothing to the normal volume level.

    80     */

    81     TTimeIntervalMicroSeconds iVolumeRamp;

    82 

    83     TAny* iReserved1; /** Reserved for future use. */

    84     TAny* iReserved2; /** Reserved for future use. */

    85     TInt iReserved3; /** Reserved for future use. */

    86     TInt iReserved4; /** Reserved for future use. */

    87 

    88     };

    89 

    90 #endif // SANIMTONEPLUGIN_H