msg_plat/smil_engine_api/inc/smilactiveinterface.h
changeset 0 72b543305e3a
equal deleted inserted replaced
-1:000000000000 0:72b543305e3a
       
     1 /*
       
     2 * Copyright (c) 2003 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: smilactiveinterface  declaration
       
    15 *
       
    16 */
       
    17 
       
    18 
       
    19 
       
    20 #ifndef SMILACTIVE_H
       
    21 #define SMILACTIVE_H
       
    22 
       
    23 //  INCLUDES
       
    24 #include <e32base.h>
       
    25 
       
    26 #include <smiltime.h>
       
    27 
       
    28 // FORWARD DECLARATIONS
       
    29 class CSmilObject;
       
    30 class CSmilPresentation;
       
    31 
       
    32 // CLASS DECLARATION
       
    33 /**
       
    34  * This interface provides SMIL engine generated timing for components
       
    35  * outside SMIL engine. This allows accurate synchronization of external 
       
    36  * components to the SMIL engine clock. For example, this interface may
       
    37  * be used in media renderer to implement animation, for example 
       
    38  * animated GIFs. The interface is used inside the SMIL engine to 
       
    39  * provide timing for transition effects.
       
    40  * 
       
    41  * To use this interface, the using component inherits it and implements
       
    42  * ActivateL() method. By using MSmilMedia::AfterL() method the
       
    43  * component can request a delay of specific duration. ActivateL() is
       
    44  *  called when this duration has passed in SMIL presentation timeline.
       
    45  * In real time, this might take longer than the requested time, for example 
       
    46  * if the presentation is paused.
       
    47   */
       
    48 class MSmilActive 
       
    49     {
       
    50 protected:  
       
    51 
       
    52 	/**
       
    53 	* Called when the requested time has been reached. The current time, relative to the requesting media obect, is passed as parameter.
       
    54 	*/
       
    55 	virtual void ActivateL(const TSmilTime& aTime) = 0;
       
    56 
       
    57 public:  
       
    58 
       
    59 	CSmilObject* iSmilObject;
       
    60 	friend class CSmilPresentation;
       
    61 	};
       
    62 
       
    63 #endif      // ?INCLUDE_H   
       
    64             
       
    65 // End of File