mmsharinguis_plat/live_comms_plugin_api/inc/lcsourcefilecontrol.h
branchRCL_3
changeset 33 bc78a40cd63c
parent 32 73a1feb507fb
child 35 6c57ef9392d2
equal deleted inserted replaced
32:73a1feb507fb 33:bc78a40cd63c
     1 /*
       
     2 * Copyright (c) 2009 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 #ifndef MLCSOURCEFILECONTROL_H
       
    19 #define MLCSOURCEFILECONTROL_H
       
    20 
       
    21 // INCLUDES
       
    22 #include <e32std.h>
       
    23 
       
    24 // CLASS DECLARATION
       
    25 /**
       
    26 * Class for controlling the usage of a source file for a player.
       
    27 */
       
    28 class MLcSourceFileControl
       
    29     {
       
    30     public: 
       
    31         
       
    32         /**
       
    33         * Sets the name of the source file.
       
    34         * @param aFileName the file name
       
    35         */
       
    36         virtual void SetLcFileNameL( const TFileName& aFileName ) = 0;
       
    37         
       
    38         /**
       
    39         * Returns the name of the source file.
       
    40         * @return the file name
       
    41         */
       
    42         virtual TFileName& LcFileName() = 0;
       
    43  
       
    44         /**
       
    45         * Starts or stops fast forwarding the file. 
       
    46         * The file is left paused after stopping the fast forwarding.
       
    47         * @param aUseFFWD ETrue to start FFWD, EFalse to stop it.
       
    48         */       
       
    49         virtual void LcFastForwardL( TBool aUseFFWD ) = 0;
       
    50 
       
    51         /**
       
    52         * Starts or stops fast rewinding the file. 
       
    53         * The file is left paused after stopping the fast rewinding.
       
    54         * @param aUseFRWD ETrue to start FRWD, EFalse to stop it.
       
    55         */        
       
    56         virtual void LcFastRewindL( TBool aUseFRWD ) = 0;
       
    57 
       
    58         /**
       
    59         * Returns duration of the file as time interval.
       
    60         * @return the duration of the file
       
    61         */        
       
    62         virtual TTimeIntervalSeconds LcFileDurationL() = 0;
       
    63         
       
    64         /**
       
    65         * Returns current file position as time interval.
       
    66         * @return the current position
       
    67         */        
       
    68         virtual TTimeIntervalSeconds LcFilePositionL() = 0;
       
    69 
       
    70         /**
       
    71         * Sets the file position as time interval.
       
    72         * @param aPosition the new position
       
    73         */ 
       
    74         virtual void SetLcFilePositionL( 
       
    75             const TTimeIntervalSeconds& aPosition ) = 0;       
       
    76     };
       
    77 
       
    78 #endif // MLCSOURCEFILECONTROL_H
       
    79 
       
    80 // end of file