devsound/a3facf/inc/maudiodatasupplier.h
changeset 0 40261b775718
equal deleted inserted replaced
-1:000000000000 0:40261b775718
       
     1 /*
       
     2 * Copyright (c) 2006-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 *
       
    16 */
       
    17 
       
    18 
       
    19 
       
    20 
       
    21 /**
       
    22  @file
       
    23  @publishedPartner 
       
    24  @released
       
    25 */
       
    26 
       
    27 #ifndef MAUDIODATASUPPLIER_H
       
    28 #define MAUDIODATASUPPLIER_H
       
    29 
       
    30 #include <a3f/a3fbase.h>
       
    31 
       
    32 class MMMFBufferSource;
       
    33 class CMMFBuffer;
       
    34 
       
    35 /**
       
    36  * An interface to a set of callback functions that a buffer source client must implement.
       
    37  */
       
    38 class MMMFAudioDataSupplier
       
    39 	{
       
    40 	public:
       
    41 	/**
       
    42 	 * Request a buffer to be filled with audio data.
       
    43 	 *
       
    44 	 * After filling the buufer, the client must call MBufferSource::BufferFilled() passing the filled buffer as a parameter.
       
    45 	 * 
       
    46 	 * @param aSource a pointer to the source requesting the buffer.
       
    47 	 * @param aBuffer a pointer to the buffer to fill.
       
    48 	 */
       
    49 	virtual void BufferToBeFilled(MMMFBufferSource* aSource, CMMFBuffer* aBuffer)=0;
       
    50 
       
    51 	/**
       
    52 	 * Indicates that all buffers originating from this source have been removed from the audio path.
       
    53 	 * Also, all pending buffers previously requested by this source have become invalid and must not be used.
       
    54 	 *
       
    55 	 * @param aSource the source whose previous buffer requests should be ignored.
       
    56 	 */
       
    57 	virtual void DiscardBuffers(MMMFBufferSource* aSource)=0;
       
    58 	};
       
    59 
       
    60 #endif // MAUDIODATASUPPLIER_H