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 "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:  This is the definition of the source location effect class.

    15 *

    16 */

    17 

    18 

    19 #ifndef CSOURCELOCATION_H

    20 #define CSOURCELOCATION_H

    21 

    22 // INCLUDES

    23 

    24 #include <e32base.h>

    25 #include <LocationBase.h>

    26 #include <MCustomInterface.h>

    27 

    28 const TUid KUidSourceLocationEffect = {0x10203835};

    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 source location effect class for managing source location settings.

    48 *

    49 *  @lib SourceLocationEffect.lib

    50 *  @since 3.0

    51 */

    52 

    53 class CSourceLocation : public CLocation

    54     {

    55 

    56     public:     // Constructors and Destructor

    57 

    58         /**

    59         * Factory function for creating the Source location object.

    60         * @since 3.0

    61         * @param aUtility A reference to a convert utility

    62         * @return pointer to CSourceLocation object

    63         */

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

    65 

    66         /**

    67         * Factory function for creating the Source location object.

    68         * @since 3.0

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

    70         * @return pointer to CSourceLocation object

    71         */

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

    73 

    74         /**

    75         * Factory function for creating the Source location object.

    76         * @since 3.0

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

    78         * @return pointer to CSourceLocation object

    79         */

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

    81 

    82         /**

    83         * Factory function for creating the Source location object.

    84         * @since 3.0

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

    86         * @return pointer to CSourceLocation object

    87         */

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

    89 

    90         /**

    91         * Factory function for creating the Source 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 CSourceLocation object

    97         */

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

    99 

   100         /**

   101         * Factory function for creating the Source location object.

   102         * @since 3.0

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

   104         * @return pointer to CSourceLocation object

   105         */

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

   107 

   108         /**

   109         * Factory function for creating the Source location object.

   110         * @since 3.0

   111         * @param aDevSound A reference to a DevSound instance

   112         * @return pointer to CSourceLocation object

   113         */

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

   115 

   116         /**

   117         * Factory function for creating the Source location object.

   118         * @since 3.0

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

   120         * @return pointer to CSourceLocation object

   121         */

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

   123 

   124         /**

   125         * Factory function for creating the Source location object.

   126         * @since 3.0

   127         * @param aCustomInterface A reference to a custom interface

   128         * @return pointer to CSourceLocation object

   129         */

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

   131 

   132         /**

   133         * Factory function for creating the Source location object.

   134         * @since 3.0

   135         * @param aUtility A reference to a CMidiClientUtility

   136         * @return pointer to CSourceLocation object

   137         */

   138         IMPORT_C static CSourceLocation* NewL( CMidiClientUtility& aUtility );

   139 

   140         /**

   141         * Factory function for creating the Source location object.

   142         * @since 3.0

   143         * @param CDrmPlayerUtility A reference to a CDrmPlayerUtility object

   144         * @return pointer to CSourceLocation object

   145         */

   146         IMPORT_C static CSourceLocation* NewL( CDrmPlayerUtility& aUtility );

   147 

   148         /**

   149         * Factory function for creating the Source location object.

   150         * @since 3.2

   151         * @param CVideoPlayerUtility A reference to a CVideoPlayerUtility object

   152         * @return pointer to CSourceLocation object

   153         */

   154         IMPORT_C static CSourceLocation* NewL( CVideoPlayerUtility& aUtility );

   155 

   156         /**

   157         *

   158         * Destructor

   159         */

   160         IMPORT_C virtual ~CSourceLocation();

   161 

   162     public: // functions from base class

   163 

   164         /*

   165         * From CAudioEffect

   166         * Get the unique identifier of the audio effect

   167         * @since 3.0

   168         * @return Unique identifier

   169         */

   170         IMPORT_C TUid Uid() const;

   171 

   172     protected:

   173 

   174         /**

   175         * Private C++ constructor for this class.

   176         * @since    3.0

   177         * @param    aEffectObserver reference to event observer object

   178         * @return   -

   179         */

   180         IMPORT_C CSourceLocation();

   181 

   182     protected:    // Friend classes

   183 

   184         friend class CSourceLocationMessageHandler;

   185 

   186     };

   187 

   188 #endif  // of CSOURCELOCATION_H

   189 

   190 // End of File