videofeeds/clientapi/inc/CIptvVodDlDownloadListItem.h
changeset 0 96612d01cf9f
equal deleted inserted replaced
-1:000000000000 0:96612d01cf9f
       
     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 the License "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 
       
    22 #ifndef CIPTVVODDLDOWNLOADLISTITEM_H
       
    23 #define CIPTVVODDLDOWNLOADLISTITEM_H
       
    24 
       
    25 //  INCLUDES
       
    26 #include <e32base.h>
       
    27 #include "CIptvUtil.h"
       
    28 
       
    29 // CONSTANTS
       
    30 
       
    31 // MACROS
       
    32 
       
    33 // DATA TYPES
       
    34 
       
    35 // FUNCTION PROTOTYPES
       
    36 
       
    37 // FORWARD DECLARATIONS
       
    38 class RReadStream;
       
    39 class RWriteStream;
       
    40 class CIptvMyVideosGlobalFileId;
       
    41 
       
    42 // CLASS DECLARATION
       
    43 
       
    44 /**
       
    45 *  Used with CIptvVodDlDownloadList. Contains information about a single download in VOD DL manager.
       
    46 *
       
    47 *  @lib IptvClientApi.lib
       
    48 */
       
    49 class CIptvVodDlDownloadListItem : public CBase
       
    50     {
       
    51     public:  // Constructors and destructor
       
    52         
       
    53         /**
       
    54         * Two-phased constructor.
       
    55         */
       
    56         IMPORT_C static CIptvVodDlDownloadListItem* NewL();
       
    57         
       
    58         /**
       
    59         * Destructor.
       
    60         */
       
    61         IMPORT_C virtual ~CIptvVodDlDownloadListItem();
       
    62 
       
    63     public: // New functions
       
    64         
       
    65         /**
       
    66         * Initializes this object from stream.
       
    67         * @param aStream stream to read data from
       
    68         */
       
    69         IMPORT_C void InternalizeL(RReadStream& aStream);
       
    70 
       
    71         /**
       
    72         * Writes this object to stream.
       
    73         * @param aStream stream to write data to.
       
    74         */
       
    75         IMPORT_C void ExternalizeL(RWriteStream& aStream);
       
    76 
       
    77         /**
       
    78         * Counts externalize size.
       
    79         * @param aStream stream to read data from
       
    80         */
       
    81         IMPORT_C TUint32 CountExternalizeSize();
       
    82         
       
    83 
       
    84     private:
       
    85 
       
    86         /**
       
    87         * C++ default constructor.
       
    88         */
       
    89         CIptvVodDlDownloadListItem();
       
    90 
       
    91         /**
       
    92         * By default Symbian 2nd phase constructor is private.
       
    93         */
       
    94         void ConstructL();
       
    95 
       
    96     public:     // Data
       
    97 
       
    98         /**
       
    99         * Global file ID in My Videos database.
       
   100         */    
       
   101         CIptvMyVideosGlobalFileId* iGlobalFileId;
       
   102 
       
   103         /**
       
   104         * If ETrue, iGlobalFileId won't change anymore.
       
   105         */
       
   106         TBool                      iGlobalFileIdIsValid;
       
   107 
       
   108         /**
       
   109         * Identifies the service in the Service database.
       
   110         */    
       
   111         TUint32                    iServiceId;
       
   112         
       
   113         /**
       
   114         * Identifies content in EPG database.
       
   115         */    
       
   116         TUint32                    iContentId;
       
   117 
       
   118         /**
       
   119         * Content index in EPG database.
       
   120         */    
       
   121         TUint32                    iContentIndex;
       
   122         
       
   123         /**
       
   124         * Identifies accesspoint in CommsDB.
       
   125         */    
       
   126         TUint32                    iIapId;
       
   127         
       
   128         /**
       
   129         * Download type. See possible values from CIptvUtil.h.
       
   130         */    
       
   131         TIptvDownloadType          iDlType;
       
   132         
       
   133         /**
       
   134         * Download progress in percentages.
       
   135         */    
       
   136         TUint32                    iProgress;
       
   137         
       
   138         /**
       
   139         * Download state, see possible states from CIptvUtil.h
       
   140         */    
       
   141         TUint32                    iState;
       
   142         
       
   143         /**
       
   144         * In case of error (iState = KIptvVodDlDownloadFailed) contains error code.
       
   145         * See possible codes from CIptvUtil.h.
       
   146         */    
       
   147         TIptvDlError               iError;        
       
   148 
       
   149     };
       
   150 
       
   151 #endif      // CIPTVVODDLDOWNLOADLISTITEM_H   
       
   152             
       
   153 // End of File