|
sl@0
|
1 |
/*
|
|
sl@0
|
2 |
* Copyright (c) 2006-2009 Nokia Corporation and/or its subsidiary(-ies).
|
|
sl@0
|
3 |
* All rights reserved.
|
|
sl@0
|
4 |
* This component and the accompanying materials are made available
|
|
sl@0
|
5 |
* under the terms of "Eclipse Public License v1.0"
|
|
sl@0
|
6 |
* which accompanies this distribution, and is available
|
|
sl@0
|
7 |
* at the URL "http://www.eclipse.org/legal/epl-v10.html".
|
|
sl@0
|
8 |
*
|
|
sl@0
|
9 |
* Initial Contributors:
|
|
sl@0
|
10 |
* Nokia Corporation - initial contribution.
|
|
sl@0
|
11 |
*
|
|
sl@0
|
12 |
* Contributors:
|
|
sl@0
|
13 |
*
|
|
sl@0
|
14 |
* Description:
|
|
sl@0
|
15 |
*
|
|
sl@0
|
16 |
*/
|
|
sl@0
|
17 |
|
|
sl@0
|
18 |
|
|
sl@0
|
19 |
|
|
sl@0
|
20 |
|
|
sl@0
|
21 |
/**
|
|
sl@0
|
22 |
@file
|
|
sl@0
|
23 |
@publishedPartner
|
|
sl@0
|
24 |
@released
|
|
sl@0
|
25 |
*/
|
|
sl@0
|
26 |
|
|
sl@0
|
27 |
#ifndef MAUDIOGAINCONTROLOBSERVER_H
|
|
sl@0
|
28 |
#define MAUDIOGAINCONTROLOBSERVER_H
|
|
sl@0
|
29 |
|
|
sl@0
|
30 |
#include <e32base.h>
|
|
sl@0
|
31 |
#include <a3f/a3fbase.h>
|
|
sl@0
|
32 |
#include <a3f/maudiogaincontrol.h>
|
|
sl@0
|
33 |
|
|
sl@0
|
34 |
/**
|
|
sl@0
|
35 |
* An interface to a set of AudioGainControl callback functions.
|
|
sl@0
|
36 |
*
|
|
sl@0
|
37 |
* this serves as the method of communication between the client and the
|
|
sl@0
|
38 |
* AudioGainControl.
|
|
sl@0
|
39 |
*
|
|
sl@0
|
40 |
* The class is a mixin and is intended to be inherited by the client class
|
|
sl@0
|
41 |
* that is interested in observing the Gain operations. The functions
|
|
sl@0
|
42 |
* encapsulated by this class are called when specific events occur while
|
|
sl@0
|
43 |
* processing audio.
|
|
sl@0
|
44 |
*
|
|
sl@0
|
45 |
*/
|
|
sl@0
|
46 |
class MAudioGainControlObserver
|
|
sl@0
|
47 |
{
|
|
sl@0
|
48 |
public:
|
|
sl@0
|
49 |
|
|
sl@0
|
50 |
/**
|
|
sl@0
|
51 |
* Notifies the observer that the max ramp time supported by the gain
|
|
sl@0
|
52 |
* control has changed.
|
|
sl@0
|
53 |
*
|
|
sl@0
|
54 |
* @param aGain a reference to GainControl whose max ramp time changed.
|
|
sl@0
|
55 |
*/
|
|
sl@0
|
56 |
virtual void MaxRampTimeChanged(MAudioGainControl& aGain)=0;
|
|
sl@0
|
57 |
|
|
sl@0
|
58 |
/**
|
|
sl@0
|
59 |
* Notifies the observer that the maximum gain value supported by the
|
|
sl@0
|
60 |
* gain control has changed.
|
|
sl@0
|
61 |
*
|
|
sl@0
|
62 |
* @param aGain a reference to GainControl whose max gain changed.
|
|
sl@0
|
63 |
*/
|
|
sl@0
|
64 |
virtual void MaxGainChanged(MAudioGainControl& aGain)=0;
|
|
sl@0
|
65 |
|
|
sl@0
|
66 |
/**
|
|
sl@0
|
67 |
* Notifies the observer that the gain has changed,
|
|
sl@0
|
68 |
* due to request from the client or otherwise.
|
|
sl@0
|
69 |
* If gain change by the client cannot be fulfilled,
|
|
sl@0
|
70 |
* a gain change with an error code other than KErrNone will be issued.
|
|
sl@0
|
71 |
* @param aGain a reference to the gain control whose gain has changed.
|
|
sl@0
|
72 |
* @return aError an error code.
|
|
sl@0
|
73 |
* KErrNone if the gain change was requested by the client and was completed successfully.
|
|
sl@0
|
74 |
* KErrNotSupported if the SetGain() call referred to non-existent channels.
|
|
sl@0
|
75 |
* KErrArgument if aGain of less than 0 or larger than max gain,
|
|
sl@0
|
76 |
* the same channel is specified multiple times,
|
|
sl@0
|
77 |
* or aRampDuration is less than 0 or greater than max ramp duration.
|
|
sl@0
|
78 |
* KErrA3fUnsupportedRamp if the ramp operation requested is not supported,
|
|
sl@0
|
79 |
* or the Uid value supplies is unknown.
|
|
sl@0
|
80 |
* Other system-wide errors are also possible. They will indicate that the gain change failed.
|
|
sl@0
|
81 |
* Note that these errors could alternatively be returned by the associated SetGain() call.
|
|
sl@0
|
82 |
*/
|
|
sl@0
|
83 |
virtual void GainChanged(MAudioGainControl& aGain, TInt aError)=0;
|
|
sl@0
|
84 |
|
|
sl@0
|
85 |
};
|
|
sl@0
|
86 |
|
|
sl@0
|
87 |
#endif // MAUDIOGAINCONTROLOBSERVER_H
|