1 /*

     2  * Copyright (c) 2010 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: QT Bindings for TMS

    15  *

    16  */

    17 

    18 #ifndef QTMS_VOLUME_EFFECT_H

    19 #define QTMS_VOLUME_EFFECT_H

    20 

    21 #include <qtms.h>

    22 #include <qtmseffect.h>

    23 #include "qtmswrapperexport.h"

    24 

    25 // FORWARD DECLARATIONS

    26 namespace TMS

    27 {

    28 class TMSEffect;

    29 }

    30 

    31 namespace QTMS

    32 {

    33 

    34 /**

    35  * QTMSVolumeEffect class

    36  *

    37  * This class provides volume level control in the stream scope.

    38  *

    39  * @lib QTMSapi.lib

    40  *

    41  */

    42 class QTMS_WRAPPER_DLL_EXPORT QTMSVolumeEffect : public QObject,

    43                                                  public QTMSEffect

    44 {

    45     Q_OBJECT

    46 public:

    47     /**

    48      * Destructor

    49      */

    50     virtual ~QTMSVolumeEffect();

    51 

    52     /**

    53      * Set audio volume level. The volume level should not be higher than

    54      * the value returned by GetMaxLevel().

    55      *

    56      * @param  level

    57      *      Volume level to be set.

    58      *

    59      * @return

    60      *      QTMS_RESULT_SUCCESS if the operation was successful.

    61      *

    62      */

    63     gint SetLevel(const guint level);

    64 

    65     /**

    66      * Return current audio volume level settings.

    67      *

    68      * @param  level

    69      *      Volume level.

    70      *

    71      * @return

    72      *      QTMS_RESULT_SUCCESS if the operation was successful.

    73      *

    74      */

    75     gint GetLevel(guint& level);

    76 

    77     /**

    78      * Return max volume level supported by the device.

    79      *

    80      * @param  level

    81      *      Max volume level.

    82      *

    83      * @return

    84      *      QTMS_RESULT_SUCCESS if the operation was successful.

    85      *

    86      */

    87     gint GetMaxLevel(guint& level);

    88 

    89     /**

    90      * Returns type of the effect.

    91      *

    92      * This function can be called at any time.

    93      *

    94      * @param  effecttype

    95      *      Variable that contains the effect type on return.

    96      *

    97      * @return

    98      *      QTMS_RESULT_SUCCESS if the operation was successful.

    99      *

   100      */

   101     virtual gint GetType(QTMSEffectType& effecttype);

   102 

   103     Q_SIGNALS:

   104     void EffectsEvent(const QTMSEffect& tmseffect, QTMSSignalEvent event);

   105 

   106 protected:

   107     /**

   108      * Constructor

   109      */

   110     QTMSVolumeEffect();

   111 

   112 protected:

   113     TMS::TMSEffect *iEffect;

   114 };

   115 

   116 } //namespace QTMS

   117 

   118 #endif //QTMS_VOLUME_EFFECT_H