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:  @file
sl@0:  @publishedPartner 
sl@0:  @released
sl@0: */
sl@0: 
sl@0: #ifndef MAUDIODATACONSUMER_H
sl@0: #define MAUDIODATACONSUMER_H
sl@0: 
sl@0: #include <a3f/a3fbase.h>
sl@0: 
sl@0: class MMMFBufferSink;
sl@0: class CMMFBuffer;
sl@0: 
sl@0: /**
sl@0:  * An interface to a set of callback functions that a buffer sink client must implement.
sl@0:  */
sl@0: class MMMFAudioDataConsumer
sl@0: 	{
sl@0: 	public:
sl@0: 	/**
sl@0: 	 * Provides a buffer with audio data to the client.
sl@0: 	 *
sl@0: 	 * After reading the data from the buffer, the client must call MBufferSink::BufferEmptied() passing the buffer as a parameter.
sl@0: 	 * @param aSink a pointer to the sink providing the buffer.
sl@0: 	 * @param aBuffer a pointer to the buffer to empty.
sl@0: 	 */
sl@0: 	virtual void BufferToBeEmptied(MMMFBufferSink* aSink, CMMFBuffer* aBuffer)=0;
sl@0: 
sl@0: 
sl@0: 	/**
sl@0: 	 * Indicates that any outstanding buffer requests are to be cancelled, so that control of those buffers returns to the framework.
sl@0: 	 * The client must call MMMFBufferSink::BuffersDiscarded() to acknowledge that this has taken place.
sl@0: 	 * @param aSource the source whose previous buffer requests should be ignored.
sl@0: 	 */
sl@0: 	virtual void DiscardBuffers(MMMFBufferSink* aSink)=0;
sl@0: 	};
sl@0: 
sl@0: #endif // MAUDIODATACONSUMER_H