1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>pvplayer_engine: pv_player_interface.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.6.3 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="annotated.html"><span>Data Structures</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="files.html"><span>File List</span></a></li>
</ul>
</div>
<h1>pv_player_interface.h</h1><a href="pv__player__interface_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/*</span>
<a name="l00002"></a>00002 <span class="comment">* ==============================================================================</span>
<a name="l00003"></a>00003 <span class="comment">* Name : pv_player_interface.h</span>
<a name="l00004"></a>00004 <span class="comment">* Part of :</span>
<a name="l00005"></a>00005 <span class="comment">* Interface :</span>
<a name="l00006"></a>00006 <span class="comment">* Description : Interface class and supporting definitions for the pvPlayer engine</span>
<a name="l00007"></a>00007 <span class="comment">* Version : (see RELEASE field in copyright header above)</span>
<a name="l00008"></a>00008 <span class="comment">*</span>
<a name="l00009"></a>00009 <span class="comment">* ==============================================================================</span>
<a name="l00010"></a>00010 <span class="comment">*/</span>
<a name="l00011"></a>00011
<a name="l00012"></a>00012 <span class="preprocessor">#ifndef PV_PLAYER_INTERFACE_H_INCLUDED</span>
<a name="l00013"></a>00013 <span class="preprocessor"></span><span class="preprocessor">#define PV_PLAYER_INTERFACE_H_INCLUDED</span>
<a name="l00014"></a>00014 <span class="preprocessor"></span>
<a name="l00015"></a>00015
<a name="l00016"></a>00016 <span class="comment">// INCLUDES</span>
<a name="l00017"></a>00017 <span class="preprocessor">#ifndef OSCL_BASE_H_INCLUDED</span>
<a name="l00018"></a>00018 <span class="preprocessor"></span><span class="preprocessor">#include "oscl_base.h"</span>
<a name="l00019"></a>00019 <span class="preprocessor">#endif</span>
<a name="l00020"></a>00020 <span class="preprocessor"></span>
<a name="l00021"></a>00021 <span class="preprocessor">#ifndef OSCL_STRING_H_INCLUDED</span>
<a name="l00022"></a>00022 <span class="preprocessor"></span><span class="preprocessor">#include "oscl_string.h"</span>
<a name="l00023"></a>00023 <span class="preprocessor">#endif</span>
<a name="l00024"></a>00024 <span class="preprocessor"></span>
<a name="l00025"></a>00025 <span class="preprocessor">#ifndef OSCL_VECTOR_H_INCLUDED</span>
<a name="l00026"></a>00026 <span class="preprocessor"></span><span class="preprocessor">#include "oscl_vector.h"</span>
<a name="l00027"></a>00027 <span class="preprocessor">#endif</span>
<a name="l00028"></a>00028 <span class="preprocessor"></span>
<a name="l00029"></a>00029 <span class="preprocessor">#ifndef OSCL_MEM_H_INCLUDED</span>
<a name="l00030"></a>00030 <span class="preprocessor"></span><span class="preprocessor">#include "oscl_mem.h"</span>
<a name="l00031"></a>00031 <span class="preprocessor">#endif</span>
<a name="l00032"></a>00032 <span class="preprocessor"></span>
<a name="l00033"></a>00033 <span class="preprocessor">#ifndef PVLOGGER_H_INCLUDED</span>
<a name="l00034"></a>00034 <span class="preprocessor"></span><span class="preprocessor">#include "pvlogger.h"</span>
<a name="l00035"></a>00035 <span class="preprocessor">#endif</span>
<a name="l00036"></a>00036 <span class="preprocessor"></span>
<a name="l00037"></a>00037 <span class="preprocessor">#ifndef PVMF_RETURN_CODES_H_INCLUDED</span>
<a name="l00038"></a>00038 <span class="preprocessor"></span><span class="preprocessor">#include "pvmf_return_codes.h"</span>
<a name="l00039"></a>00039 <span class="preprocessor">#endif</span>
<a name="l00040"></a>00040 <span class="preprocessor"></span>
<a name="l00041"></a>00041 <span class="preprocessor">#ifndef PV_ENGINE_TYPES_H_INCLUDED</span>
<a name="l00042"></a>00042 <span class="preprocessor"></span><span class="preprocessor">#include "pv_engine_types.h"</span>
<a name="l00043"></a>00043 <span class="preprocessor">#endif</span>
<a name="l00044"></a>00044 <span class="preprocessor"></span>
<a name="l00045"></a>00045 <span class="preprocessor">#ifndef PV_PLAYER_TYPES_H_INCLUDED</span>
<a name="l00046"></a>00046 <span class="preprocessor"></span><span class="preprocessor">#include "pv_player_types.h"</span>
<a name="l00047"></a>00047 <span class="preprocessor">#endif</span>
<a name="l00048"></a>00048 <span class="preprocessor"></span>
<a name="l00049"></a>00049 <span class="preprocessor">#ifndef PV_PLAYER_EVENTS_H_INCLUDED</span>
<a name="l00050"></a>00050 <span class="preprocessor"></span><span class="preprocessor">#include "pv_player_events.h"</span>
<a name="l00051"></a>00051 <span class="preprocessor">#endif</span>
<a name="l00052"></a>00052 <span class="preprocessor"></span>
<a name="l00053"></a>00053 <span class="preprocessor">#ifndef PV_PLAYER_DATASOURCE_H_INCLUDED</span>
<a name="l00054"></a>00054 <span class="preprocessor"></span><span class="preprocessor">#include "pv_player_datasource.h"</span>
<a name="l00055"></a>00055 <span class="preprocessor">#endif</span>
<a name="l00056"></a>00056 <span class="preprocessor"></span>
<a name="l00057"></a>00057 <span class="preprocessor">#ifndef PV_PLAYER_DATASINK_H_INCLUDED</span>
<a name="l00058"></a>00058 <span class="preprocessor"></span><span class="preprocessor">#include "pv_player_datasink.h"</span>
<a name="l00059"></a>00059 <span class="preprocessor">#endif</span>
<a name="l00060"></a>00060 <span class="preprocessor"></span>
<a name="l00061"></a>00061 <span class="preprocessor">#ifndef PVMI_KVP_H_INCLUDED</span>
<a name="l00062"></a>00062 <span class="preprocessor"></span><span class="preprocessor">#include "pvmi_kvp.h"</span>
<a name="l00063"></a>00063 <span class="preprocessor">#endif</span>
<a name="l00064"></a>00064 <span class="preprocessor"></span>
<a name="l00065"></a>00065 <span class="preprocessor">#ifndef PVMF_MEDIA_CLOCK_H_INCLUDED</span>
<a name="l00066"></a><a class="code" href="classPVPlayerInterface.html#a675501e8969781fb71c0736c6315de8f">00066</a> <span class="preprocessor"></span><span class="preprocessor">#include "pvmf_media_clock.h"</span>
<a name="l00067"></a>00067 <span class="preprocessor">#endif</span>
<a name="l00068"></a>00068 <span class="preprocessor"></span>
<a name="l00069"></a>00069
<a name="l00070"></a>00070 <span class="comment">// CLASS DECLARATION</span>
<a name="l00077"></a><a class="code" href="classPVPlayerInterface.html">00077</a> <span class="comment"></span><span class="keyword">class </span><a class="code" href="classPVPlayerInterface.html">PVPlayerInterface</a>
<a name="l00078"></a>00078 {
<a name="l00079"></a>00079 <span class="keyword">public</span>:
<a name="l00080"></a>00080
<a name="l00085"></a>00085 <span class="keyword">virtual</span> <a class="code" href="classPVPlayerInterface.html#a675501e8969781fb71c0736c6315de8f">~PVPlayerInterface</a>() {};
<a name="l00086"></a>00086
<a name="l00104"></a>00104 <span class="keyword">virtual</span> PVCommandId <a class="code" href="classPVPlayerInterface.html#acfc31ff9055f7cfaad4a0da976afd1d6">GetSDKModuleInfo</a>(PVSDKModuleInfo &aSDKModuleInfo, <span class="keyword">const</span> OsclAny* aContextData = NULL) = 0;
<a name="l00105"></a>00105
<a name="l00128"></a>00128 <span class="keyword">virtual</span> PVCommandId <a class="code" href="classPVPlayerInterface.html#a814cf3ec39f5780da14acafa379b0900">SetLogAppender</a>(<span class="keyword">const</span> <span class="keywordtype">char</span>* aTag, OsclSharedPtr<PVLoggerAppender>& aAppender, <span class="keyword">const</span> OsclAny* aContextData = NULL) = 0;
<a name="l00129"></a>00129
<a name="l00149"></a>00149 <span class="keyword">virtual</span> PVCommandId <a class="code" href="classPVPlayerInterface.html#a53125b6f10a6ae2e14f5dcf1b1aa222d">RemoveLogAppender</a>(<span class="keyword">const</span> <span class="keywordtype">char</span>* aTag, OsclSharedPtr<PVLoggerAppender>& aAppender, <span class="keyword">const</span> OsclAny* aContextData = NULL) = 0;
<a name="l00150"></a>00150
<a name="l00174"></a>00174 <span class="keyword">virtual</span> PVCommandId <a class="code" href="classPVPlayerInterface.html#a4e1846a075d63a140cfe470aa8f532a6">SetLogLevel</a>(<span class="keyword">const</span> <span class="keywordtype">char</span>* aTag, int32 aLevel, <span class="keywordtype">bool</span> aSetSubtree = <span class="keyword">false</span>, <span class="keyword">const</span> OsclAny* aContextData = NULL) = 0;
<a name="l00175"></a>00175
<a name="l00194"></a>00194 <span class="keyword">virtual</span> PVCommandId <a class="code" href="classPVPlayerInterface.html#aa89568064eb62c675b44d7dc0c5f7ff3">GetLogLevel</a>(<span class="keyword">const</span> <span class="keywordtype">char</span>* aTag, PVLogLevelInfo& aLogInfo, <span class="keyword">const</span> OsclAny* aContextData = NULL) = 0;
<a name="l00195"></a>00195
<a name="l00216"></a>00216 <span class="keyword">virtual</span> PVCommandId <a class="code" href="classPVPlayerInterface.html#ac7c54fc8feadf1a59b7827870ebbf4c0">QueryInterface</a>(<span class="keyword">const</span> PVUuid& aUuid, PVInterface*& aInterfacePtr, <span class="keyword">const</span> OsclAny* aContextData = NULL) = 0;
<a name="l00217"></a>00217
<a name="l00234"></a>00234 <span class="keyword">virtual</span> PVCommandId <a class="code" href="classPVPlayerInterface.html#ad3f18906ca6895a8ff42858ef3d47a27">CancelCommand</a>(PVCommandId aCancelCmdId, <span class="keyword">const</span> OsclAny* aContextData = NULL) = 0;
<a name="l00235"></a>00235
<a name="l00247"></a>00247 <span class="keyword">virtual</span> PVCommandId <a class="code" href="classPVPlayerInterface.html#a3c097b05283b38b49ce2a3fac79d8128">CancelAllCommands</a>(<span class="keyword">const</span> OsclAny* aContextData = NULL) = 0;
<a name="l00248"></a>00248
<a name="l00263"></a>00263 <span class="keyword">virtual</span> PVCommandId <a class="code" href="classPVPlayerInterface.html#afc17bf49f411edf4820d7fca327d6172">GetPVPlayerState</a>(PVPlayerState& aState, <span class="keyword">const</span> OsclAny* aContextData = NULL) = 0;
<a name="l00264"></a>00264
<a name="l00275"></a>00275 <span class="keyword">virtual</span> PVMFStatus <a class="code" href="classPVPlayerInterface.html#a2aee1c69bb2265379aecd05787a4dd02">GetPVPlayerStateSync</a>(PVPlayerState& aState) = 0;
<a name="l00276"></a>00276
<a name="l00294"></a>00294 <span class="keyword">virtual</span> PVCommandId <a class="code" href="classPVPlayerInterface.html#a204d0c4b0cbe2827c3ed929f964c9d74">AddDataSource</a>(PVPlayerDataSource& aDataSource, <span class="keyword">const</span> OsclAny* aContextData = NULL) = 0;
<a name="l00295"></a>00295
<a name="l00312"></a>00312 <span class="keyword">virtual</span> PVCommandId <a class="code" href="classPVPlayerInterface.html#ad915478a764d1e24ee20e5cc1abdf099">UpdateDataSource</a>(PVPlayerDataSource& aDataSource, <span class="keyword">const</span> OsclAny* aContextData = NULL) = 0;
<a name="l00313"></a>00313
<a name="l00331"></a>00331 <span class="keyword">virtual</span> PVCommandId <a class="code" href="classPVPlayerInterface.html#ab1102ea132c162fe16c619323ff6cc3a">Init</a>(<span class="keyword">const</span> OsclAny* aContextData = NULL) = 0;
<a name="l00332"></a>00332
<a name="l00364"></a>00364 <span class="keyword">virtual</span> PVCommandId <a class="code" href="classPVPlayerInterface.html#af766cc88b9e9a4a2e41aea3ce178e380">GetMetadataValues</a>(PVPMetadataList& aKeyList, int32 aStartingValueIndex, int32 aMaxValueEntries, int32& aNumAvailableValueEntries,
<a name="l00365"></a>00365 Oscl_Vector<PvmiKvp, OsclMemAllocator>& aValueList, <span class="keyword">const</span> OsclAny* aContextData = NULL,
<a name="l00366"></a>00366 <span class="keywordtype">bool</span> aMetadataValuesCopiedInCallBack = <span class="keyword">true</span>, uint32 aClipIndex = 0) = 0;
<a name="l00367"></a>00367
<a name="l00386"></a>00386 <span class="keyword">virtual</span> PVCommandId <a class="code" href="classPVPlayerInterface.html#ac8f1d4922feac7e27c69ea321d113f6b">ReleaseMetadataValues</a>(Oscl_Vector<PvmiKvp, OsclMemAllocator>& aValueList, <span class="keyword">const</span> OsclAny* aContextData = NULL,
<a name="l00387"></a>00387 uint32 aClipIndex = 0) = 0;
<a name="l00388"></a>00388
<a name="l00406"></a>00406 <span class="keyword">virtual</span> PVCommandId <a class="code" href="classPVPlayerInterface.html#a6850c85b53e85fbf29cef0656d507456">AddDataSink</a>(PVPlayerDataSink& aDataSink, <span class="keyword">const</span> OsclAny* aContextData = NULL) = 0;
<a name="l00407"></a>00407
<a name="l00447"></a>00447 <span class="keyword">virtual</span> PVCommandId <a class="code" href="classPVPlayerInterface.html#a4dd4a15e7391482c5bb9b393565f299e">SetPlaybackRange</a>(PVPPlaybackPosition aBeginPos, PVPPlaybackPosition aEndPos, <span class="keywordtype">bool</span> aQueueRange, <span class="keyword">const</span> OsclAny* aContextData = NULL,
<a name="l00448"></a>00448 <span class="keywordtype">bool</span> aSkipToRequestedPosition = <span class="keyword">true</span>, <span class="keywordtype">bool</span> aSeekToSyncPoint = <span class="keyword">true</span>) = 0;
<a name="l00449"></a>00449
<a name="l00470"></a>00470 <span class="keyword">virtual</span> PVCommandId <a class="code" href="classPVPlayerInterface.html#aed395e031598d2d787ee285a9ada76f2">GetPlaybackRange</a>(PVPPlaybackPosition &aBeginPos, PVPPlaybackPosition &aEndPos, <span class="keywordtype">bool</span> aQueued, <span class="keyword">const</span> OsclAny* aContextData = NULL) = 0;
<a name="l00471"></a>00471
<a name="l00487"></a>00487 <span class="keyword">virtual</span> PVCommandId <a class="code" href="classPVPlayerInterface.html#a343571f3fc8eb3b9e89a8b799f2c54b5">GetCurrentPosition</a>(PVPPlaybackPosition &aPos, <span class="keyword">const</span> OsclAny* aContextData = NULL) = 0;
<a name="l00488"></a>00488
<a name="l00521"></a>00521 <span class="keyword">virtual</span> PVCommandId <a class="code" href="classPVPlayerInterface.html#af2a760aaf363a66b7c3d4fb3938d340b">SetPlaybackRate</a>(int32 aRate, PVMFTimebase* aTimebase = NULL, <span class="keyword">const</span> OsclAny* aContextData = NULL) = 0;
<a name="l00522"></a>00522
<a name="l00546"></a>00546 <span class="keyword">virtual</span> PVCommandId <a class="code" href="classPVPlayerInterface.html#a05260638e26c1d9ec7a7a2d602dcfad0">GetPlaybackRate</a>(int32& aRate, PVMFTimebase*& aTimebase, <span class="keyword">const</span> OsclAny* aContextData = NULL) = 0;
<a name="l00547"></a>00547
<a name="l00567"></a>00567 <span class="keyword">virtual</span> PVCommandId <a class="code" href="classPVPlayerInterface.html#a89a7c418c51ea79c6fe6ef8e44793eea">GetPlaybackMinMaxRate</a>(int32& aMinRate, int32& aMaxRate, <span class="keyword">const</span> OsclAny* aContextData = NULL) = 0;
<a name="l00568"></a>00568
<a name="l00580"></a>00580 <span class="keyword">virtual</span> PVMFStatus <a class="code" href="classPVPlayerInterface.html#acb29a1feb906013757abc6e0234113ff">GetCurrentPositionSync</a>(PVPPlaybackPosition &aPos) = 0;
<a name="l00581"></a>00581
<a name="l00598"></a>00598 <span class="keyword">virtual</span> PVCommandId <a class="code" href="classPVPlayerInterface.html#afa06b1de938025013ef372a6bce9732f">Prepare</a>(<span class="keyword">const</span> OsclAny* aContextData = NULL) = 0;
<a name="l00599"></a>00599
<a name="l00614"></a>00614 <span class="keyword">virtual</span> PVCommandId <a class="code" href="classPVPlayerInterface.html#af0022fc7c9df8f9451f316daf65339fb">Start</a>(<span class="keyword">const</span> OsclAny* aContextData = NULL) = 0;
<a name="l00615"></a>00615
<a name="l00629"></a>00629 <span class="keyword">virtual</span> PVCommandId <a class="code" href="classPVPlayerInterface.html#a67edb06be32a790e2fa9658870d5ee2a">Pause</a>(<span class="keyword">const</span> OsclAny* aContextData = NULL) = 0;
<a name="l00630"></a>00630
<a name="l00645"></a>00645 <span class="keyword">virtual</span> PVCommandId <a class="code" href="classPVPlayerInterface.html#a9df7ed528024aee6279f20f04148b8be">Resume</a>(<span class="keyword">const</span> OsclAny* aContextData = NULL) = 0;
<a name="l00646"></a>00646
<a name="l00662"></a>00662 <span class="keyword">virtual</span> PVCommandId <a class="code" href="classPVPlayerInterface.html#a3fc658912aea50c69727d622ee36232a">Stop</a>(<span class="keyword">const</span> OsclAny* aContextData = NULL) = 0;
<a name="l00663"></a>00663
<a name="l00681"></a>00681 <span class="keyword">virtual</span> PVCommandId <a class="code" href="classPVPlayerInterface.html#ab2e2e2ce5cefa1549309a1bfb1e58d92">RemoveDataSink</a>(PVPlayerDataSink& aDataSink, <span class="keyword">const</span> OsclAny* aContextData = NULL) = 0;
<a name="l00682"></a>00682
<a name="l00698"></a>00698 <span class="keyword">virtual</span> PVCommandId <a class="code" href="classPVPlayerInterface.html#a6884207fbe3193bb35518860cbe97f4a">Reset</a>(<span class="keyword">const</span> OsclAny* aContextData = NULL) = 0;
<a name="l00699"></a>00699
<a name="l00717"></a>00717 <span class="keyword">virtual</span> PVCommandId <a class="code" href="classPVPlayerInterface.html#a3cd5e208c9cf9c37f31b1653dcec3eac">RemoveDataSource</a>(PVPlayerDataSource& aDataSource, <span class="keyword">const</span> OsclAny* aContextData = NULL) = 0;
<a name="l00718"></a>00718
<a name="l00728"></a>00728 OSCL_IMPORT_REF <span class="keyword">static</span> <span class="keywordtype">void</span> <a class="code" href="classPVPlayerInterface.html#afbd3c1afd05a530c484f4276fd65d400">GetSDKInfo</a>(PVSDKInfo& aSDKInfo);
<a name="l00729"></a>00729
<a name="l00730"></a>00730 };
<a name="l00731"></a>00731
<a name="l00732"></a>00732
<a name="l00733"></a>00733
<a name="l00734"></a>00734
<a name="l00735"></a>00735 <span class="preprocessor">#endif // PV_PLAYER_INTERFACE_H_INCLUDED</span>
</pre></div></div>
<hr size="1"><img src="pvlogo_small.jpg"><address style="align: right;"><small>PV Player Engine</small>
<address style="align: left;"><small>Posting Version: CORE_9.005.1.1 </small>
</small></address>
</body>
</html>
|
