devsound/a3fdevsound/src/mmfdevsoundserver/mmfdevsoundsession.h
changeset 6 fe9d1bf55678
parent 0 b8ed18f6c07b
equal deleted inserted replaced
5:b220a9341636 6:fe9d1bf55678
   558 		@return void
   558 		@return void
   559 	*/
   559 	*/
   560 	void DoAlreadyCompletedPlayToneSequenceL();
   560 	void DoAlreadyCompletedPlayToneSequenceL();
   561 
   561 
   562 	/**
   562 	/**
   563 		Method to service signal DevSound to play fixed sequence operation
       
   564 		request.
       
   565 		Leaves on failure.
       
   566 		@since 
       
   567 		@param const RMmfIpcMessage& aMessage A reference to message object
       
   568 			containing request attributes.
       
   569 		@return ETrue if the request is serviced completely else EFalse.
       
   570 	*/
       
   571 	TBool DoPlayFixedSequenceL(const RMmfIpcMessage& aMessage);
       
   572 
       
   573 	/**
       
   574 		Method to service signal DevSound to play fixed sequence operation
       
   575 		request that has already completed, but not finished due to a
       
   576 		pre-emption clash during its commit cycle(s).
       
   577 		Leaves on failure.
       
   578 		@return void
       
   579 	*/
       
   580 	void DoAlreadyCompletedPlayFixedSequenceL();
       
   581 
       
   582 	/**
       
   583 		Method to service signal DevSound to initilize DTMF String operation
   563 		Method to service signal DevSound to initilize DTMF String operation
   584 		request.
   564 		request.
   585 		Leaves on failure.
   565 		Leaves on failure.
   586 		@since 
   566 		@since 
   587 		@param const RMmfIpcMessage& aMessage A reference to message object
   567 		@param const RMmfIpcMessage& aMessage A reference to message object
   660 		@param const RMmfIpcMessage& aMessage A reference to message object
   640 		@param const RMmfIpcMessage& aMessage A reference to message object
   661 			containing request attributes.
   641 			containing request attributes.
   662 		@return ETrue if the request is serviced completely else EFalse.
   642 		@return ETrue if the request is serviced completely else EFalse.
   663 	*/
   643 	*/
   664 	TBool DoSetPrioritySettingsL(const RMmfIpcMessage& aMessage);
   644 	TBool DoSetPrioritySettingsL(const RMmfIpcMessage& aMessage);
   665 
       
   666 	/**
       
   667 		Method to service the request querrying fixed sequence name.
       
   668 		Leaves on failure.
       
   669 		@since 
       
   670 		@param const RMmfIpcMessage& aMessage A reference to message object
       
   671 			containing request attributes.
       
   672 		@return ETrue if the request is serviced completely else EFalse.
       
   673 	*/
       
   674 	TBool DoFixedSequenceNameL(const RMmfIpcMessage& aMessage);
       
   675 
       
   676 	/**
       
   677 		Method to service the request querrying fixed sequence count.
       
   678 		Leaves on failure.
       
   679 		@since 
       
   680 		@param const RMmfIpcMessage& aMessage A reference to message object
       
   681 			containing request attributes.
       
   682 		@return ETrue if the request is serviced completely else EFalse.
       
   683 	*/
       
   684 	TBool DoFixedSequenceCountL(const RMmfIpcMessage& aMessage);
       
   685 
   645 
   686 	/**
   646 	/**
   687 		Method to service the request querrying supported output data types.
   647 		Method to service the request querrying supported output data types.
   688 		Leaves on failure.
   648 		Leaves on failure.
   689 		@since 
   649 		@since 
  1104 		@return void
  1064 		@return void
  1105 	*/
  1065 	*/
  1106 	void PlayToneSequenceL(const TDesC8& aData);
  1066 	void PlayToneSequenceL(const TDesC8& aData);
  1107 
  1067 
  1108 	/**
  1068 	/**
  1109 		Initializes the audio device and starts playing the specified
       
  1110 		pre-defined tone sequence.
       
  1111 		Leaves on failure.
       
  1112 		@since 
       
  1113 		@param TInt aSequenceNumber The index identifying the specific
       
  1114 			pre-defined tone sequence. Index values are relative to zero.
       
  1115 			This can be any value from zero to the value returned by a call
       
  1116 			to FixedSequenceCount() - 1. The function raises a panic if the
       
  1117 			sequence number is not within this range.
       
  1118 		@return void
       
  1119 	*/
       
  1120 	void PlayFixedSequenceL(TInt aSequenceNumber);
       
  1121 
       
  1122 	/**
       
  1123 		Defines the number of times the audio is to be repeated during the
  1069 		Defines the number of times the audio is to be repeated during the
  1124 		tone playback operation. A period of silence can follow each playing
  1070 		tone playback operation. A period of silence can follow each playing
  1125 		of a tone. The tone playing can be repeated indefinitely
  1071 		of a tone. The tone playing can be repeated indefinitely
  1126 		@since 
  1072 		@since 
  1127 		@param TInt aRepeatCount The number of times the tone, together with
  1073 		@param TInt aRepeatCount The number of times the tone, together with
  1188 		@return   "TAny"
  1134 		@return   "TAny"
  1189 			Custom interface implementation. The exact type of pointer is
  1135 			Custom interface implementation. The exact type of pointer is
  1190 			dependent on the custom interface implemenation.
  1136 			dependent on the custom interface implemenation.
  1191 	*/
  1137 	*/
  1192 	virtual TAny* CustomInterface(TUid aInterfaceId);
  1138 	virtual TAny* CustomInterface(TUid aInterfaceId);
  1193 
       
  1194 	/**
       
  1195 		Returns the number of available pre-defined tone sequences.
       
  1196 		This is the number of fixed sequence supported by DevSound by default.
       
  1197 		@since 
       
  1198 		@return TInt  The fixed sequence count. This value is implementation
       
  1199 			dependent.
       
  1200 	*/
       
  1201 	TInt FixedSequenceCount();
       
  1202 
       
  1203 	/**
       
  1204 		Returns the name assigned to a specific pre-defined tone sequence.
       
  1205 		This is the number of the fixed sequence supported by DevSound by
       
  1206 		default.
       
  1207 		The function raises a panic if sequence number specified is invalid.
       
  1208 		@since 
       
  1209 		@param TInt aSequenceNumber The index identifying the specific
       
  1210 			pre-defined tone sequence. Index values are relative to zero.
       
  1211 			This can be any value from zero to the value returned by a call
       
  1212 			to CMdaAudioPlayerUtility::FixedSequenceCount() - 1. The
       
  1213 			function raises a panic if sequence number is not within this
       
  1214 			range.
       
  1215 		@return const TDesC & A reference to a Descriptor containing the fixed
       
  1216 			sequence name indexed by aSequenceNumber.
       
  1217 	*/
       
  1218 	const TDesC& FixedSequenceName(TInt aSequenceNumber);
       
  1219 
  1139 
  1220 	/**
  1140 	/**
  1221 		Returns a list of the supported input datatypes that can be sent to
  1141 		Returns a list of the supported input datatypes that can be sent to
  1222 		DevSound for playing audio. The datatypes returned are those that the
  1142 		DevSound for playing audio. The datatypes returned are those that the
  1223 		DevSound supports given the priority settings passed in
  1143 		DevSound supports given the priority settings passed in