/*

 * Copyright (c) 2008 Nokia Corporation and/or its subsidiary(-ies).

 * All rights reserved.

 * This component and the accompanying materials are made available

 * under the terms of "Eclipse Public License v1.0"

 * which accompanies this distribution, and is available

 * at the URL "http://www.eclipse.org/legal/epl-v10.html".

 *

 * Initial Contributors:

 * Nokia Corporation - initial contribution.

 *

 * Contributors:

 *

 * Description:  Defines VoIP downlink stream APIs.

 *

 */

#include <voipaudiocommon.h>

#include <voipdtmftoneplayer.h>

// FORWARD DECLARATIONS

class CVoIPAudioDownlinkStream;

class CVoIPAudioDownlinkStreamImpl;

class CVoIPDataBuffer;

class CVoIPFormatIntfc;

/**

 *  MVoIPDownlinkObserver class

 *

 *  @lib VoIPAudioIntfc.dll

 *

 */

class MVoIPDownlinkObserver

    {

public:

    static const TUint KOpenComplete = 1;

    static const TUint KDownlinkError = 2;

    static const TUint KDownlinkClosed = 3;

    static const TUint KAudioDeviceChanged = 4;

public:

    /**

     * @param const CVoIPAudioDownlinkStream&

     * @param CVoIPDataBuffer*

     * @return void

     */

    virtual void FillBuffer(const CVoIPAudioDownlinkStream& aSrc,

            CVoIPDataBuffer* aBuffer) = 0;

    /**

     * @param const CVoIPAudioDownlinkStream&

     * @param TInt - Event type

     * @param TInt - Status

     * @return void

     */

    virtual void Event(const CVoIPAudioDownlinkStream& aSrc, TInt aEventType,

            TInt aError) = 0;

    };

/**

 *  CVoIPAudioDownlinkStream class

 *

 *  @lib VoIPAudioIntfc.dll

 *

 */

class CVoIPAudioDownlinkStream

    {

public:

    /**

     *  TVoIPOutputDevice

     */

    enum TVoIPOutputDevice

        {

        EHandset,

        ELoudSpeaker,

        ENoPreference

        };

public:

    /**

     * Destructor

     * @param none

     * @return none

     */

    IMPORT_C virtual ~CVoIPAudioDownlinkStream();

    /**

     * @param MVoIPDownlinkObserver&

     * @return TInt

     */

    IMPORT_C TInt Open(MVoIPDownlinkObserver& aObserver);

    /**

     * @param TVersion&

     * @return TInt

     */

    IMPORT_C TInt GetVersion(TVersion& aVersion);

    /**

     * @param TInt&

     * @return TInt

     */

    IMPORT_C TInt GetMaxVolume(TInt& aVolume);

    /**

     * @param TInt

     * @return TInt

     */

    IMPORT_C TInt SetVolume(TInt aVolume);

    /**

     * @param TInt&

     * @return TInt

     */

    IMPORT_C TInt GetVolume(TInt& aVolume);

    /**

     * @param TVoIPCodecFormat

     * @param CVoIPFormatIntfc*&

     * @return TInt

     */

    IMPORT_C TInt SetFormat(TVoIPCodecFormat aFormat,

            CVoIPFormatIntfc*& aIntfc);

    /**

     * @param TVoIPOutputDevice

     * @return TInt

     */

    IMPORT_C TInt SetAudioDevice(TVoIPOutputDevice aDevice);

    /**

     * @param TVoIPOutputDevice&

     * @return TInt

     */

    IMPORT_C TInt GetAudioDevice(TVoIPOutputDevice& aDevice);

    /**

     * @param none

     * @return TInt

     */

    IMPORT_C TInt Start();

    /**

     * @param none

     * @return TInt

     */

    IMPORT_C TInt Stop();

    /**

     * @param none

     * @return void

     */

    IMPORT_C void Close();

    /**

     * @param CVoIPDataBuffer*

     * @return TInt

     */

    IMPORT_C TInt BufferFilled(CVoIPDataBuffer* aBuffer);

protected:

    /**

     * Constructor

     * @param none

     * @return TInt

     */

    CVoIPAudioDownlinkStream();

    /**

     * Symbian constructor

     * @param none

     * @return TInt

     */

private:

    /**

     * For internal use only

     */

    friend class CDTMFTonePlayer;

private:

    CVoIPAudioDownlinkStreamImpl* iVoIPAudioDownlinkStreamImpl;

    };

// End of file