epoc32/include/mdaaudioinputstream.h
branchSymbian3
changeset 4 837f303aceeb
parent 2 2fe1408b6811
     1.1 --- a/epoc32/include/mdaaudioinputstream.h	Wed Mar 31 12:27:01 2010 +0100
     1.2 +++ b/epoc32/include/mdaaudioinputstream.h	Wed Mar 31 12:33:34 2010 +0100
     1.3 @@ -2,9 +2,9 @@
     1.4  // Copyright (c) 2002-2009 Nokia Corporation and/or its subsidiary(-ies).
     1.5  // All rights reserved.
     1.6  // This component and the accompanying materials are made available
     1.7 -// 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
     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.symbianfoundation.org/legal/licencesv10.html".
    1.11 +// at the URL "http://www.eclipse.org/legal/epl-v10.html".
    1.12  //
    1.13  // Initial Contributors:
    1.14  // Nokia Corporation - initial contribution.
    1.15 @@ -149,23 +149,28 @@
    1.16  	        A callback to notify the client when the input stream has been initialised and is ready for 
    1.17  	        use. The caller must create a callback class which implements this interface.
    1.18  	@param  aPriority
    1.19 -	        This client's relative priority. This is a value between EMdaPriorityMin and EMdaPriorityMax and 
    1.20 -	        represents a relative priority. A higher value indicates a more important request.
    1.21 -	@param  aPref
    1.22 -	        The required behaviour if a higher priority client takes over the sound output device.
    1.23 +	        The Priority Value - this client's relative priority. This is a value between EMdaPriorityMin and 
    1.24 +	        EMdaPriorityMax and represents a relative priority. A higher value indicates a more important request.
    1.25 +    @param  aPref
    1.26 +            The Priority Preference - an additional audio policy parameter. The suggested default is 
    1.27 +            EMdaPriorityPreferenceNone. Further values are given by TMdaPriorityPreference, and additional 
    1.28 +            values may be supported by given phones and/or platforms, but should not be depended upon by 
    1.29 +            portable code.
    1.30  
    1.31  	@return A pointer to the audio input stream object.
    1.32  
    1.33 -	@capability MultimediaDD
    1.34 -	            A process requesting or using this method that has MultimediaDD capability will
    1.35 -				always have precedence over a process that does not have MultimediaDD.
    1.36 -	            
    1.37  	@capability	UserEnvironment
    1.38  			For recording - the requesting client process must have a 
    1.39  			UserEnvironment capability.
    1.40 +			
    1.41 +	Note: The Priority Value and Priority Preference are used primarily when deciding what to do when
    1.42 +	several audio clients attempt to play or record simultaneously. In addition to the Priority Value and Preference, 
    1.43 +	the adaptation may consider other parameters such as the SecureId and Capabilities of the client process. 
    1.44 +	Whatever, the decision 	as to what to do in such situations is up to the audio adaptation, and may
    1.45 +	vary between different phones. Portable applications are advised not to assume any specific behaviour. 
    1.46  	*/
    1.47  	IMPORT_C static CMdaAudioInputStream* NewL(MMdaAudioInputStreamCallback& aCallBack,
    1.48 -		TInt aPriority,	TMdaPriorityPreference aPref);
    1.49 +		TInt aPriority,	TInt aPref);
    1.50  
    1.51  	/**
    1.52      Destructor.
    1.53 @@ -244,19 +249,14 @@
    1.54  	This function cannot be used while the stream object is open. It is intended for use before an Open()
    1.55  	is issued, or between a previous Stop() and a new Open().
    1.56  
    1.57 -	@param  aPriority
    1.58 -	        The priority level to apply, EMdaPriorityMin means the client can be interrupted by any other client, EMdaPriorityNormal
    1.59 -	        means the client is only interrupted by clients with a higher priority and EMdaPriorityMax means the client cannot be interrupted by
    1.60 -	        other clients.
    1.61 -	@param  aPref
    1.62 -	        A set of priority values that define the behaviour to be adopted by a client using a sound device if a higher priority
    1.63 -	        client takes over that device.
    1.64 +    @param  aPriority
    1.65 +            The Priority Value.
    1.66 +    @param  aPref
    1.67 +            The Priority Preference.
    1.68  
    1.69 -	@capability MultimediaDD
    1.70 -	            A process requesting or using this method that has MultimediaDD capability will
    1.71 -				always have precedence over a process that does not have MultimediaDD.
    1.72 +    @see CMdaAudioInputStream::NewL()
    1.73  	*/
    1.74 -	IMPORT_C void SetPriority(TInt aPriority, TMdaPriorityPreference aPref);
    1.75 +	IMPORT_C void SetPriority(TInt aPriority, TInt aPref);
    1.76  
    1.77  	/**
    1.78  	Records streaming raw audio data.