1 listenerlocationbase.h

     1 /*

     2 * Copyright (c) 2006 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 the License "Symbian Foundation License v1.0" to Symbian Foundation members and "Symbian Foundation End User License Agreement v1.0" to non-members

     6 * which accompanies this distribution, and is available

     7 * at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".

     8 *

     9 * Initial Contributors:

    10 * Nokia Corporation - initial contribution.

    11 *

    12 * Contributors:

    13 *

    14 * Description:  This is the definition of the listener location effect class.

    15 *

    16 */

    17 

    18 

    19 #ifndef CLISTENERLOCATION_H

    20 #define CLISTENERLOCATION_H

    21 

    22 // INCLUDES

    23 

    24 #include <e32base.h>

    25 #include <LocationBase.h>

    26 #include <MCustomInterface.h>

    27 

    28 const TUid KUidListenerLocationEffect = {0x1020382D};

    29 

    30 // FORWARD DELCARATION

    31 class CMdaAudioConvertUtility;

    32 class CMdaAudioPlayerUtility;

    33 class CMdaAudioRecorderUtility;

    34 class CMdaAudioInputStream;

    35 class CMdaAudioOutputStream;

    36 class CMdaAudioToneUtility;

    37 class CCustomCommandUtility;

    38 class CCustomInterfaceUtility;

    39 class CMMFDevSound;

    40 class CMidiClientUtility;

    41 class CDrmPlayerUtility;

    42 class CVideoPlayerUtility;

    43 

    44 // CLASS DECLARATION

    45 

    46 /**

    47 *  This is the listener location effect class for managing audio location settings.

    48 *

    49 *  @lib ListenerLocationEffect.lib

    50 *  @since 3.0

    51 */

    52 

    53 class CListenerLocation : public CLocation

    54     {

    55 

    56     public:     // Constructors and Destructor

    57 

    58         /**

    59         * Factory function for creating the listener location object.

    60         * @since 3.0

    61         * @param aUtility A reference to a convert utility

    62         * @return pointer to CListenerLocation object

    63         */

    64         IMPORT_C static CListenerLocation* NewL( CMdaAudioConvertUtility& aUtility );

    65 

    66         /**

    67         * Factory function for creating the listener location object.

    68         * @since 3.0

    69         * @param aUtility A reference to an audio input stream utility

    70         * @return pointer to CListenerLocation object

    71         */

    72         IMPORT_C static CListenerLocation* NewL( CMdaAudioInputStream& aUtility );

    73 

    74         /**

    75         * Factory function for creating the listener location object.

    76         * @since 3.0

    77         * @param aUtility A reference to an audio output stream utility

    78         * @return pointer to CListenerLocation object

    79         */

    80         IMPORT_C static CListenerLocation* NewL( CMdaAudioOutputStream& aUtility );

    81 

    82         /**

    83         * Factory function for creating the listener location object.

    84         * @since 3.0

    85         * @param aUtility A reference to an audio player utility

    86         * @return pointer to CListenerLocation object

    87         */

    88         IMPORT_C static CListenerLocation* NewL( CMdaAudioPlayerUtility& aUtility );

    89 

    90         /**

    91         * Factory function for creating the listener location object.

    92         * @since 3.0

    93         * @param aUtility A reference to an audio record utility

    94         * @param aRecordStream ETrue if the effect is to be applied to the recording,

    95         *                      EFalse if the effect is to be applied only to the playback

    96         * @return pointer to CListenerLocation object

    97         */

    98         IMPORT_C static CListenerLocation* NewL( CMdaAudioRecorderUtility& aUtility, TBool aRecordStream );

    99 

   100         /**

   101         * Factory function for creating the listener location object.

   102         * @since 3.0

   103         * @param aUtility A reference to an audio tone utility

   104         * @return pointer to CListenerLocation object

   105         */

   106         IMPORT_C static CListenerLocation* NewL( CMdaAudioToneUtility& aUtility );

   107 

   108         /**

   109         * Factory function for creating the listener location object.

   110         * @since 3.0

   111         * @param aDevSound A reference to a DevSound instance

   112         * @return pointer to CListenerLocation object

   113         */

   114         IMPORT_C static CListenerLocation* NewL( CMMFDevSound& aDevSound );

   115 

   116         /**

   117         * Factory function for creating the listener location object.

   118         * @since 3.0

   119         * @param aUtility A reference to a custom command utility

   120         * @return pointer to CListenerLocation object

   121         */

   122         IMPORT_C static CListenerLocation* NewL( CCustomCommandUtility* aUtility );

   123 

   124         /**

   125         * Factory function for creating the listener location object.

   126         * @since 3.0

   127         * @param aCustomInterface A reference to a custom interface

   128         * @return pointer to CListenerLocation object

   129         */

   130         IMPORT_C static CListenerLocation* NewL( MCustomInterface& aCustomInterface );

   131 

   132         /**

   133         * Factory function for creating the listener location object.

   134         * @since 3.0

   135         * @param aUtility A reference to a CMidiClientUtility

   136         * @return pointer to CListenerLocation object

   137         */

   138 

   139         IMPORT_C static CListenerLocation* NewL( CMidiClientUtility& aUtility );

   140 

   141         /**

   142         * Factory function for creating the listener location object.

   143         * @since 3.0

   144         * @param CDrmPlayerUtility A reference to a CDrmPlayerUtility object

   145         * @return pointer to CListenerLocation object

   146         */

   147         IMPORT_C static CListenerLocation* NewL( CDrmPlayerUtility& aUtility );

   148 

   149         /**

   150         * Factory function for creating the listener location object.

   151         * @since 3.2

   152         * @param CVideoPlayerUtility A reference to a CVideoPlayerUtility object

   153         * @return pointer to CListenerLocation object

   154         */

   155         IMPORT_C static CListenerLocation* NewL( CVideoPlayerUtility& aUtility );

   156 

   157         /**

   158         *

   159         * Destructor

   160         */

   161         IMPORT_C virtual ~CListenerLocation();

   162 

   163     public: // functions from base class

   164 

   165         /*

   166         * From CAudioEffect

   167         * Get the unique identifier of the audio effect

   168         * @since 3.0

   169         * @return Unique identifier

   170         */

   171         IMPORT_C TUid Uid() const;

   172 

   173     protected:

   174 

   175         /**

   176         * Private C++ constructor for this class.

   177         * @since    3.0

   178         * @param    aEffectObserver reference to event observer object

   179         * @return   -

   180         */

   181         IMPORT_C CListenerLocation();

   182 

   183     protected:    // Friend classes

   184 

   185         friend class CListenerLocationMessageHandler;

   186 

   187     };

   188 

   189 #endif  // of CLISTENERLOCATION_H

   190 

   191 // End of File