ipappsrv_plat/multimedia_comms_api/inc/mcefilesink.h
changeset 0 1bce908db942
child 23 a297cbce4e85
equal deleted inserted replaced
-1:000000000000 0:1bce908db942
       
     1 /*
       
     2 * Copyright (c) 2006 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 #ifndef MCEFILESINK_H
       
    22 #define MCEFILESINK_H
       
    23 
       
    24 // INCLUDES
       
    25 #include <e32std.h>  
       
    26 #include <MceMediaSink.h>
       
    27 
       
    28 // FORWARD DECLARATIONS
       
    29 
       
    30 // DATA TYPES
       
    31 const TMceSinkType KMceFileSink = 4;
       
    32 
       
    33 
       
    34 // CLASS DECLARATION
       
    35 
       
    36 /**
       
    37 * Class representing file sink in Mce.
       
    38 *
       
    39 * CMceFileSink can be used to record a stream to the file. The file may consist of
       
    40 * both audio and video data. If both media elements are available and should be
       
    41 * recorded to the same file, the same file sink should be attached to audio stream
       
    42 * and video stream. Recording only one of the media elements is possible as well.
       
    43 *
       
    44 * Enable (continue) and Disable (pause) operations to it are considered
       
    45 * to be local, so they are not signalled to remote terminal.
       
    46 * 
       
    47 * @lib mceclient.lib
       
    48 */
       
    49 class CMceFileSink : public CMceMediaSink
       
    50 	{
       
    51 	public: // Constructors and destructor
       
    52 
       
    53 	    /**
       
    54 	    * Two-phased constructor.
       
    55 	    * @param aFileName name of the file including full path info
       
    56 	    */
       
    57 		IMPORT_C static CMceFileSink* NewL( const TFileName& aFileName );
       
    58 
       
    59 	    /**
       
    60 	    * Two-phased constructor.
       
    61 	    * @param aFileName name of the file including full path info
       
    62 	    */
       
    63 		IMPORT_C static CMceFileSink* NewLC( const TFileName& aFileName );
       
    64 
       
    65 	    /**
       
    66 	    * Destructor.
       
    67 	    */
       
    68 		IMPORT_C ~CMceFileSink();
       
    69 
       
    70 
       
    71 	public: // From CMceMediaSink
       
    72 
       
    73 	    /**
       
    74 	    * Enables the sink explicitly.
       
    75 	    */
       
    76 		IMPORT_C void EnableL(); 
       
    77 
       
    78 	    /**
       
    79 	    * Disables the sink explicitly.
       
    80 	    */
       
    81 		IMPORT_C void DisableL(); 	    
       
    82 
       
    83 	public: 
       
    84 
       
    85 	    /**
       
    86 	    * Two-phased constructor.
       
    87 	    */
       
    88 	    static CMceFileSink* NewL();
       
    89 
       
    90 	    /**
       
    91 	    * Two-phased constructor.
       
    92 	    */
       
    93 		static CMceFileSink* NewLC();
       
    94 
       
    95 
       
    96 	public: // internal from CMceMediaSink
       
    97 
       
    98 	    /**
       
    99 	    * Initializes 
       
   100 	    * @param aManager the manager. Ownership is NOT transferred
       
   101 	    */
       
   102 	    void InitializeL( CMceManager* aManager );
       
   103 	    	    
       
   104 	private:
       
   105 
       
   106 	    /**
       
   107 	    * C++ default constructor.
       
   108 	    */
       
   109 		CMceFileSink();
       
   110 
       
   111 	    /**
       
   112 	    * Second-phase constructor.
       
   113 	    */
       
   114 		void ConstructL( const TFileName& aFileName );
       
   115     
       
   116         void GetFileInfoL();
       
   117 
       
   118 	};
       
   119 
       
   120 #endif