os/mm/devsound/a3fdevsound/src/mmfdevsound/sounddevicebody.h
changeset 0 bde4ae8d615e
     1.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.2 +++ b/os/mm/devsound/a3fdevsound/src/mmfdevsound/sounddevicebody.h	Fri Jun 15 03:10:57 2012 +0200
     1.3 @@ -0,0 +1,574 @@
     1.4 +/*
     1.5 +* Copyright (c) 2006-2009 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:
    1.18 +*
    1.19 +*/
    1.20 +
    1.21 +
    1.22 +
    1.23 +#ifndef SOUNDDEVICEBODY_H
    1.24 +#define SOUNDDEVICEBODY_H
    1.25 +
    1.26 +//  INCLUDES
    1.27 +#include <mmf/server/sounddevice.h>
    1.28 +#include "mmfdevsoundproxy.h"
    1.29 +#include <mmf/server/mmfdevsoundcustominterfacesupport.h>
    1.30 +#include <mmf/server/mmfdevsoundcustominterface.h>
    1.31 +#include <a3f/mmfdevsoundcustominterfaceextensions.h>
    1.32 +#include "MmfDevSoundCIMuxUtility.h"
    1.33 +
    1.34 +/**
    1.35 +*  This is the Body for CMMFDevSound.
    1.36 +*
    1.37 +*  @lib MMFDevSound.lib
    1.38 +*/
    1.39 +
    1.40 +NONSHARABLE_CLASS( CMMFDevSound::CBody ) : public CBase,
    1.41 +										   public MMMFDevSoundCancelInitialize,
    1.42 +										   public MMMFDevSoundCustomInterfaceChannel,
    1.43 +										   public MMMFDevSoundCustomInterfaceObserver,
    1.44 +										   public MMMFDevSoundEmptyBuffers,
    1.45 +										   public MAutoPauseResumeSupport,
    1.46 +										   public MMMFDevSoundTimePlayed,
    1.47 +										   public MMMFDevSoundQueryIgnoresUnderflow,
    1.48 +										   public MAudioClientThreadInfo, 
    1.49 +										   public MMMFDevSoundTruePause
    1.50 +
    1.51 +	{
    1.52 +public:  // Constructors and destructor
    1.53 +
    1.54 +	/**
    1.55 +	* Factory function - returning instance of the class.
    1.56 +	*/
    1.57 +	static CBody* NewL();
    1.58 +
    1.59 +	/**
    1.60 +	* Destructor.
    1.61 +
    1.62 +	* Deletes all objects and releases all resources owned by this
    1.63 +	* instance.
    1.64 +	*/
    1.65 +	~CBody();
    1.66 +
    1.67 +	/**
    1.68 +	* Initializes to raw audio data PCM16 and Sampling Rate of 8 KHz.
    1.69 +	* On completion of Initialization, calls InitializeComplete() on
    1.70 +	* aDevSoundObserver.
    1.71 +	* @param aDevSoundObserver. A reference to DevSound observer instance.
    1.72 +	* @param aMode. Mode for which this object will be used.
    1.73 +	*/
    1.74 +	void InitializeL(MDevSoundObserver& aDevSoundObserver,
    1.75 +	                 TMMFState aMode);
    1.76 +
    1.77 +	/**
    1.78 +	* Initializes DevSound object for the mode aMode for processing audio
    1.79 +	* data with hardware device supporting FourCC aDesiredFourCC.
    1.80 +	* @param  aDevSoundObserver. A reference to DevSound observer instance.
    1.81 +	* @param  aDesiredFourCC. The CMMFHwDevice implementation FourCC code.
    1.82 +	* @param  aMode. The mode for which this object will be used
    1.83 +	*/
    1.84 +	void InitializeL(MDevSoundObserver& aDevSoundObserver,
    1.85 +	                 TFourCC aDesiredFourCC,
    1.86 +	                 TMMFState aMode);
    1.87 +
    1.88 +	/**
    1.89 +	* Returns the supported Audio settings ie. encoding, sample rates,
    1.90 +	* mono/stereo operation, buffer size etc..
    1.91 +	* @return TMMFCapabilities. The device settings.
    1.92 +	*/
    1.93 +	inline TMMFCapabilities Capabilities();
    1.94 +
    1.95 +	/**
    1.96 +	* Returns the current device configuration.
    1.97 +	* @return TMMFCapabilities. The device settings.
    1.98 +	*/
    1.99 +	inline TMMFCapabilities Config() const;
   1.100 +
   1.101 +	/**
   1.102 +	* Configure CMMFDevSound object with the settings in aConfig. Use this
   1.103 +	* to set sampling rate, encoding and mono/stereo.
   1.104 +	* @param aConfig. The attribute values to which CMMFDevSound object will be configured to.
   1.105 +	*/
   1.106 +	inline void SetConfigL(const TMMFCapabilities& aCaps);
   1.107 +
   1.108 +	/**
   1.109 +	* Returns an integer representing the maximum volume device supports.
   1.110 +	* This is the maximum value which can be passed to
   1.111 +	* CMMFDevSound::SetVolume.
   1.112 +	* @return TInt The maximum volume. This value is platform dependent but is always greater than or equal to one.
   1.113 +	*/
   1.114 +	inline TInt MaxVolume();
   1.115 +
   1.116 +	/**
   1.117 +	* Returns an integer representing the current volume.
   1.118 +	* @return TInt The current volume level.
   1.119 +	*/
   1.120 +	inline TInt Volume();
   1.121 +
   1.122 +	/**
   1.123 +	* Changes the current playback volume to a specified value. The volume
   1.124 +	* can be changed before or during playback and is effective immediately.
   1.125 +	* @param aVolume. The volume setting. This can be any value from 0
   1.126 +	*        to the value returned by a call to
   1.127 +	*        CMMFDevSound::MaxVolume(). If the volume is not
   1.128 +	*        within this range, the volume is automatically set
   1.129 +	*        to minimum or maximum value based on the value
   1.130 +	*        that is being passed. Setting a zero value mutes
   1.131 +	*        the sound. Setting the maximum value results in
   1.132 +	*        the loudest possible sound.
   1.133 +	*/
   1.134 +	inline void SetVolume(TInt aVolume);
   1.135 +
   1.136 +	/**
   1.137 +	* Returns an integer representing the maximum gain the device supports.
   1.138 +	* This is the maximum value which can be passed to CMMFDevSound::SetGain
   1.139 +	* @return TInt The maximum gain. This value is platform dependent but is
   1.140 +	*        always greater than or equal to one.
   1.141 +	*/
   1.142 +	inline TInt MaxGain();
   1.143 +
   1.144 +	/**
   1.145 +	* Returns an integer representing the current gain.
   1.146 +	* @return TInt The current gain level.
   1.147 +	*/
   1.148 +	inline TInt Gain();
   1.149 +
   1.150 +	/**
   1.151 +	* Changes the current recording gain to a specified value. The gain can
   1.152 +	* be changed before or during recording and is effective immediately.
   1.153 +	* @param aGain. The gain setting. This can be any value from zero to
   1.154 +	*        the value returned by a call to
   1.155 +	*        CMMFDevSound::MaxGain(). If the volume
   1.156 +	*        is not within this range, the gain is automatically
   1.157 +	*        set to minimum or maximum value based on the value
   1.158 +	*        that is being passed. Setting a zero value mutes the
   1.159 +	*        sound. Setting the maximum value results in the
   1.160 +	*        loudest possible sound.
   1.161 +	*/
   1.162 +	inline void SetGain(TInt aGain);
   1.163 +
   1.164 +	/**
   1.165 +	* Returns the speaker balance set for playing.
   1.166 +	* @param aLeftPercentage. On return contains the left speaker volume percentage.
   1.167 +	* @param aRightPercentage. On return contains the right speaker volume percentage.
   1.168 +	*/
   1.169 +	inline void GetPlayBalanceL(TInt& aLeftPercentage,TInt& aRightPercentage);
   1.170 +
   1.171 +	/**
   1.172 +	* Sets the speaker balance for playing. The speaker balance can be
   1.173 +	* changed before or during playback and is effective immediately.
   1.174 +	* @param aLeftPercentage. The left speaker volume percentage. This
   1.175 +	*        can be any value from zero to 100. Setting
   1.176 +	*        a zero value mutes the sound on left
   1.177 +	*        speaker.
   1.178 +	* @param aRightPercentage. The right speaker volume percentage.
   1.179 +	*        This can be any value from zero to 100.
   1.180 +	*        Setting a zero value mutes the sound on
   1.181 +	*        right speaker.
   1.182 +	*/
   1.183 +	inline void SetPlayBalanceL(TInt aLeftPercentage,
   1.184 +	                            TInt aRightPercentage);
   1.185 +
   1.186 +	/**
   1.187 +	* Returns the microphone gain balance set for recording.
   1.188 +	* @param aLeftPercentage On return contains the left microphone
   1.189 +	*        gain percentage.
   1.190 +	* @param aRightPercentage On return contains the right microphone
   1.191 +	*        gain percentage.
   1.192 +	*/
   1.193 +	inline void GetRecordBalanceL(TInt& aLeftPercentage, TInt& aRightPercentage);
   1.194 +
   1.195 +	/**
   1.196 +	* Sets the microphone balance for recording. The microphone balance can
   1.197 +	* be changed before or during recording and is effective immediately.
   1.198 +	* @param aLeftPercentage. The left microphone gain percentage. This
   1.199 +	*        can be any value from zero to 100. Setting
   1.200 +	*        a zero value mutes the sound from left
   1.201 +	*        microphone.
   1.202 +	* @param aRightPercentage. The right microphone gain percentage.
   1.203 +	*        This can be any value from zero to 100.
   1.204 +	*        Setting a zero value mutes the sound from
   1.205 +	*        right microphone.
   1.206 +	*/
   1.207 +	inline void SetRecordBalanceL(TInt aLeftPercentage,
   1.208 +	                              TInt aRightPercentage);
   1.209 +
   1.210 +	/**
   1.211 +	* Initializes the audio device and starts the play process. This
   1.212 +	* function queries and acquires the audio policy before initializing
   1.213 +	* audio device. If there was an error during policy initialization,
   1.214 +	* PlayError() function will be called on the observer with error code
   1.215 +	* KErrAccessDenied, otherwise BufferToBeFilled() function will be called
   1.216 +	* with a buffer reference. After reading data into the buffer reference
   1.217 +	* passed, the client should call PlayData() to play data.
   1.218 +	* The amount of data that can be played is specified in
   1.219 +	* CMMFBuffer::RequestSize(). Any data that is read into buffer beyond
   1.220 +	* this size will be ignored.
   1.221 +	*/
   1.222 +	inline void PlayInitL();
   1.223 +
   1.224 +	/**
   1.225 +	* Initializes the audio device and starts the record process. This
   1.226 +	* function queries and acquires the audio policy before initializing
   1.227 +	* audio device. If there was an error during policy initialization,
   1.228 +	* RecordError() function will be called on the observer with error code
   1.229 +	* KErrAccessDenied, otherwise BufferToBeEmptied() function will be
   1.230 +	* called with a buffer reference. This buffer contains recorded or
   1.231 +	* encoded data. After processing data in the buffer reference passed,
   1.232 +	* the client should call RecordData() to continue recording process.
   1.233 +	* The amount of data that is available is specified in
   1.234 +	* CMMFBuffer::RequestSize().
   1.235 +	*/
   1.236 +	inline void RecordInitL();
   1.237 +
   1.238 +	/**
   1.239 +	* Plays data in the buffer at the current volume.
   1.240 +	* The client should fill the buffer with audio data before calling this
   1.241 +	* function. The observer gets a reference to the buffer along with the
   1.242 +	* callback function BufferToBeFilled(). When playing of the audio sample
   1.243 +	* is complete, successfully or otherwise, the function PlayError() on
   1.244 +	* the observer is called.
   1.245 +	* The last buffer of the audio stream being played should have the last
   1.246 +	* buffer flag set using CMMFBuffer::SetLastBuffer(TBool). If a
   1.247 +	* subsequent attempt to play the clip is made, this flag will need
   1.248 +	* resetting by the client.
   1.249 +	*/
   1.250 +	inline void PlayData();
   1.251 +
   1.252 +	/**
   1.253 +	* Contine the process of recording.
   1.254 +	* Once the buffer is filled with recorded data, the Observer gets a
   1.255 +	* reference to the buffer along with the callback function
   1.256 +	* BufferToBeEmptied(). After processing the buffer (copying over to a
   1.257 +	* different buffer or writing to file) the client should call this
   1.258 +	* function to continue the recording process.
   1.259 +	*/
   1.260 +	inline void RecordData();
   1.261 +
   1.262 +	/**
   1.263 +	* Stops the ongoing operation (Play, Record, TonePlay).
   1.264 +	*/
   1.265 +	inline void Stop();
   1.266 +
   1.267 +	/**
   1.268 +	* Temporarily Stops the ongoing operation (Play, Record, TonePlay).
   1.269 +	*/
   1.270 +	inline void Pause();
   1.271 +
   1.272 +	/**
   1.273 +	* Returns the Sample recorded so far
   1.274 +	* @return TInt Returns the samples recorded.
   1.275 +	*/
   1.276 +	inline TInt SamplesRecorded();
   1.277 +
   1.278 +	/**
   1.279 +	* Returns the Sample played so far
   1.280 +	* @return TInt Returns the samples played.
   1.281 +	*/
   1.282 +	inline TInt SamplesPlayed();
   1.283 +
   1.284 +	/**
   1.285 +	* Initializes the audio device and starts playing a tone. The tone is
   1.286 +	* played with the frequency and duration specified.
   1.287 +	* Leaves on failure.
   1.288 +	* @param aFrequency. The frequency at which the tone will be played.
   1.289 +	* @param const TTimeIntervalMicroSeconds &aDuration The period over
   1.290 +	*        which the tone will be played. A zero value causes the no tone
   1.291 +	*        to be played.
   1.292 +	*/
   1.293 +	inline void PlayToneL(TInt aFrequency, const TTimeIntervalMicroSeconds& aDuration);
   1.294 +
   1.295 +	/**
   1.296 +	* Initializes audio device and starts playing a dual tone. Dual Tone is
   1.297 +	* played with the specified frequencies and for the specified duration.
   1.298 +	* @param aFrequencyOne The first frequency of dual tone.
   1.299 +	* @param aFrequencyTwo The second frequency of dual tone.
   1.300 +	* @param aDuration The period over which the tone will be played. 
   1.301 +	* A zero value causes the no tone to be played.
   1.302 +	*/
   1.303 +	inline void PlayDualToneL(
   1.304 +	            TInt aFrequencyOne,
   1.305 +	            TInt aFrequencyTwo,
   1.306 +	            const TTimeIntervalMicroSeconds& aDuration);
   1.307 +
   1.308 +	/**
   1.309 +	* Initializes the audio device and starts playing the DTMF string
   1.310 +	* aDTMFString.
   1.311 +	* @param aDTMFString The DTMF sequence in a descriptor.
   1.312 +	*/
   1.313 +	inline void PlayDTMFStringL(const TDesC& aDTMFString);
   1.314 +
   1.315 +	/**
   1.316 +	* Initializes the audio device and starts playing a tone sequence.
   1.317 +	* @param aData The tone sequence in a descriptor.
   1.318 +	*/
   1.319 +	inline void PlayToneSequenceL(const TDesC8& aData);
   1.320 +
   1.321 +	/**
   1.322 +	* Defines the number of times the audio is to be repeated during the
   1.323 +	* tone playback operation. A period of silence can follow each playing
   1.324 +	* of a tone. The tone playing can be repeated indefinitely
   1.325 +	* @param aRepeatCount. The number of times the tone, together with
   1.326 +	*        the trailing silence, is to be repeated. If this is set to
   1.327 +	*        KMdaRepeatForever, then the tone, together with the trailing
   1.328 +	*        silence, is repeated indefinitely or until Stop() is called.
   1.329 +	*        If this is set to zero, then the tone is not repeated.
   1.330 +	* @param aRepeatTrailingSilence An interval of silence which will be played after each tone.
   1.331 +	*        Supported only during tone playing.
   1.332 +	*/
   1.333 +	inline void SetToneRepeats(
   1.334 +	            TInt aRepeatCount,
   1.335 +	            const TTimeIntervalMicroSeconds& aRepeatTrailingSilence);
   1.336 +
   1.337 +	/**
   1.338 +	* Defines the duration of tone on, tone off and tone pause to be used
   1.339 +	* during the DTMF tone playback operation.
   1.340 +	* Supported only during tone playing.
   1.341 +	* @param aToneOnLength The period over which the tone will be played.
   1.342 +	* If this is set to zero, then the tone is not played.
   1.343 +	* @param aToneOffLength The period over which the no tone will be played.
   1.344 +	* @param aPauseLength The period over which the tone playing will be paused.
   1.345 +	*/
   1.346 +	inline void SetDTMFLengths(
   1.347 +	            TTimeIntervalMicroSeconds32& aToneOnLength,
   1.348 +	            TTimeIntervalMicroSeconds32& aToneOffLength,
   1.349 +	            TTimeIntervalMicroSeconds32& aPauseLength);
   1.350 +
   1.351 +	/**
   1.352 +	* Defines the period over which the volume level is to rise smoothly
   1.353 +	* from nothing to the normal volume level.
   1.354 +	* The function is only available before playing.
   1.355 +	* @param aRampDuration The period over which the volume is to rise. 
   1.356 +	* 	 A zero value causes the tone sample to be played at the 
   1.357 +	* 	 normal level for the full duration of the playback. 
   1.358 +	* 	 A value, which is longer than the duration of
   1.359 +	*        the tone sample means that the sample never reaches its normal
   1.360 +	*        volume level.
   1.361 +	*/
   1.362 +	inline void SetVolumeRamp(
   1.363 +	            const TTimeIntervalMicroSeconds& aRampDuration);
   1.364 +
   1.365 +	/**
   1.366 +	* Defines the priority settings that should be used for this instance.
   1.367 +	* @param aPrioritySettings. A class type representing the client's priority, 
   1.368 +	* priority preference and state
   1.369 +	*/
   1.370 +	inline void SetPrioritySettings(
   1.371 +	            const TMMFPrioritySettings& aPrioritySettings);
   1.372 +
   1.373 +	/**
   1.374 +	* Retrieves a custom interface to the device.
   1.375 +	* @param aInterfaceId. The interface UID, defined with the custom
   1.376 +	*        interface.
   1.377 +	* @return TAny* A pointer to the interface implementation, or NULL if
   1.378 +	*        the device does not implement the interface requested. The
   1.379 +	*        return value must be cast to the correct type by the user.
   1.380 +	*/
   1.381 +	TAny* CustomInterface(TUid aInterfaceId);
   1.382 +
   1.383 +	/**
   1.384 +	* Returns a list of the supported input datatypes that can be sent to
   1.385 +	* DevSound for playing audio. The datatypes returned are those that the
   1.386 +	* DevSound supports given the priority settings passed in
   1.387 +	* aPrioritySettings. Note that if no supported data types are found this
   1.388 +	* does not constitute failure, the function will return normally with no
   1.389 +	* entries in aSupportedDataTypes.
   1.390 +	* @param aSupportedDataTypes The array of supported
   1.391 +	*        data types that will be filled in by this function. The
   1.392 +	*        supported data types of the DevSound are in the form of an
   1.393 +	*        array of TFourCC codes. Any existing entries in the array will
   1.394 +	*        be overwritten on calling this function. If no supported data
   1.395 +	*        types are found given the priority settings, then the
   1.396 +	*        aSupportedDatatypes array will have zero entries.
   1.397 +	* @param aPrioritySettings The priority settings used to determine the 
   1.398 +	* 	 supported datatypes. Note this does not set the priority settings. 
   1.399 +	* 	 For input datatypes the iState member of the priority settings would 
   1.400 +	* 	 be expected to be either EMMFStatePlaying or EMMFStatePlayingRecording.
   1.401 +	* 	 The priority settings may effect the supported datatypes depending
   1.402 +	*        on the audio routing.
   1.403 +	*/
   1.404 +	inline void GetSupportedInputDataTypesL(
   1.405 +	            RArray<TFourCC>& aSupportedDataTypesconst,
   1.406 +	            const TMMFPrioritySettings& aPrioritySettings) const;
   1.407 +
   1.408 +	/**
   1.409 +	* Returns a list of the supported output dataypes that can be received
   1.410 +	* from DevSound for recording audio. The datatypes returned are those
   1.411 +	* that the DevSound supports given the priority settings passed in
   1.412 +	* aPrioritySettings. Note that if no supported data types are found this
   1.413 +	* does not constitute failure, the function will return normally with no
   1.414 +	* entries in aSupportedDataTypes.
   1.415 +	* @param aSupportedDataTypes. The array of supported
   1.416 +	*        data types that will be filled in by this function. The
   1.417 +	*        supported datatypes of the DevSound are in the form of an array
   1.418 +	*        of TFourCC codes. Any existing entries in the array will be
   1.419 +	*        overwritten on calling this function. If no supported datatypes
   1.420 +	*        are found given the priority settings, then the
   1.421 +	*        aSupportedDatatypes array will have zero entries.
   1.422 +	* @param aPrioritySettings. The priority settings used to determine the supported 
   1.423 +	*        data types. Note this does not set the priority settings. For output data types the
   1.424 +	*        iState member of the priority settings would expected to be
   1.425 +	*        either EMMFStateRecording or EMMFStatePlayingRecording. The
   1.426 +	*        priority settings may effect the supported datatypes depending
   1.427 +	*        on the audio routing.
   1.428 +	*/
   1.429 +	inline void GetSupportedOutputDataTypesL(
   1.430 +	            RArray<TFourCC>& aSupportedDataTypes,
   1.431 +	            const TMMFPrioritySettings& aPrioritySettings) const;
   1.432 +	            
   1.433 +	/** 
   1.434 +	Registers the client for notification of resource avalibility.
   1.435 +
   1.436 +	@param  aEventType
   1.437 +	        The Notification event type for which the client needs notification.
   1.438 +	@param  aNotificationRegistrationData
   1.439 +	        The Notification Registration data has been reserved for future use and its value should be always NULL
   1.440 +	@return An error code indicating if the function call was successful. KErrNone on success, 
   1.441 +			KErrNotSupported if the event type is not supported, KErrArgument if the notification data
   1.442 +			is not null otherwise another of the system-wide error codes.
   1.443 +	*/
   1.444 +	inline TInt RegisterAsClient(TUid aEventType, const TDesC8& aNotificationRegistrationData = KNullDesC8);
   1.445 +
   1.446 +	/**
   1.447 +	Cancels the Registered Notification.
   1.448 +
   1.449 +	@param  aEventType. The Event type need to cancel
   1.450 +	@return An error code indicating if the function call was successful. KErrNone on success, KErrNotSupported
   1.451 +			if the event type is not supported otherwise another of the system-wide error codes.
   1.452 +	*/	
   1.453 +	inline TInt CancelRegisterAsClient(TUid aEventType);
   1.454 +
   1.455 +	/**
   1.456 +	Returns the Notification data which the client needs to resume playing.
   1.457 +
   1.458 +	@param aEventType. The Event type for which to get notification data  
   1.459 +	@param aNotificationData
   1.460 +			The reference data for which the client needs to resume the play. The actual data depends on the event type.
   1.461 +			Note that for the event type 'KMMFEventCategoryAudioResourceAvailable' the package buffer returned
   1.462 +			is TMMFTimeIntervalMicroSecondsPckg,but the contents should be converted to an integer and
   1.463 +			interpreted as the data returned is samples played ,but not as a microsecond value.
   1.464 +	@return An error code indicating if the function call was successful. KErrNone on success, otherwise
   1.465 +	        another of the system-wide error codes.
   1.466 +	*/
   1.467 +	inline TInt GetResourceNotificationData(TUid aEventType,TDes8& aNotificationData);
   1.468 +
   1.469 +	/**
   1.470 +	Wait for the clients to resume play back even after the default timeout expires.
   1.471 +	Unless the client cancels the notification request or completes no other client gets
   1.472 +	notification.
   1.473 +
   1.474 +	@return An error code indicating if the function call was successful. KErrNone on success, 
   1.475 +	        otherwise another of the system-wide error codes.
   1.476 +	*/
   1.477 +	inline TInt WillResumePlay();
   1.478 +
   1.479 +	/**
   1.480 +	Empties the play buffers below DevSound without causing the codec to be deleted.
   1.481 +
   1.482 +	@return An error code indicating if the function call was successful. KErrNone on success,
   1.483 +			KErrNotSupported if called in a mode other than EMMFStatePlaying or if the function is otherwise not supported,
   1.484 +			KErrNotReady if this is called before playing,
   1.485 +			otherwise another of the system-wide error codes.
   1.486 +			If this function is not supported, it is advised to use Stop().
   1.487 +	*/
   1.488 +	inline TInt EmptyBuffers();
   1.489 +	
   1.490 +	//from MMMFDevSoundCancelInitialize
   1.491 +	/** 
   1.492 +		
   1.493 +	Cancels the initialization process of a CMMFDevSound object
   1.494 +
   1.495 +	@return An error code indicating if the function call was successful. 
   1.496 +			KErrNone on success,
   1.497 +			KerrNotReady if this is called before InitializeL() call or after      
   1.498 +			the object has been initialized 
   1.499 +	*/
   1.500 +	inline TInt CancelInitialize();
   1.501 +
   1.502 +	// from MMMFDevSoundCustomInterfaceChannel
   1.503 +	/**
   1.504 +	Implements a synchronous custom command
   1.505 +	@param aUid
   1.506 +		   The UID of the custom command
   1.507 +	@param aParam1
   1.508 +		   A buffer of data to be supplied to the receiver
   1.509 +	@param aParam2
   1.510 +		   A buffer of data to be supplied to the receiver
   1.511 +	@param aOutParam
   1.512 +		   A buffer that will be written into by the receiver
   1.513 +		   and returned to the client
   1.514 +	@return the result of the custom command
   1.515 +	 */
   1.516 +	TInt SyncCustomCommand(TUid aUid, const TDesC8& aParam1, const TDesC8& aParam2, TDes8* aOutParam);
   1.517 +
   1.518 +	/**
   1.519 +	Implements an asynchronous custom command
   1.520 +	@param aUid
   1.521 +		   The UID of the custom command
   1.522 +	@param aStatus
   1.523 +		   The request status of the active object that
   1.524 +		   will be called upon the completion of the request
   1.525 +	@param aParam1
   1.526 +		   A buffer of data to be supplied to the receiver
   1.527 +	@param aParam2
   1.528 +		   A buffer of data to be supplied to the receiver
   1.529 +	@param aOutParam
   1.530 +		   A buffer that will be written into by the receiver
   1.531 +		   and returned to the client
   1.532 +	 */
   1.533 +	void AsyncCustomCommand(TUid aUid, TRequestStatus& aStatus, const TDesC8& aParam1, const TDesC8& aParam2, TDes8* aOutParam);
   1.534 +
   1.535 +	//from MMMFDevSoundCustomInterfaceObserver
   1.536 +	void CloseCustomInterface(TInt aInterfaceId);
   1.537 +
   1.538 +	//from MMMFDevSoundTimePlayed
   1.539 +	TInt GetTimePlayed(TTimeIntervalMicroSeconds& aTime);
   1.540 +	
   1.541 +	//MMMFDevSoundQueryIgnoresUnderflow
   1.542 +	TBool QueryIgnoresUnderflow();
   1.543 +	
   1.544 +	// Set the real client thread with thread Id
   1.545 +	TInt SetClientThreadInfo(TThreadId aTid);
   1.546 +
   1.547 +	// from MMMFDevSoundTruePause
   1.548 +	TBool IsResumeSupported();
   1.549 +	TInt Resume();
   1.550 +protected:
   1.551 +
   1.552 +	/**
   1.553 +	* Constructor
   1.554 +	*/
   1.555 +	CBody();
   1.556 +
   1.557 +	/**
   1.558 +	* Symbian constructor
   1.559 +	*/
   1.560 +	void ConstructL();
   1.561 +
   1.562 +	TInt FindCustomInterface(TUid aInterfaceId);
   1.563 +
   1.564 +	// custom interface storage
   1.565 +	RArray<TMMFDevSoundCustomInterfaceData> iCustomInterfaceArray;
   1.566 +	CMMFDevSoundCIMuxUtility* iMuxUtility;
   1.567 +	// Reference to DevSound proxy
   1.568 +	RMMFDevSoundProxy* iDevSoundProxy;
   1.569 +	// CI Extension
   1.570 +	MDevSoundCIClientExtension* iCIExtension;
   1.571 +	};
   1.572 +
   1.573 +#include "sounddevicebody.inl"
   1.574 +
   1.575 +#endif // SOUNDDEVICEBODY_H
   1.576 +
   1.577 +// End of File