mmmw_plat/voip_audio_services_api/inc/voipdatabuffer.h
author Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
Fri, 19 Feb 2010 23:19:48 +0200
branchRCL_3
changeset 3 4f62049db6ac
parent 0 71ca22bcf22a
permissions -rw-r--r--
Revision: 201003 Kit: 201007

/*
 * 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 buffer type for VoIP data streaming.
 *
 */

#ifndef __VOIPDATABUFFER_H
#define __VOIPDATABUFFER_H

#include <e32base.h>

// FORWARD DECLARATIONS
class CVoIPDataBufferImpl;
class CVoIPJBDataBufferImpl;

/**
 *  CVoIPDataBuffer
 *  ?description
 *
 */
class CVoIPDataBuffer
    {
public:
    /**
     * Buffer types
     */
    enum TVoIPBufferType
        {
        EStandard,
        EJitterBuffer
        };

public:
    /**
     * Destructor
     *
     * @since S60 v5.0
     * @param none
     * @return none
     */
    IMPORT_C virtual ~CVoIPDataBuffer();

    /**
     * SetPayloadPtr
     *
     * @since S60 v5.0
     * @param TPtr8
     * @return none
     */
    IMPORT_C void SetPayloadPtr(TPtr8 aPayloadPtr);

    /**
     * GetPayloadPtr
     *
     * @since S60 v5.0
     * @param TPtr8&
     * @return none
     */
    IMPORT_C void GetPayloadPtr(TPtr8& aPayloadPtr);

    /**
     * GetBufferType
     *
     * @since S60 v5.0
     * @param TVoIPBufferType&
     * @return none
     */
    IMPORT_C void GetBufferType(TVoIPBufferType& aType);

protected:
    /**
     * Constructor
     *
     * @since S60 v5.0
     * @param none
     * @return none
     */
    CVoIPDataBuffer();

    /**
     * 2nd phase constructor
     *
     * @since S60 v5.0
     * @param CVoIPDataBufferImpl*
     * @return void
     */
    void ConstructL(CVoIPDataBufferImpl* aVoIPDataBufferImpl);

private:

    CVoIPDataBufferImpl* iVoIPDataBufferImpl;

    };

/**
 *  CVoIPJBDataBuffer
 *  ?description
 *
 */
class CVoIPJBDataBuffer : public CVoIPDataBuffer
    {
public:
    /**
     * Destructor
     *
     * @since S60 v5.0
     * @param none
     * @return none
     */
    IMPORT_C virtual ~CVoIPJBDataBuffer();

    /**
     * SetBufferSequence
     *
     * @since S60 v5.0
     * @param const TUint - between 0 and 0xFFFF
     * @return none
     */
    IMPORT_C void SetBufferSequence(const TUint aBufferSeq);

    /**
     * GetBufferSequence
     *
     * @since S60 v5.0
     * @param TUint& - between 0 and 0xFFFF
     * @return none
     */
    IMPORT_C void GetBufferSequence(TUint& aBufferSeq);

protected:
    /**
     * Constructor
     *
     * @since S60 v5.0
     * @param none
     * @return none
     */
    CVoIPJBDataBuffer();

    /**
     * 2nd phase constructor
     *
     * @since S60 v5.0
     * @param CVoIPJBDataBufferImpl*
     * @return void
     */
    void ConstructL(CVoIPJBDataBufferImpl* aVoIPJBDataBufferImpl);

private:

    CVoIPJBDataBufferImpl* iVoIPJBDataBufferImpl;

    };

#endif //__VOIPDATABUFFER_H

// End of file