devsound/devsoundpluginsupport/inc/plugin/devsoundplugin.h
author hgs
Thu, 24 Jun 2010 10:37:45 +0100
changeset 26 c36d67f77f75
permissions -rw-r--r--
2010wk21_04
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
26
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
     1
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
     2
// Copyright (c) 2001-2009 Nokia Corporation and/or its subsidiary(-ies).
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
     3
// All rights reserved.
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
     4
// This component and the accompanying materials are made available
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
     5
// under the terms of "Eclipse Public License v1.0"
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
     6
// which accompanies this distribution, and is available
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
     7
// at the URL "http://www.eclipse.org/legal/epl-v10.html".
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
     8
//
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
     9
// Initial Contributors:
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
    10
// Nokia Corporation - initial contribution.
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
    11
//
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
    12
// Contributors:
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
    13
//
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
    14
// Description:
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
    15
//
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
    16
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
    17
/**
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
    18
 @file
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
    19
 @publishedPartner
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
    20
 @released
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
    21
*/
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
    22
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
    23
#ifndef DEVSOUNDPLUGIN_H
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
    24
#define DEVSOUNDPLUGIN_H
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
    25
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
    26
_LIT8(KDevSoundPluginMatchString, "*"); // ECom insists on something
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
    27
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
    28
/**
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
    29
Interface class used in the plugin implementation of DevSound.
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
    30
The CMMFDevSound implementation loads a plugin based on this interface class. 
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
    31
Once this has been constructed, calls to method functions of CMMFDevSound are passed
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
    32
verbatim to this interface. For further description of required functionality, 
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
    33
see CMMFDevSound.
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
    34
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
    35
@see CMMFDevSound
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
    36
*/
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
    37
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
    38
