devsound/hwdevapi/inc/TaskConfig.h
changeset 0 40261b775718
equal deleted inserted replaced
-1:000000000000 0:40261b775718
       
     1 // Copyright (c) 2002-2009 Nokia Corporation and/or its subsidiary(-ies).
       
     2 // All rights reserved.
       
     3 // This component and the accompanying materials are made available
       
     4 // under the terms of "Eclipse Public License v1.0"
       
     5 // which accompanies this distribution, and is available
       
     6 // at the URL "http://www.eclipse.org/legal/epl-v10.html".
       
     7 //
       
     8 // Initial Contributors:
       
     9 // Nokia Corporation - initial contribution.
       
    10 //
       
    11 // Contributors:
       
    12 //
       
    13 // Description:
       
    14 //
       
    15 
       
    16 /**
       
    17  @publishedPartner
       
    18  @released
       
    19 */
       
    20 
       
    21 #ifndef __TASKCONFIG_H__
       
    22 #define __TASKCONFIG_H__
       
    23 
       
    24 /**
       
    25 @publishedPartner
       
    26 @released
       
    27 
       
    28 TTaskSampleRate is a member of TTaskConfig which tells the HwDevice plugin the sample
       
    29 rate of the audio data.
       
    30 */
       
    31 enum TTaskSampleRate
       
    32 	{
       
    33   	/** 8000 Hz Sampling Rate
       
    34 	*/
       
    35 	ETask8000Hz  = 0x00000001,
       
    36   	/** 11025 Hz Sampling Rate
       
    37 	*/
       
    38 	ETask11025Hz = 0x00000002,
       
    39   	/** 16000 Hz Sampling Rate
       
    40 	*/
       
    41 	ETask16000Hz = 0x00000004,
       
    42   	/** 22050 Hz Sampling Rate
       
    43 	*/
       
    44 	ETask22050Hz = 0x00000008,
       
    45   	/** 32000 Hz Sampling Rate
       
    46 	*/
       
    47 	ETask32000Hz = 0x00000010,
       
    48   	/** 44100 Hz Sampling Rate
       
    49 	*/
       
    50 	ETask44100Hz = 0x00000020,
       
    51   	/** 48000 Hz Sampling Rate
       
    52 	*/
       
    53 	ETask48000Hz = 0x00000040,
       
    54   	/** 88200 Hz Sampling Rate
       
    55 	*/
       
    56 	ETask88200Hz = 0x00000080,
       
    57   	/** 96000 Hz Sampling Rate
       
    58 	*/
       
    59 	ETask96000Hz = 0x00000100,
       
    60   	/** 12000 Hz Sampling Rate
       
    61 	*/
       
    62 	ETask12000Hz = 0x00000200,
       
    63   	/** 24000 Hz Sampling Rate
       
    64 	*/
       
    65 	ETask24000Hz = 0x00000400,
       
    66 	/** 64000 Hz Sampling Rate
       
    67 	*/
       
    68 	ETask64000Hz = 0x00000800
       
    69 	};
       
    70 
       
    71 /**
       
    72 @publishedPartner
       
    73 @released
       
    74 
       
    75 TTaskStereoMode is a member of TTaskConfig which tells the HwDevice plugin whether stereo audio
       
    76 data is interleaved or not.
       
    77 */
       
    78 enum TTaskStereoMode
       
    79 	{
       
    80   	/** Audio data is mono.
       
    81 	*/
       
    82 	ETaskMono			= 0x00000001,
       
    83   	/** Audio data is interleaved.
       
    84 	*/
       
    85 	ETaskInterleaved	= 0x00000002,
       
    86   	/** Audio data is non-interleaved.
       
    87 	*/
       
    88 	ETaskNonInterleaved	= 0x00000004
       
    89 	};
       
    90 
       
    91 /**
       
    92 @publishedPartner
       
    93 @released
       
    94 
       
    95 Used by the SetConfig() method to configure the sample rate and stereo mode of a CMMFHwDevice 
       
    96 plugin. The configuration of HwDevices is device specific.
       
    97 */
       
    98 class TTaskConfig
       
    99 	{
       
   100 	public:
       
   101 		/** The rate of the audio data.
       
   102 
       
   103 		@see TTaskSampleRate
       
   104 	    */
       
   105 		TInt iRate;
       
   106 		/** The type of stereo audio data.
       
   107 
       
   108 		@see TTaskStereoMode
       
   109 		*/
       
   110 		TInt iStereoMode;
       
   111 		/** Uid for this TTaskConfig struct
       
   112 		*/
       
   113 		TInt iUid;
       
   114 	};
       
   115 	
       
   116 /**
       
   117 @publishedPartner
       
   118 @released
       
   119 
       
   120 Extended version of TTaskConfig used by the SetConfig() method to configure the sample rate, 
       
   121 stereo mode and number of channels of a CMdfHwDevice plugin. The configuration of HwDevices 
       
   122 is device specific.
       
   123 */	
       
   124 class TTaskConfig2 : public TTaskConfig
       
   125 	{
       
   126 public:
       
   127 	/** 
       
   128 	The number of channels.
       
   129 	*/
       
   130 	TInt iNumberOfChannels;
       
   131 	};	
       
   132 
       
   133 #endif
       
   134