mmsharing/livecommsui/lcui/tsrc/mustester/Stubs/mceclientstub/inc/mcefilesink.h
author Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
Tue, 31 Aug 2010 15:12:07 +0300
branchRCL_3
changeset 32 73a1feb507fb
permissions -rw-r--r--
Revision: 201032 Kit: 201035

/*
* Copyright (c) 2006 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 MCEFILESINK_H
#define MCEFILESINK_H

// INCLUDES
#include <e32std.h>  
#include <MceMediaSink.h>

// FORWARD DECLARATIONS

// DATA TYPES
const TMceSinkType KMceFileSink = 4;


// CLASS DECLARATION

/**
* Class representing file sink in Mce.
*
* CMceFileSink can be used to record a stream to the file. The file may consist of
* both audio and video data. If both media elements are available and should be
* recorded to the same file, the same file sink should be attached to audio stream
* and video stream. Recording only one of the media elements is possible as well.
*
* Enable (continue) and Disable (pause) operations to it are considered
* to be local, so they are not signalled to remote terminal.
* 
* @lib mceclient.lib
*/
class CMceFileSink : public CMceMediaSink
	{
	public: // Constructors and destructor

	    /**
	    * Two-phased constructor.
	    * @param aFileName name of the file including full path info
	    */
		IMPORT_C static CMceFileSink* NewL( const TFileName& aFileName );

	    /**
	    * Two-phased constructor.
	    * @param aFileName name of the file including full path info
	    */
		IMPORT_C static CMceFileSink* NewLC( const TFileName& aFileName );

	    /**
	    * Destructor.
	    */
		IMPORT_C ~CMceFileSink();


	public: // From CMceMediaSink

	    /**
	    * Enables the sink explicitly.
	    */
		IMPORT_C void EnableL(); 

	    /**
	    * Disables the sink explicitly.
	    */
		IMPORT_C void DisableL(); 	    
	    	    
	private:

	    /**
	    * C++ default constructor.
	    */
		CMceFileSink();

	    /**
	    * Second-phase constructor.
	    */
		void ConstructL( const TFileName& aFileName );
    
    public: // Stub data
    
        TFileName iFileName;
        
	};

#endif