sl@0: /*
sl@0: * Copyright (c) 2006-2009 Nokia Corporation and/or its subsidiary(-ies).
sl@0: * All rights reserved.
sl@0: * This component and the accompanying materials are made available
sl@0: * under the terms of "Eclipse Public License v1.0"
sl@0: * which accompanies this distribution, and is available
sl@0: * at the URL "http://www.eclipse.org/legal/epl-v10.html".
sl@0: *
sl@0: * Initial Contributors:
sl@0: * Nokia Corporation - initial contribution.
sl@0: *
sl@0: * Contributors:
sl@0: *
sl@0: * Description:
sl@0: *
sl@0: */
sl@0: 
sl@0: 
sl@0: 
sl@0: 
sl@0: /**
sl@0:  @publishedPartner
sl@0:  @file
sl@0:  @released
sl@0: */
sl@0: 
sl@0: 
sl@0: #ifndef AUDIOCONTEXTFACTORY_H
sl@0: #define AUDIOCONTEXTFACTORY_H
sl@0: 
sl@0: #include <e32base.h>
sl@0: 
sl@0: #include <a3f/a3fbase.h>
sl@0: 
sl@0: class MAudioContext;
sl@0: 
sl@0: /**
sl@0:  * An interface to an AudioContextFactory.
sl@0:  *
sl@0:  * Audio Context Factory is the entry point to the low level audio functionality of the device.
sl@0:  * Audio Context Factory is used for creating new audio contexts.
sl@0:  *
sl@0:  *  @lib AudioContextFactory.lib
sl@0:  */
sl@0: class CAudioContextFactory : public CBase
sl@0: 	{
sl@0: public:
sl@0: 	/**
sl@0: 	 * Constructs and returns a pointer to a new CAudioContextFactory object.
sl@0: 	 *
sl@0: 	 * @return CAudioContextFactory* - on success, pointer to new class instance.
sl@0: 	 * This call returns ownership, as in the standard NewL() pattern.
sl@0: 	 */
sl@0: 	IMPORT_C static CAudioContextFactory* NewL();
sl@0: 
sl@0: 	/**
sl@0: 	 * Destructor.
sl@0: 	 *
sl@0: 	 * Deletes all objects and releases all resource owned by this instance.
sl@0: 	 */
sl@0: 	IMPORT_C virtual ~CAudioContextFactory();
sl@0: 
sl@0: 	/**
sl@0: 	 * Creates a new audio context.
sl@0: 	 *
sl@0: 	 * The context must be removed using DeleteAudioContext() when it is no longer needed.
sl@0: 	 * @param aContext on return contains a reference to the created context.
sl@0: 	 * @return an error code. KErrNone if successful, otherwise one of the system wide error codes.
sl@0:  	 */
sl@0: 	IMPORT_C TInt CreateAudioContext(MAudioContext*& aContext);
sl@0: 
sl@0: 
sl@0: 	/**
sl@0: 	 * Deletes the audio context.
sl@0: 	 * All processing units have to be removed from the context by the client.
sl@0: 	 * before the context is removed. This is a null-operation if aContext is NULL on DeleteAudioContext being called.
sl@0: 	 * aContext is set to NULL on completion of the call.
sl@0: 	 * @param aContext a pointer to the context to remove.
sl@0: 	 * @return an error code. KErrNone if successful, otherwise one of the system wide error codes.
sl@0: 	 */
sl@0: 	IMPORT_C void DeleteAudioContext(MAudioContext*& aContext);
sl@0: 
sl@0: protected:
sl@0: 	/**
sl@0: 	 * Constructor
sl@0: 	 */
sl@0: 	CAudioContextFactory();
sl@0: 	/**
sl@0: 	 * Second phase contructor.
sl@0: 	 */
sl@0: 	void ConstructL();
sl@0: 	};
sl@0: 
sl@0: #endif // AUDIOCONTEXTFACTORY_H