class MMMFDevSoundPlugin
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
    39
	{
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
    40
public:
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
    41
	/**	
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
    42
	This must provide an implementation as defined by CMMFDevSound::~CMMFDevSound()
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
    43
	
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
    44
	@see CMMFDevSound::~CMMFDevSound()
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
    45
	*/
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
    46
	virtual ~MMMFDevSoundPlugin() {}
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
    47
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
    48
	/**
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
    49
	This must provide an implementation as defined by 
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
    50
	CMMFDevSound::InitializeL(MDevSoundObserver& aDevSoundObserver, TMMFState aMode)
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
    51
	
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
    52
	@param  aDevSoundObserver
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
    53
	        A reference to DevSound Observer instance.
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
    54
	@param  aMode
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
    55
	        The mode for which this object will be used.
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
    56
	        
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
    57
	@see CMMFDevSound::InitializeL(MDevSoundObserver& aDevSoundObserver, TMMFState aMode)
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
    58
	*/
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
    59
    virtual void InitializeL(MDevSoundObserver& aDevSoundObserver, TMMFState aMode)=0;
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
    60
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
    61
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
    62
	/**
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
    63
	This must provide an implementation as defined by 
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
    64
	CMMFDevSound::InitializeL(MDevSoundObserver& aDevSoundObserver, TUid aHWDev, TMMFState aMode)
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
    65
	
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
    66
	@param  aDevSoundObserver
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
    67
	        A reference to DevSound Observer instance.
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
    68
	@param  aHWDev
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
    69
	        The CMMFHwDevice implementation identifier.
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
    70
	@param  aMode
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
    71
	        The mode for which this object will be used.
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
    72
	        
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
    73
	@see CMMFDevSound::InitializeL(MDevSoundObserver& aDevSoundObserver, TUid aHWDev, TMMFState aMode)
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
    74
	*/
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
    75
	virtual void InitializeL(MDevSoundObserver& aDevSoundObserver, TUid aHWDev, TMMFState aMode)=0;
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
    76
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
    77
	/**
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
    78
	This must provide an implementation as defined by 
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
    79
	CMMFDevSound::InitializeL(MDevSoundObserver& aDevSoundObserver, TFourCC aDesiredFourCC, TMMFState aMode)
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
    80
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
    81
	@param  aDevSoundObserver
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
    82
	        A reference to DevSound Observer instance.
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
    83
	@param  aDesiredFourCC
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
    84
	        The CMMFHwDevice implementation FourCC code.
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
    85
	@param  aMode
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
    86
	        The mode for which this object will be used.
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
    87
	        
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
    88
	@see CMMFDevSound::InitializeL(MDevSoundObserver& aDevSoundObserver, TFourCC aDesiredFourCC, TMMFState aMode)
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
    89
	*/
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
    90
	virtual void InitializeL(MDevSoundObserver& aDevSoundObserver, TFourCC aDesiredFourCC, TMMFState aMode)=0;
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
    91
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
    92
	/**
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
    93
	This must provide an implementation as defined by CMMFDevSound::Capabilities()
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
    94
	
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
    95
	@return	The device settings.
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
    96
	
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
    97
	@see CMMFDevSound::Capabilities()
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
    98
	*/
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
    99
	virtual TMMFCapabilities Capabilities()=0;
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   100
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   101
	/**
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   102
	This must provide an implementation as defined by CMMFDevSound::Config()
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   103
	
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   104
	@return	The device settings.
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   105
	
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   106
	@see CMMFDevSound::Config()
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   107
	*/
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   108
	virtual TMMFCapabilities Config() const=0;
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   109
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   110
	/**
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   111
	This must provide an implementation as defined by CMMFDevSound::SetConfigL(const TMMFCapabilities& aCaps)
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   112
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   113
	@param  aCaps The attribute values to which CMMFDevSound object will be configured to.
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   114
	        
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   115
	@see CMMFDevSound::SetConfigL(const TMMFCapabilities& aCaps)
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   116
	*/
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   117
	virtual void SetConfigL(const TMMFCapabilities& aCaps)=0;
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   118
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   119
	/**
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   120
	This must provide an implementation as defined by CMMFDevSound::MaxVolume()
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   121
	
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   122
	@return	The maximum volume. This value is platform dependent but is always greater than or equal
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   123
	to one.
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   124
	
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   125
	@see CMMFDevSound::MaxVolume()
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   126
	*/
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   127
	virtual TInt MaxVolume()=0;
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   128
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   129
	/**
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   130
	This must provide an implementation as defined by CMMFDevSound::Volume()
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   131
	
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   132
	@return The current volume level.
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   133
		
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   134
	@see CMMFDevSound::Volume()
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   135
	*/
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   136
	virtual TInt Volume()=0;
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   137
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   138
	/**
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   139
	This must provide an implementation as defined by CMMFDevSound::SetVolume()
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   140
	
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   141
	@param  aVolume
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   142
	        The volume setting. This can be any value from 0 to the value
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   143
	        returned by a call to CMMFDevSound::MaxVolume(). If the
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   144
	        volume is not within this range, the volume is automatically set to
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   145
	        minimum or maximum value based on the value that is being passed.
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   146
	        Setting a zero value mutes the sound. Setting the maximum value
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   147
	        results in the loudest possible sound.
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   148
        
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   149
	@see CMMFDevSound::SetVolume()
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   150
	*/
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   151
	virtual void SetVolume(TInt aVolume)=0;
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   152
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   153
	/**
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   154
	This must provide an implementation as defined by CMMFDevSound::MaxGain()
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   155
	
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   156
	@return The maximum gain. This value is platform dependent but is always greater than or equal
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   157
	to one.
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   158
	
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   159
	@see CMMFDevSound::MaxGain()
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   160
	*/
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   161
	virtual TInt MaxGain()=0;
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   162
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   163
	/**
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   164
	This must provide an implementation as defined by CMMFDevSound::Gain()
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   165
	
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   166
	@return The current gain level.
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   167
	
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   168
	@see CMMFDevSound::Gain()
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   169
	*/
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   170
	virtual TInt Gain()=0;
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   171
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   172
	/**
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   173
	This must provide an implementation as defined by CMMFDevSound::SetGain()
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   174
	
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   175
	@param  aGain
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   176
		    The gain setting. This can be any value from zero to the value
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   177
		    returned by a call to CMMFDevSound::MaxGain(). If the
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   178
		    volume is not within this range, the gain is automatically set to
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   179
		    minimum or maximum value based on the value that is being passed.
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   180
		    Setting a zero value mutes the sound. Setting the maximum value
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   181
		    results in the loudest possible sound.
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   182
	@see CMMFDevSound::SetGain()
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   183
	*/
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   184
	virtual void SetGain(TInt aGain)=0;
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   185
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   186
	/**
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   187
	This must provide an implementation as defined by 
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   188
	CMMFDevSound::GetPlayBalanceL(TInt& aLeftPercentage, TInt& aRightPercentage)
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   189
	
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   190
	@param  aLeftPercentage
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   191
	        On return contains the left speaker volume percentage.
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   192
	@param  aRightPercentage
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   193
	        On return contains the right speaker volume percentage.
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   194
	        
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   195
	@see CMMFDevSound::GetPlayBalanceL(TInt& aLeftPercentage, TInt& aRightPercentage)
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   196
	*/
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   197
	virtual void GetPlayBalanceL(TInt& aLeftPercentage, TInt& aRightPercentage)=0;
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   198
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   199
	/**
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   200
	This must provide an implementation as defined by 
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   201
	CMMFDevSound::SetPlayBalanceL(TInt aLeftPercentage, TInt aRightPercentage)
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   202
	
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   203
	@param  aLeftPercentage
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   204
	        On return contains left speaker volume perecentage. This can be any
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   205
	        value from zero to 100. Setting a zero value mutes the sound on left
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   206
	        speaker.
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   207
	@param  aRightPercentage
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   208
	        On return contains right speaker volume perecentage. This can be any
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   209
	        value from zero to 100. Setting a zero value mutes the sound on
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   210
	        right speaker.
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   211
	        
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   212
	@see CMMFDevSound::SetPlayBalanceL(TInt aLeftPercentage, TInt aRightPercentage)
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   213
	*/
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   214
	virtual void SetPlayBalanceL(TInt aLeftPercentage, TInt aRightPercentage)=0;
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   215
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   216
	/**
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   217
	This must provide an implementation as defined by 
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   218
	CMMFDevSound::GetRecordBalanceL(TInt& aLeftPercentage, TInt& aRightPercentage)
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   219
	
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   220
	@param  aLeftPercentage
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   221
	        On return contains the left microphone gain percentage.
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   222
	@param  aRightPercentage
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   223
	        On return contains the right microphone gain percentage.
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   224
	        
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   225
	@see CMMFDevSound::GetRecordBalanceL(TInt& aLeftPercentage, TInt& aRightPercentage)
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   226
	*/
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   227
	virtual void GetRecordBalanceL(TInt& aLeftPercentage, TInt& aRightPercentage)=0;
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   228
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   229
	/**
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   230
	This must provide an implementation as defined by 
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   231
	CMMFDevSound::GetRecordBalanceL(TInt aLeftPercentage, TInt aRightPercentage)
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   232
	
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   233
	@param  aLeftPercentage
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   234
	        The left microphone gain precentage. This can be any value from zero to
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   235
	        100. Setting a zero value mutes the gain on left microphone.
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   236
	@param  aRightPercentage
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   237
	        The right microphone gain precentage. This can be any value from zero to
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   238
	        100. Setting a zero value mutes the gain on right microphone.
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   239
	        
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   240
	@see CMMFDevSound::GetRecordBalanceL(TInt aLeftPercentage, TInt aRightPercentage)
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   241
	*/
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   242
	virtual void SetRecordBalanceL(TInt aLeftPercentage, TInt aRightPercentage)=0;
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   243
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   244
	/**
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   245
	This must provide an implementation as defined by CMMFDevSound::PlayInitL()
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   246
	
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   247
	@see CMMFDevSound::PlayInitL()
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   248
	*/
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   249
	virtual void PlayInitL()=0;
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   250
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   251
	/**
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   252
	This must provide an implementation as defined by CMMFDevSound::RecordInitL()
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   253
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   254
	@see CMMFDevSound::RecordInitL()
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   255
	*/
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   256
	virtual void RecordInitL()=0;
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   257
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   258
	/**
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   259
	This must provide an implementation as defined by CMMFDevSound::PlayData()
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   260
	
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   261
	@see CMMFDevSound::PlayData()
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   262
	*/
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   263
	virtual void PlayData()=0;
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   264
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   265
	/**
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   266
	This must provide an implementation as defined by CMMFDevSound::RecordData()
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   267
	
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   268
	@see CMMFDevSound::RecordData()
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   269
	*/
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   270
	virtual void RecordData()=0;
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   271
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   272
	/**
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   273
	This must provide an implementation as defined by CMMFDevSound::Stop()
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   274
	
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   275
	@see CMMFDevSound::Stop()
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   276
	*/
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   277
	virtual void Stop()=0;
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   278
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   279
	/**
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   280
	This must provide an implementation as defined by CMMFDevSound::Pause()
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   281
	
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   282
	@see CMMFDevSound::Pause()
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   283
	*/
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   284
	virtual void Pause()=0;
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   285
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   286
	/**
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   287
	This must provide an implementation as defined by CMMFDevSound::SamplesRecorded()
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   288
	
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   289
	@return The samples recorded.
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   290
	
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   291
	@see CMMFDevSound::SamplesRecorded()
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   292
	*/
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   293
	virtual TInt SamplesRecorded()=0;
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   294
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   295
	/**
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   296
	This must provide an implementation as defined by CMMFDevSound::SamplesPlayed()
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   297
	
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   298
	@return The samples played.
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   299
	
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   300
	@see CMMFDevSound::SamplesPlayed()
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   301
	*/
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   302
	virtual TInt SamplesPlayed()=0;
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   303
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   304
	/**
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   305
	This must provide an implementation as defined by 
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   306
	CMMFDevSound::PlayToneL(TInt aFrequency, const TTimeIntervalMicroSeconds& aDuration)
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   307
	
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   308
	@param  aFrequency
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   309
	        The frequency at which the tone will be played.
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   310
	@param  aDuration
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   311
	        The period over which the tone will be played. A zero value causes
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   312
	        the no tone to be played.
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   313
	        
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   314
	@see CMMFDevSound::PlayToneL(TInt aFrequency, const TTimeIntervalMicroSeconds& aDuration)
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   315
	*/
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   316
	virtual void PlayToneL(TInt aFrequency, const TTimeIntervalMicroSeconds& aDuration)=0;
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   317
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   318
	/**
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   319
	This must provide an implementation as defined by 
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   320
	CMMFDevSound::PlayDualToneL(TInt aFrequencyOne, TInt aFrequencyTwo, const TTimeIntervalMicroSeconds& aDuration)
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   321
	
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   322
	@param  aFrequencyOne
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   323
	        The first frequency of dual tone.
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   324
	@param  aFrequencyTwo
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   325
	        The second frequency of dual tone
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   326
	@param  aDuration
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   327
	        The period over which the tone will be played. A zero value causes
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   328
	        the no tone to be played (Verify this with test app).
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   329
	        
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   330
	@see CMMFDevSound::PlayDualToneL(TInt aFrequencyOne, TInt aFrequencyTwo, const TTimeIntervalMicroSeconds& aDuration)
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   331
	*/
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   332
	virtual void PlayDualToneL(TInt aFrequencyOne, TInt aFrequencyTwo, const TTimeIntervalMicroSeconds& aDuration)=0;
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   333
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   334
	/**
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   335
	This must provide an implementation as defined by CMMFDevSound::PlayDTMFStringL(const TDesC& aDTMFString)
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   336
	
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   337
	@param  aDTMFString The DTMF sequence in a descriptor.
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   338
	
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   339
	@see CMMFDevSound::PlayDTMFStringL(const TDesC& aDTMFString)
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   340
	*/
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   341
	virtual void PlayDTMFStringL(const TDesC& aDTMFString)=0;
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   342
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   343
	/**
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   344
	This must provide an implementation as defined by CMMFDevSound::PlayToneSequenceL(const TDesC8& aData)
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   345
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   346
	@param  aData The tone sequence in a descriptor.
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   347
	
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   348
	@see CMMFDevSound::PlayToneSequenceL(const TDesC8& aData)
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   349
	*/
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   350
	virtual void PlayToneSequenceL(const TDesC8& aData)=0;
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   351
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   352
	/**
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   353
	This must provide an implementation as defined by CMMFDevSound::PlayFixedSequenceL(TInt aSequenceNumber)
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   354
	
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   355
	@param  aSequenceNumber
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   356
	        The index identifying the specific pre-defined tone sequence. Index
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   357
	        values are relative to zero.
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   358
	        This can be any value from zero to the value returned by a call to
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   359
	        FixedSequenceCount() - 1.
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   360
	        The function raises a panic if the sequence number is not within this
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   361
	        range.
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   362
	        
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   363
	@see CMMFDevSound::PlayFixedSequenceL(TInt aSequenceNumber)
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   364
	@see FixedSequenceCount()
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   365
	*/
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   366
	virtual void PlayFixedSequenceL(TInt aSequenceNumber)=0;
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   367
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   368
	/**
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   369
	This must provide an implementation as defined by 
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   370
	CMMFDevSound::SetToneRepeats(TInt aRepeatCount,
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   371
					const TTimeIntervalMicroSeconds& aRepeatTrailingSilence)
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   372
	
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   373
	@param  aRepeatCount
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   374
	        The number of times the tone, together with the trailing silence,
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   375
	        is to be repeated. If this is set to KMdaRepeatForever, then the
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   376
	        tone, together with the trailing silence, is repeated indefinitely
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   377
	        or until Stop() is called. If this is set to zero, then the tone is
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   378
	        not repeated.
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   379
	@param  aRepeatTrailingSilence
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   380
	        An interval of silence which will be played after each tone.
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   381
	        Supported only during tone playing.
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   382
	        
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   383
	@see CMMFDevSound::SetToneRepeats(TInt aRepeatCount,
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   384
					const TTimeIntervalMicroSeconds& aRepeatTrailingSilence)
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   385
	*/
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   386
	virtual void SetToneRepeats(TInt aRepeatCount,
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   387
					const TTimeIntervalMicroSeconds& aRepeatTrailingSilence)=0;
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   388
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   389
	/**
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   390
	This must provide an implementation as defined by 
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   391
	CMMFDevSound::(TTimeIntervalMicroSeconds32& aToneOnLength,
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   392
									TTimeIntervalMicroSeconds32& aToneOffLength,
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   393
									TTimeIntervalMicroSeconds32& aPauseLength)
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   394
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   395
	@param  aToneOnLength
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   396
	        The period over which the tone will be played. If this is set to
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   397
	        zero, then the tone is not played.
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   398
	@param  aToneOffLength
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   399
	        The period over which the no tone will be played.
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   400
	@param  aPauseLength
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   401
	        The period over which the tone playing will be paused.
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   402
	        
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   403
	@see CMMFDevSound::(TTimeIntervalMicroSeconds32& aToneOnLength,
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   404
									TTimeIntervalMicroSeconds32& aToneOffLength,
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   405
									TTimeIntervalMicroSeconds32& aPauseLength)
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   406
	*/
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   407
	virtual void SetDTMFLengths(TTimeIntervalMicroSeconds32& aToneOnLength,
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   408
									TTimeIntervalMicroSeconds32& aToneOffLength,
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   409
									TTimeIntervalMicroSeconds32& aPauseLength)=0;
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   410
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   411
	/**
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   412
	This must provide an implementation as defined by 
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   413
	CMMFDevSound::SetVolumeRamp(const TTimeIntervalMicroSeconds& aRampDuration)
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   414
	
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   415
	@param  aRampDuration
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   416
	        The period over which the volume is to rise. A zero value causes
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   417
	        the tone sample to be played at the normal level for the full
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   418
	        duration of the playback. A value, which is longer than the duration
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   419
	        of the tone sample means that the sample never reaches its normal
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   420
	        volume level.
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   421
	        
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   422
	@see CMMFDevSound::SetVolumeRamp(const TTimeIntervalMicroSeconds& aRampDuration)
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   423
	*/
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   424
	virtual void SetVolumeRamp(const TTimeIntervalMicroSeconds& aRampDuration)=0;
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   425
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   426
	/**
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   427
	This must provide an implementation as defined by 
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   428
	CMMFDevSound::SetPrioritySettings(const TMMFPrioritySettings& aPrioritySettings)
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   429
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   430
	@param	aPrioritySettings 
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   431
			A class type representing the client's priority, priority preference and state.
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   432
			
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   433
	@see CMMFDevSound::SetPrioritySettings(const TMMFPrioritySettings& aPrioritySettings)
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   434
	*/
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   435
	virtual void SetPrioritySettings(const TMMFPrioritySettings& aPrioritySettings)=0;
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   436
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   437
	/**
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   438
	This must provide an implementation as defined by CMMFDevSound::CustomInterface(TUid aInterfaceId)
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   439
	
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   440
	@param  aInterfaceId
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   441
	        The interface UID, defined with the custom interface.
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   442
	
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   443
	@return A pointer to the interface implementation, or NULL if the device does not
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   444
	        implement the interface requested. The return value must be cast to the
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   445
	        correct type by the user.The user should be careful while caching the custom interface pointer,
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   446
	        as in some situations the lower level custom interface pointer may become NULL
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   447
	        
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   448
	@see CMMFDevSound::CustomInterface(TUid aInterfaceId)
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   449
	*/
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   450
	virtual TAny* CustomInterface(TUid aInterfaceId)=0;
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   451
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   452
	/**
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   453
	This must provide an implementation as defined by CMMFDevSound::FixedSequenceCount()
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   454
	
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   455
	@return The fixed sequence count. This value is implementation dependent but is always greater 
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   456
	        than or equal to zero.
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   457
	        
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   458
	@see CMMFDevSound::FixedSequenceCount()
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   459
	*/
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   460
	virtual TInt FixedSequenceCount()=0;
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   461
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   462
	/**
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   463
	This must provide an implementation as defined by CMMFDevSound::FixedSequenceName(TInt aSequenceNumber)
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   464
	
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   465
	@param  aSequenceNumber
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   466
	        The index identifying the specific pre-defined tone sequence. Index values are relative 
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   467
	        to zero. This can be any value from zero to the value returned by a call to
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   468
	        FixedSequenceCount() - 1.
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   469
	        The function raises a panic if sequence number is not within this
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   470
	        range.
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   471
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   472
	@return A reference to a Descriptor containing the fixed sequence name indexed by
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   473
	        aSequenceNumber.
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   474
	        
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   475
	@see CMMFDevSound::FixedSequenceName(TInt aSequenceNumber)
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   476
	@see FixedSequenceCount()
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   477
	*/
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   478
	virtual const TDesC& FixedSequenceName(TInt aSequenceNumber)=0;
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   479
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   480
	/**
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   481
	This must provide an implementation as defined by 
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   482
	CMMFDevSound::GetSupportedInputDataTypesL(RArray<TFourCC>& aSupportedDataTypes,
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   483
													const TMMFPrioritySettings& aPrioritySettings) const
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   484
	
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   485
	@param  aSupportedDataTypes
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   486
	        The array of supported data types that will be filled in by this function.
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   487
	        The supported data types of the DevSound are in the form of an array
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   488
	        of TFourCC codes. Any existing entries in the array will be overwritten on 
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   489
	        calling this function. If no supported data types are found given the priority 
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   490
	        settings, then the aSupportedDatatypes array will have zero entries.
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   491
	@param  aPrioritySettings
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   492
	        The priority settings used to determine the supported datatypes.  Note this
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   493
	        does not set the priority settings. For input datatypes the iState member
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   494
	        of the priority settings would be expected to be either
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   495
	        EMMFStatePlaying or EMMFStatePlayingRecording. The priority settings may
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   496
	        effect the supported datatypes depending on the audio routing.
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   497
	        
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   498
	@see CMMFDevSound::GetSupportedInputDataTypesL(RArray<TFourCC>& aSupportedDataTypes,
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   499
													const TMMFPrioritySettings& aPrioritySettings) const
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   500
	*/
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   501
	virtual void GetSupportedInputDataTypesL(RArray<TFourCC>& aSupportedDataTypes, const TMMFPrioritySettings& aPrioritySettings) const=0;
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   502
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   503
	/**
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   504
	This must provide an implementation as defined by 
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   505
	CMMFDevSound::GetSupportedOutputDataTypesL(RArray<TFourCC>& aSupportedDataTypes, const TMMFPrioritySettings& aPrioritySettings) const
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   506
	
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   507
	@param  aSupportedDataTypes
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   508
	        The array of supported data types that will be filled in by this function.
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   509
	        The supported datatypes of the DevSound are in the form of an array
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   510
	        of TFourCC codes.
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   511
	        Any existing entries in the array will be overwritten on calling this function.
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   512
	        If no supported datatypes are found given the priority settings, then
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   513
	        the aSupportedDatatypes array will have zero entries.
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   514
	@param  aPrioritySettings
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   515
	        The priority settings used to determine the supported data types.  Note this
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   516
	        does not set the priority settings. For output data types the iState member
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   517
	        of the priority settings would expected to be either
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   518
	        EMMFStateRecording or EMMFStatePlayingRecording. The priority settings may
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   519
	        effect the supported datatypes depending on the audio routing.
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   520
	        
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   521
	@see CMMFDevSound::GetSupportedOutputDataTypesL(RArray<TFourCC>& aSupportedDataTypes, const TMMFPrioritySettings& aPrioritySettings) const
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   522
	*/
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   523
	virtual void GetSupportedOutputDataTypesL(RArray<TFourCC>& aSupportedDataTypes, const TMMFPrioritySettings& aPrioritySettings) const=0;
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   524
	
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   525
	};
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   526
c36d67f77f75 2010wk21_04
hgs
parents:
diff changeset
   527
#endif // DEVSOUNDPLUGIN_H