|
1 /* |
|
2 * Copyright (c) 2004-2005 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 #ifndef MIPTVVODCONTENT_H |
|
22 #define MIPTVVODCONTENT_H |
|
23 |
|
24 // INCLUDES |
|
25 #include "CIptvUtil.h" |
|
26 |
|
27 // FORWARD DECLARATIONS |
|
28 class CIptvVodContentCategoryBriefDetails; |
|
29 class CIptvVodContentContentBriefDetails; |
|
30 class CIptvVodContentContentFullDetails; |
|
31 class CIptvMediaContent; |
|
32 |
|
33 // CLASS DECLARATION |
|
34 |
|
35 class MIptvVodContent |
|
36 { |
|
37 public: |
|
38 |
|
39 /** |
|
40 * Get list of ECG categories. |
|
41 * The order of categories is defined by database originated from service provider. |
|
42 * @since |
|
43 * @param aParentCategoryId Points to category ID which sub-categories should be listed. Use KIptvVodContentCategoryRootId if the root is referenced. |
|
44 * @param aCategoryList Reference to a storage where pointer to created category list is returned. |
|
45 * @return Error code, KErrNone if no errors, |
|
46 * KErrCouldNotConnect if server is needs permission for connection, otherwise one of the system wide error codes. |
|
47 */ |
|
48 virtual TInt GetEcgCategoryListL(TIptvCategoryId aParentCategoryId, RPointerArray<CIptvVodContentCategoryBriefDetails>& aCategoryList) = 0; |
|
49 |
|
50 /** |
|
51 * Get full detais of one category item. |
|
52 * @since Engine 1.1 |
|
53 * @param aCategoryId Selected category ID identifier. |
|
54 * @param aCategory Reference to a full details data returned. |
|
55 * @return Error code, KErrNone if no errors. |
|
56 */ |
|
57 virtual TInt GetCategoryDetailsL(TIptvCategoryId aCategoryId, CIptvVodContentCategoryBriefDetails& aCategory) = 0; |
|
58 |
|
59 /** |
|
60 * Get parent category ID identifier. |
|
61 * This method allows application to browse toward root category, then two consecutive calls are needed. |
|
62 * Note that root is KIptvVodContentCategoryRootId. |
|
63 * @since |
|
64 * @param aCategoryId Points to category ID which parent category is requested. |
|
65 * @param aParentId Reference to a storage where parent ID is returned. |
|
66 * @return Error code, KErrNone if no errors, |
|
67 * KErrCouldNotConnect if server is needs permission for connection, otherwise one of the system wide error codes. |
|
68 */ |
|
69 virtual TInt GetParentCategoryL(TIptvCategoryId aCategoryId, TIptvCategoryId& aParentId) = 0; |
|
70 |
|
71 /** |
|
72 * Get list of ECG contents in the specified category in order defined by database originated from service provider. |
|
73 * @since |
|
74 * @param aCategoryId Selected category ID identifier. Use KIptvVodContentCategoryRootId if the root is referenced. |
|
75 * @param aSearchString A search string used to filter contents search. If empty string, no filtering issued. |
|
76 * @param aFrom The start index for listed contents. |
|
77 * @param aAmount Amount of content elementes to be listes. If zero, all starting from aFrom. |
|
78 * @param aTotalAmount Poiter to a variable where total amount of content is returned. |
|
79 * @param aEcgList Reference to returned ECG list items. |
|
80 * @return Error code, KErrNone if no errors, |
|
81 * KErrCouldNotConnect if server is needs permission for connection, otherwise one of the system wide error codes. |
|
82 */ |
|
83 virtual TInt GetEcgListL(TIptvCategoryId aCategoryId, TDesC& aSearchString, TUint32 aFrom, TUint32 aAmount, TUint32& aTotalAmount, RPointerArray<CIptvVodContentContentBriefDetails>& aEcgList) = 0; |
|
84 |
|
85 /** |
|
86 * Get list of all ECG contents in alphabetical order. |
|
87 * @since |
|
88 * @param aSearchString A search string used to filter contents search. If empty string, no filtering issued. |
|
89 * @param aFrom The start index for listed contents. |
|
90 * @param aAmount Amount of content elementes to be listes. If zero, all starting from aFrom. |
|
91 * @param aTotalAmount Poiter to a variable where total amount of content is returned. |
|
92 * @param aEcgList Reference to returned ECG list items. |
|
93 * @return Error code, KErrNone if no errors, |
|
94 * KErrCouldNotConnect if server is needs permission for connection, otherwise one of the system wide error codes. |
|
95 */ |
|
96 virtual TInt GetEcgAllListL(TDesC& aSearchString, TUint32 aFrom, TUint32 aAmount, TUint32& aTotalAmount, RPointerArray<CIptvVodContentContentBriefDetails>& aEcgList) = 0; |
|
97 |
|
98 /** |
|
99 * Get full detais of one content item. |
|
100 * @since |
|
101 * @param aContentId Selected content ID identifier. |
|
102 * @param aContentFullDetails Reference to returned full details data. |
|
103 * @return Error code, KErrNone if no errors, |
|
104 * KErrCouldNotConnect if server is needs permission for connection, otherwise one of the system wide error codes. |
|
105 */ |
|
106 virtual TInt GetContentDetailsL(TIptvContentId aContentId, CIptvVodContentContentFullDetails& aContentFullDetails) = 0; |
|
107 |
|
108 /** |
|
109 * Set IAP for service. |
|
110 * @since |
|
111 * @return Error code, KErrNone if no errors, otherwise one of the system wide error codes. |
|
112 */ |
|
113 virtual TInt SetIapL(const TUint32 aIap) = 0; |
|
114 |
|
115 /** |
|
116 * Update Ecg. |
|
117 * @since |
|
118 * @return Error code, KErrNone if no errors, otherwise one of the system wide error codes. |
|
119 */ |
|
120 virtual TInt UpdateEcgL() = 0; |
|
121 |
|
122 /** |
|
123 * Get time when service was last updated. |
|
124 * @since |
|
125 * @param aTime Reference to TTime object. |
|
126 * @return Error code, KErrNone if no errors, otherwise one of the system wide error codes. |
|
127 */ |
|
128 virtual TInt GetUpdateTimeL(TTime& aTime) = 0; |
|
129 |
|
130 /** |
|
131 * Get content access objects belonging to given content. |
|
132 * @since Engine 1.1 |
|
133 * @param aContentId Content id |
|
134 * @param aCAList Content access list. |
|
135 * @return Error code, KErrNone if no errors, otherwise one of the system wide error codes. |
|
136 */ |
|
137 virtual TInt GetContentAccessListL(TUint32 aContentId, RPointerArray<CIptvMediaContent>& aCAList) = 0; |
|
138 |
|
139 /** |
|
140 * Set last play position to content access. |
|
141 * @since Engine 1.1 |
|
142 * @param aContentId Content id |
|
143 * @param aIndex Content access index (id). |
|
144 * @param aPosition Position. |
|
145 * @return Error code, KErrNone if no errors, otherwise one of the system wide error codes. |
|
146 */ |
|
147 virtual TInt SetLastPositionL(TUint32 aContentId, TUint32 aIndex, TUint32 aPosition) = 0; |
|
148 |
|
149 /** |
|
150 * Set Mpx media id |
|
151 * @param aContentId Content id |
|
152 * @param aCaIndex Content access index (id). |
|
153 * @param aMpxId Mpx id. |
|
154 * @return Error code. |
|
155 */ |
|
156 virtual TInt SetMpxIdL( TUint32 aContentId, |
|
157 TUint32 aCaIndex, |
|
158 TUint32 aMpxId ) = 0; |
|
159 }; |
|
160 |
|
161 #endif // MIPTVVODCONTENT_H |
|
162 |
|
163 // End of File |