devsound/a3fdevsound/src/mmfdevsoundproxy/mmfdevsoundproxy.h
changeset 6 fe9d1bf55678
parent 0 b8ed18f6c07b
equal deleted inserted replaced
5:b220a9341636 6:fe9d1bf55678
   421 	* @return void
   421 	* @return void
   422 	*/
   422 	*/
   423 	IMPORT_C void PlayToneSequenceL(const TDesC8& aData);
   423 	IMPORT_C void PlayToneSequenceL(const TDesC8& aData);
   424 
   424 
   425 	/**
   425 	/**
   426 	* Initializes the audio device and starts playing the specified
       
   427 	* pre-defined tone sequence.
       
   428 	* Leaves on failure.
       
   429 	* @since 
       
   430 	* @param TInt aSequenceNumber The index identifying the specific
       
   431 	*        pre-defined tone sequence. Index values are relative to zero.
       
   432 	*        This can be any value from zero to the value returned by a call
       
   433 	*        to FixedSequenceCount() - 1. The function raises a panic if the
       
   434 	*        sequence number is not within this range.
       
   435 	* @return void
       
   436 	*/
       
   437 	IMPORT_C void PlayFixedSequenceL(TInt aSequenceNumber);
       
   438 
       
   439 	/**
       
   440 	* Defines the duration of tone on, tone off and tone pause to be used
   426 	* Defines the duration of tone on, tone off and tone pause to be used
   441 	* during the DTMF tone playback operation.
   427 	* during the DTMF tone playback operation.
   442 	* Supported only during tone playing.
   428 	* Supported only during tone playing.
   443 	* @since 
   429 	* @since 
   444 	* @param TTimeIntervalMicroSeconds32 &aToneOnLength The period over
   430 	* @param TTimeIntervalMicroSeconds32 &aToneOnLength The period over
   570 	*/
   556 	*/
   571 	IMPORT_C void SetPrioritySettings(
   557 	IMPORT_C void SetPrioritySettings(
   572 	              const TMMFPrioritySettings& aPrioritySettings);
   558 	              const TMMFPrioritySettings& aPrioritySettings);
   573 
   559 
   574 	/**
   560 	/**
   575 	* Returns the name assigned to a specific pre-defined tone sequence.
       
   576 	* This is the number of the fixed sequence supported by DevSound by
       
   577 	* default.
       
   578 	* The function raises a panic if sequence number specified is invalid.
       
   579 	* @since 
       
   580 	* @param TInt aSequenceNumber The index identifying the specific
       
   581 	*        pre-defined tone sequence. Index values are relative to zero.
       
   582 	*        This can be any value from zero to the value returned by a call
       
   583 	*        to CMdaAudioPlayerUtility::FixedSequenceCount() - 1. The
       
   584 	*        function raises a panic if sequence number is not within this
       
   585 	*        range.
       
   586 	* @return const TDesC & A reference to a Descriptor containing the fixed
       
   587 	*        sequence name indexed by aSequenceNumber.
       
   588 	*/
       
   589 	IMPORT_C const TDesC& FixedSequenceName(TInt aSequenceNumber);
       
   590 
       
   591 	/**
       
   592 	* Retrieves a custom interface to the device.
   561 	* Retrieves a custom interface to the device.
   593 	* @since 
   562 	* @since 
   594 	* @param TUid aInterfaceId The interface UID, defined with the custom
   563 	* @param TUid aInterfaceId The interface UID, defined with the custom
   595 	*        interface.
   564 	*        interface.
   596 	* @return TAny* A pointer to the interface implementation, or NULL if
   565 	* @return TAny* A pointer to the interface implementation, or NULL if
   597 	*        the device does not implement the interface requested. The
   566 	*        the device does not implement the interface requested. The
   598 	*        return value must be cast to the correct type by the user.
   567 	*        return value must be cast to the correct type by the user.
   599 	*/
   568 	*/
   600 	IMPORT_C TAny* CustomInterface(TUid aInterfaceId);
   569 	IMPORT_C TAny* CustomInterface(TUid aInterfaceId);
   601 
       
   602 	/**
       
   603 	* Returns the number of available pre-defined tone sequences.
       
   604 	* This is the number of fixed sequence supported by DevSound by default.
       
   605 	* @since 
       
   606 	* @return TInt  The fixed sequence count. This value is implementation
       
   607 	*        dependent.
       
   608 	*/
       
   609 	IMPORT_C TInt FixedSequenceCount();
       
   610 
   570 
   611 	/**
   571 	/**
   612 	* Returns data buffer from the DevSound server for playback.
   572 	* Returns data buffer from the DevSound server for playback.
   613 	* @since 
   573 	* @since 
   614 	* @param TMMFDevSoundProxyHwBufPckg& aSetPckg A reference to pckg to
   574 	* @param TMMFDevSoundProxyHwBufPckg& aSetPckg A reference to pckg to