1.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.2 +++ b/os/mm/devsound/a3facf/inc/maudiodataconsumer.h	Fri Jun 15 03:10:57 2012 +0200
     1.3 @@ -0,0 +1,59 @@
     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 + @file
    1.26 + @publishedPartner 
    1.27 + @released
    1.28 +*/
    1.29 +
    1.30 +#ifndef MAUDIODATACONSUMER_H
    1.31 +#define MAUDIODATACONSUMER_H
    1.32 +
    1.33 +#include <a3f/a3fbase.h>
    1.34 +
    1.35 +class MMMFBufferSink;
    1.36 +class CMMFBuffer;
    1.37 +
    1.38 +/**
    1.39 + * An interface to a set of callback functions that a buffer sink client must implement.
    1.40 + */
    1.41 +class MMMFAudioDataConsumer
    1.42 +	{
    1.43 +	public:
    1.44 +	/**
    1.45 +	 * Provides a buffer with audio data to the client.
    1.46 +	 *
    1.47 +	 * After reading the data from the buffer, the client must call MBufferSink::BufferEmptied() passing the buffer as a parameter.
    1.48 +	 * @param aSink a pointer to the sink providing the buffer.
    1.49 +	 * @param aBuffer a pointer to the buffer to empty.
    1.50 +	 */
    1.51 +	virtual void BufferToBeEmptied(MMMFBufferSink* aSink, CMMFBuffer* aBuffer)=0;
    1.52 +
    1.53 +
    1.54 +	/**
    1.55 +	 * Indicates that any outstanding buffer requests are to be cancelled, so that control of those buffers returns to the framework.
    1.56 +	 * The client must call MMMFBufferSink::BuffersDiscarded() to acknowledge that this has taken place.
    1.57 +	 * @param aSource the source whose previous buffer requests should be ignored.
    1.58 +	 */
    1.59 +	virtual void DiscardBuffers(MMMFBufferSink* aSink)=0;
    1.60 +	};
    1.61 +
    1.62 +#endif // MAUDIODATACONSUMER_H