1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/os/mm/mm_plat/audio_routing_api/inc/AudioOutput.h Fri Jun 15 03:10:57 2012 +0200
1.3 @@ -0,0 +1,180 @@
1.4 +/*
1.5 +* Copyright (c) 2006 Nokia Corporation and/or its subsidiary(-ies).
1.6 +* All rights reserved.
1.7 +* This component and the accompanying materials are made available
1.8 +* under the terms of "Eclipse Public License v1.0"
1.9 +* which accompanies this distribution, and is available
1.10 +* at the URL "http://www.eclipse.org/legal/epl-v10.html".
1.11 +*
1.12 +* Initial Contributors:
1.13 +* Nokia Corporation - initial contribution.
1.14 +*
1.15 +* Contributors:
1.16 +*
1.17 +* Description: This is the definition of the CAudioOutput class.
1.18 +*
1.19 +*/
1.20 +
1.21 +
1.22 +
1.23 +#ifndef AUDIOOUTPUT_H
1.24 +#define AUDIOOUTPUT_H
1.25 +
1.26 +// INCLUDES
1.27 +#include <e32base.h>
1.28 +#include <mdaaudiotoneplayer.h>
1.29 +#include <mdaaudiooutputstream.h>
1.30 +#include <midiclientutility.h>
1.31 +#include <MCustomInterface.h>
1.32 +
1.33 +// FORWARD DECLARATIONS
1.34 +class MAudioOutputObserver;
1.35 +class MCustomCommand;
1.36 +class CMdaAudioPlayerUtility;
1.37 +class CMdaAudioRecorderUtility;
1.38 +class CMMFDevSound;
1.39 +class CDrmPlayerUtility;
1.40 +class CVideoPlayerUtility;
1.41 +// CLASS DECLARATION
1.42 +
1.43 +/**
1.44 +* ?one_line_short_description.
1.45 +* ?other_description_lines
1.46 +*/
1.47 +class CAudioOutput : public CBase
1.48 + {
1.49 + public: // DATA TYPES
1.50 + enum TAudioOutputPreference
1.51 + {
1.52 + ENoPreference,
1.53 + EAll,
1.54 + ENoOutput,
1.55 + EPrivate,
1.56 + EPublic
1.57 + };
1.58 +
1.59 + public: // Constructors and destructor
1.60 +
1.61 + /**
1.62 + * Two-phased constructor.
1.63 + */
1.64 + IMPORT_C static CAudioOutput* NewL(CMdaAudioPlayerUtility& aUtility);
1.65 + /**
1.66 + * Factory function for creating audio output object.
1.67 + * @since 3.0
1.68 + * @param CMdaAudioRecorderUtility& - a reference to CMdaAudioRecorderUtility object
1.69 + * @return pointer to CAudioOutput object
1.70 + */
1.71 + IMPORT_C static CAudioOutput* CAudioOutput::NewL(CMdaAudioRecorderUtility& aUtility, TBool aRecordStream);
1.72 + /**
1.73 + * Factory function for creating audio output object.
1.74 + * @since 3.0
1.75 + * @param CMdaAudioOutputStream& - a reference to CMdaAudioOutputStream object
1.76 + * @return pointer to CAudioOutput object
1.77 + */
1.78 + IMPORT_C static CAudioOutput* CAudioOutput::NewL(CMdaAudioOutputStream& aUtility);
1.79 + /**
1.80 + * Factory function for creating audio output object.
1.81 + * @since 3.0
1.82 + * @param CMdaAudioToneUtility& - a reference to CMdaAudioToneUtility object
1.83 + * @return pointer to CAudioOutput object
1.84 + */
1.85 + IMPORT_C static CAudioOutput* CAudioOutput::NewL(CMdaAudioToneUtility& aUtility);
1.86 + /**
1.87 + * Factory function for creating audio output object.
1.88 + * @since 3.0
1.89 + * @param CMMFDevSound& - a reference to CMMFDevSound object
1.90 + * @return pointer to CAudioOutput object
1.91 + */
1.92 + IMPORT_C static CAudioOutput* CAudioOutput::NewL(CMMFDevSound& aDevSound);
1.93 + /**
1.94 + * Factory function for creating audio output object.
1.95 + * @since 3.0
1.96 + * @param MCustomInterface& - a reference to MCustomInterface object
1.97 + * @return pointer to CAudioOutput object
1.98 + */
1.99 + IMPORT_C static CAudioOutput* CAudioOutput::NewL(MCustomInterface& aUtility);
1.100 + /**
1.101 + * Factory function for creating audio output object.
1.102 + * @since 3.0
1.103 + * @param MCustomCommand& - a reference to MCustomCommand object
1.104 + * @return pointer to CAudioOutput object
1.105 + */
1.106 + IMPORT_C static CAudioOutput* CAudioOutput::NewL(MCustomCommand& aUtility);
1.107 + /**
1.108 + * Factory function for creating audio output object.
1.109 + * @since 3.0
1.110 + * @param CMidiClientUtility& - a reference to CMidiClientUtility object
1.111 + * @return pointer to CAudioOutput object
1.112 + */
1.113 + IMPORT_C static CAudioOutput* CAudioOutput::NewL(CMidiClientUtility& aUtility);
1.114 + /**
1.115 + * Factory function for creating audio output object.
1.116 + * @since 3.0
1.117 + * @param CDrmPlayerUtility& - a reference to CDrmPlayerUtility object
1.118 + * @return pointer to CAudioOutput object
1.119 + */
1.120 + IMPORT_C static CAudioOutput* /*CAudioOutput::*/NewL(CDrmPlayerUtility& aUtility);
1.121 +
1.122 + /**
1.123 + * Factory function for creating audio output object.
1.124 + * @since 3.2
1.125 + * @param CVideoPlayerUtility& - a reference to CVideoPlayerUtility object
1.126 + * @return pointer to CAudioOutput object
1.127 + */
1.128 + IMPORT_C static CAudioOutput* /*CAudioOutput::*/NewL(CVideoPlayerUtility& aUtility);
1.129 +
1.130 + /**
1.131 + * ?member_description.
1.132 + * @param ?arg1 ?description
1.133 + * @return ?description
1.134 + */
1.135 + virtual TAudioOutputPreference AudioOutput() = 0;
1.136 +
1.137 + /**
1.138 + * ?member_description.
1.139 + * @param ?arg1 ?description
1.140 + * @return ?description
1.141 + */
1.142 + virtual TAudioOutputPreference DefaultAudioOutput() = 0;
1.143 +
1.144 + /**
1.145 + * ?member_description.
1.146 + * @param ?arg1 ?description
1.147 + * @return ?description
1.148 + */
1.149 + virtual void RegisterObserverL( MAudioOutputObserver& aObserver ) = 0;
1.150 +
1.151 + /**
1.152 + * ?member_description.
1.153 + * @param ?arg1 ?description
1.154 + * @return ?description
1.155 + */
1.156 + virtual TBool SecureOutput() = 0;
1.157 +
1.158 + /**
1.159 + * ?member_description.
1.160 + * @param ?arg1 ?description
1.161 + * @return ?description
1.162 + */
1.163 + virtual void SetAudioOutputL( TAudioOutputPreference aAudioOutput = ENoPreference ) = 0;
1.164 +
1.165 + /**
1.166 + * ?member_description.
1.167 + * @param ?arg1 ?description
1.168 + * @return ?description
1.169 + */
1.170 + virtual void SetSecureOutputL( TBool aSecure = EFalse ) = 0;
1.171 +
1.172 + /**
1.173 + * ?member_description.
1.174 + * @param ?arg1 ?description
1.175 + * @return ?description
1.176 + */
1.177 + virtual void UnregisterObserver( MAudioOutputObserver& aObserver ) = 0;
1.178 +
1.179 + };
1.180 +
1.181 +#endif // CAUDIOOUTPUT_H
1.182 +
1.183 +// End of File