1.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.2 +++ b/os/mm/devsound/a3facf/inc/audiocontextfactory.h	Fri Jun 15 03:10:57 2012 +0200
     1.3 @@ -0,0 +1,94 @@
     1.4 +/*
     1.5 +* Copyright (c) 2006-2009 Nokia Corporation and/or its subsidiary(-ies).
     1.6 +* All rights reserved.
     1.7 +* This component and the accompanying materials are made available
     1.8 +* under the terms of "Eclipse Public License v1.0"
     1.9 +* which accompanies this distribution, and is available
    1.10 +* at the URL "http://www.eclipse.org/legal/epl-v10.html".
    1.11 +*
    1.12 +* Initial Contributors:
    1.13 +* Nokia Corporation - initial contribution.
    1.14 +*
    1.15 +* Contributors:
    1.16 +*
    1.17 +* Description:
    1.18 +*
    1.19 +*/
    1.20 +
    1.21 +
    1.22 +
    1.23 +
    1.24 +/**
    1.25 + @publishedPartner
    1.26 + @file
    1.27 + @released
    1.28 +*/
    1.29 +
    1.30 +
    1.31 +#ifndef AUDIOCONTEXTFACTORY_H
    1.32 +#define AUDIOCONTEXTFACTORY_H
    1.33 +
    1.34 +#include <e32base.h>
    1.35 +
    1.36 +#include <a3f/a3fbase.h>
    1.37 +
    1.38 +class MAudioContext;
    1.39 +
    1.40 +/**
    1.41 + * An interface to an AudioContextFactory.
    1.42 + *
    1.43 + * Audio Context Factory is the entry point to the low level audio functionality of the device.
    1.44 + * Audio Context Factory is used for creating new audio contexts.
    1.45 + *
    1.46 + *  @lib AudioContextFactory.lib
    1.47 + */
    1.48 +class CAudioContextFactory : public CBase
    1.49 +	{
    1.50 +public:
    1.51 +	/**
    1.52 +	 * Constructs and returns a pointer to a new CAudioContextFactory object.
    1.53 +	 *
    1.54 +	 * @return CAudioContextFactory* - on success, pointer to new class instance.
    1.55 +	 * This call returns ownership, as in the standard NewL() pattern.
    1.56 +	 */
    1.57 +	IMPORT_C static CAudioContextFactory* NewL();
    1.58 +
    1.59 +	/**
    1.60 +	 * Destructor.
    1.61 +	 *
    1.62 +	 * Deletes all objects and releases all resource owned by this instance.
    1.63 +	 */
    1.64 +	IMPORT_C virtual ~CAudioContextFactory();
    1.65 +
    1.66 +	/**
    1.67 +	 * Creates a new audio context.
    1.68 +	 *
    1.69 +	 * The context must be removed using DeleteAudioContext() when it is no longer needed.
    1.70 +	 * @param aContext on return contains a reference to the created context.
    1.71 +	 * @return an error code. KErrNone if successful, otherwise one of the system wide error codes.
    1.72 + 	 */
    1.73 +	IMPORT_C TInt CreateAudioContext(MAudioContext*& aContext);
    1.74 +
    1.75 +
    1.76 +	/**
    1.77 +	 * Deletes the audio context.
    1.78 +	 * All processing units have to be removed from the context by the client.
    1.79 +	 * before the context is removed. This is a null-operation if aContext is NULL on DeleteAudioContext being called.
    1.80 +	 * aContext is set to NULL on completion of the call.
    1.81 +	 * @param aContext a pointer to the context to remove.
    1.82 +	 * @return an error code. KErrNone if successful, otherwise one of the system wide error codes.
    1.83 +	 */
    1.84 +	IMPORT_C void DeleteAudioContext(MAudioContext*& aContext);
    1.85 +
    1.86 +protected:
    1.87 +	/**
    1.88 +	 * Constructor
    1.89 +	 */
    1.90 +	CAudioContextFactory();
    1.91 +	/**
    1.92 +	 * Second phase contructor.
    1.93 +	 */
    1.94 +	void ConstructL();
    1.95 +	};
    1.96 +
    1.97 +#endif // AUDIOCONTEXTFACTORY_H