multimediacommsengine/mmceshared/inc/mcecomvideostream.h
author Paulius Meskauskas <paulius.meskauskas@nokia.com>
Tue, 14 Sep 2010 11:27:31 +0300
changeset 52 04d0e3761c38
parent 0 1bce908db942
permissions -rw-r--r--
Added API documentation and example code.

/*
* Copyright (c) 2005 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:    
*
*/




#ifndef CMCECOMVIDEOSTREAM_H
#define CMCECOMVIDEOSTREAM_H

#include <e32std.h>  		
#include "mcecommediastream.h"

// FORWARD DECLARATIONS

class CMceComVideoCodec;

/**
 * 
 *
 * @lib 
 */
class CMceComVideoStream: public CMceComMediaStream
	{

public: // Constructors and destructor

    /**
    * Constructor
    */
    static CMceComVideoStream* NewL();

    /**
    * Constructor
    */
    static CMceComVideoStream* NewLC();

    /**
    * Destructor.
    */
	~CMceComVideoStream();

public: // Functions

    /**
    * Adds codec to the stream.
    * @param aCodec codec to be added to the stream.
	*	     Ownership is transferred.
    */
	void AddCodecL( CMceComCodec* aCodec);
     
     
    /**
    * Removes codec from the stream.
    * @param aCodec codec to be added to the stream.
	*	     Ownership is transferred.
    */
    void RemoveCodecL( CMceComCodec* aCodec );

	/**
	* Return pointer to codec from the list of codecs.
	* aIndex index of codec to get.
	*/
	CMceComVideoCodec* CodecL( TInt aIndex ) const;

	/**
	* Returns number of codecs in the stream.
	*/
	TInt CodecCount() const;

    /**
    * Returns the available codecs to the session.
    * @return codecs available for the session.
    */
	const RPointerArray<CMceComVideoCodec>& Codecs() const;

public: // serialization


    /**
    * Internalizes flat data
    * @param aReadStream read stream
    */
    void InternalizeFlatL( RReadStream& aReadStream );

    /**
    * Externalizes flat data
    * @param aWriteStream write stream
    */
    void ExternalizeFlatL( RWriteStream& aWriteStream );
    
    /**
    * Internalizes
    * @param aReadStream read stream
    */
    void InternalizeL( MMceComSerializationContext& aSerCtx );
    
    /**
    * Externalizes
    * @param aWriteStream write stream
    */
    void ExternalizeL( MMceComSerializationContext& aSerCtx );


public://from CMceComMediaStream


    /**
    * Initializes 
    * @param aParent the parent
    */
    void InitializeL( CMceComSession& aParent );

    /**
    * Updates 
    * @param aStream new stream
    */
    void UpdateL( CMceComMediaStream& aStream );

    /**
    * Clones
    */
    CMceComMediaStream* CloneL();
    
    void ReorderCodecs();
    
protected: // Functions

    /**
    * Constructor
    */
	CMceComVideoStream();
	
    /**
    * second-phase constructor
    */
	void ConstructL();
	
    /**
     * second-phase copy constructor
     */
	void ConstructL( CMceComVideoStream& aStream );
	
    /**
    * Searches for codec matching with input codec instance or sdp name
    * @param aCodec the search term
    * @return matching codec or NULL if not found
    */
    CMceComCodec* FindCodecL( CMceComCodec& aCodec );

	/**
	* Find index of codec in the list of codecs.
	* aCodec codec to search for.
	*/
	TInt FindCodecFromList( CMceComCodec* aCodec) const;
	
	/**
	* Removes a codec from the list of codecs.
	* @param aIndex index of codec to be removed.
	*/
	void RemoveCodecFromListL( TInt aIndex );

	/**
	* Clears list of codecs and deletes each codec in it.
	*/
	void DestroyCodecs();
    

#ifdef MCE_COMMON_SERVER_SIDE
    
protected:


    /**
    * Synchronizes stream's codecs
    * @param aRoleAnswerer is answerer
    */
    void SynchronizeL( TBool aRoleAnswerer );
       
    /**
    * Update default codec to reflect current negotiation
    */
    void UpdateDefaultCodecL();

    /**
    * Prepares stream for offer/answer
    */
    void PrepareL();
   
    /**
    * Return mcc stream type
    * @return mcc stream type
    */
    TInt MccStreamType() const;

    /**
    * Return mcc link type
    * @return mcc link type
    */
    TInt MccLinkType() const;
    
    /**
    * Update default codecs of associated local streams to reflect
    * current negotiation
    */
    void UpdateDefaultCodecForAssociatedLocalL( CMceComCodec* aNewDefaultCodec );


#endif//MCE_COMMON_SERVER_SIDE	

protected: // Owned data

    /**
     * codecs
     */
	RPointerArray<CMceComVideoCodec> iCodecs;

#ifdef EUNIT_TEST
    friend class UT_CMceComVideoStream;
    friend class UT_CMceMediaSdpCodec;
    friend class UT_CMceVideoSdpCodec;
#endif
	};



#endif