devsound/a3facf/inc/maudiocodecobserver.h
changeset 0 40261b775718
equal deleted inserted replaced
-1:000000000000 0:40261b775718
       
     1 /*
       
     2 * Copyright (c) 2007-2009 Nokia Corporation and/or its subsidiary(-ies).
       
     3 * All rights reserved.
       
     4 * This component and the accompanying materials are made available
       
     5 * under the terms of "Eclipse Public License v1.0"
       
     6 * which accompanies this distribution, and is available
       
     7 * at the URL "http://www.eclipse.org/legal/epl-v10.html".
       
     8 *
       
     9 * Initial Contributors:
       
    10 * Nokia Corporation - initial contribution.
       
    11 *
       
    12 * Contributors:
       
    13 *
       
    14 * Description:
       
    15 * Save as expressly licensed to you by Symbian Software Ltd, all rights reserved.
       
    16 * 
       
    17 *
       
    18 */
       
    19 
       
    20 
       
    21 
       
    22 /**
       
    23  @file
       
    24  @publishedPartner
       
    25  @released
       
    26 */
       
    27 
       
    28 #ifndef MAUDIOCODECOBSERVER_H
       
    29 #define MAUDIOCODECOBSERVER_H
       
    30 
       
    31 #include <e32base.h>
       
    32 #include <a3f/a3fbase.h>
       
    33 
       
    34 /**
       
    35  *  An interface to a set of AudioGainControl callback functions.
       
    36  *
       
    37  *  This serves as the method of communication between the client and the
       
    38  *  AudioGainControl.
       
    39  *
       
    40  *  The class is a mixin and is intended to be inherited by the client class
       
    41  *  that is interested in observing the Gain operations. The functions
       
    42  *  encapsulated by this class are called when specific events occur while
       
    43  *  processing audio.
       
    44  *
       
    45  */
       
    46 class MAudioCodecObserver
       
    47 	{
       
    48 public:
       
    49 
       
    50 	/**
       
    51 	* Callback showing completion SetSampleRate().
       
    52 	*
       
    53 	* @param aError will be KErrNone if the action succeeded, otherwise it will be a system error
       
    54 	* specific errors to be defined.
       
    55 	*/
       
    56 	virtual void SampleRateSet(TInt aError)=0;
       
    57 
       
    58 	/**
       
    59 	* Callback showing completion SetMode().
       
    60 	*
       
    61 	* @param aError will be KErrNone if the action succeeded, otherwise it will be a system error
       
    62 	* specific errors to be defined.
       
    63 	*/
       
    64 	virtual void ModeSet(TInt aError)=0;
       
    65 
       
    66 	/**
       
    67 	* Callback showing completion GetSupportedSampleRates().
       
    68 	*
       
    69 	* @param Error will be KErrNone if the action succeeded, otherwise it will be a system error 
       
    70 	* specific errors to be defined. If aError is not KErrNone, then the state of aSupportedRates is undefined.
       
    71 	*/
       
    72 	virtual void GetSupportedSampleRatesComplete (TInt aError)=0;
       
    73 
       
    74 	/**
       
    75 	* Callback showing completion GetSupportedModes().
       
    76 	*
       
    77 	* @param aError will be KErrNone if the action succeeded, otherwise it will be a system error
       
    78 	* specific errors to be defined. If aError is not KErrNone, then the state of aSupportedModes is undefined.
       
    79 	*/
       
    80 	virtual void GetSupportedModesComplete (TInt aError)=0;
       
    81 
       
    82 	};
       
    83 
       
    84 #endif // MAUDIOCODECOBSERVER_H
       
    85