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
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
|
<!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>Wt: Wt::WAbstractMedia Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
</head>
<body>
<div id="top"><!-- do not remove this div! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">Wt
 <span id="projectnumber">3.2.1</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- Generated by Doxygen 1.7.5.1 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="inherits.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespaceWt.html">Wt</a> </li>
<li class="navelem"><a class="el" href="classWt_1_1WAbstractMedia.html">WAbstractMedia</a> </li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#pub-types">Public Types</a> |
<a href="#pub-methods">Public Member Functions</a> </div>
<div class="headertitle">
<div class="title">Wt::WAbstractMedia Class Reference</div> </div>
</div>
<div class="contents">
<!-- doxytag: class="Wt::WAbstractMedia" --><!-- doxytag: inherits="Wt::WInteractWidget" -->
<p>Abstract baseclass for native media elements.
<a href="classWt_1_1WAbstractMedia.html#details">More...</a></p>
<p><code>#include <Wt/WAbstractMedia></code></p>
<div class="dynheader">
Inheritance diagram for Wt::WAbstractMedia:</div>
<div class="dyncontent">
<div class="center"><img src="classWt_1_1WAbstractMedia__inherit__graph.png" border="0" usemap="#Wt_1_1WAbstractMedia_inherit__map" alt="Inheritance graph"/></div>
<map name="Wt_1_1WAbstractMedia_inherit__map" id="Wt_1_1WAbstractMedia_inherit__map">
<area shape="rect" href="classWt_1_1WAudio.html" title="A widget that plays audio." alt="" coords="5,379,96,405"/><area shape="rect" href="classWt_1_1WVideo.html" title="A video-playing widget." alt="" coords="120,379,211,405"/><area shape="rect" href="classWt_1_1WInteractWidget.html" title="An abstract widget that can receive user-interface interaction." alt="" coords="36,229,180,256"/><area shape="rect" href="classWt_1_1WWebWidget.html" title="A base class for widgets with an HTML counterpart." alt="" coords="44,155,172,181"/><area shape="rect" href="classWt_1_1WWidget.html" title="The abstract base class for a user-interface component." alt="" coords="59,80,157,107"/><area shape="rect" href="classWt_1_1WObject.html" title="A base class for objects that participate in the signal/slot system." alt="" coords="60,5,156,32"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<p><a href="classWt_1_1WAbstractMedia-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-types"></a>
Public Types</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WAbstractMedia.html#a5a25922d875102bce7f295b88986a102">Options</a> { <a class="el" href="classWt_1_1WAbstractMedia.html#a5a25922d875102bce7f295b88986a102aaa22c5028f0561a520e5362ca346840b">Autoplay</a> = 1,
<a class="el" href="classWt_1_1WAbstractMedia.html#a5a25922d875102bce7f295b88986a102a6e93c0a4bbbd90c2cf121a0f2b6ae41f">Loop</a> = 2,
<a class="el" href="classWt_1_1WAbstractMedia.html#a5a25922d875102bce7f295b88986a102a08c3ddfc98b66a69be399198bf0ac16b">Controls</a> = 4
}</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Enumeration for playback options. <a href="classWt_1_1WAbstractMedia.html#a5a25922d875102bce7f295b88986a102">More...</a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WAbstractMedia.html#aa0285df6f72b088725a926354849ecb6">PreloadMode</a> { <a class="el" href="classWt_1_1WAbstractMedia.html#aa0285df6f72b088725a926354849ecb6aaf6f9bbb92981ac31c2d874483ca3528">PreloadNone</a>,
<a class="el" href="classWt_1_1WAbstractMedia.html#aa0285df6f72b088725a926354849ecb6a4b5ea61e62e704ea152cdb360f81f571">PreloadAuto</a>,
<a class="el" href="classWt_1_1WAbstractMedia.html#aa0285df6f72b088725a926354849ecb6a08fa52aba2bec649a45c2c80a0087d20">PreloadMetadata</a>
}</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Enumeration for preload strategy. <a href="classWt_1_1WAbstractMedia.html#aa0285df6f72b088725a926354849ecb6">More...</a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WAbstractMedia.html#acabdc224f494c1c9f80758d2c31f3f1f">ReadyState</a> { <br/>
  <a class="el" href="classWt_1_1WAbstractMedia.html#acabdc224f494c1c9f80758d2c31f3f1fac1b8d00f1cb2edbd826e2e471b67cf7a">HaveNothing</a> = 0,
<a class="el" href="classWt_1_1WAbstractMedia.html#acabdc224f494c1c9f80758d2c31f3f1faa50d2bf2fc67dae41ea42839dc69525e">HaveMetaData</a> = 1,
<a class="el" href="classWt_1_1WAbstractMedia.html#acabdc224f494c1c9f80758d2c31f3f1fa340653b8e1af13e1e8f6b0f6d6ffcb78">HaveCurrentData</a> = 2,
<a class="el" href="classWt_1_1WAbstractMedia.html#acabdc224f494c1c9f80758d2c31f3f1fa6d94e2b35e9bdb49ce88baa2f9b6195b">HaveFutureData</a> = 3,
<br/>
  <a class="el" href="classWt_1_1WAbstractMedia.html#acabdc224f494c1c9f80758d2c31f3f1fa24d6067cfc2900ac6a31d99bd3dc8f54">HaveEnoughData</a> = 4
<br/>
}</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The HTML5 media ReadyState flag indicates how much of the media is loaded. <a href="classWt_1_1WAbstractMedia.html#acabdc224f494c1c9f80758d2c31f3f1f">More...</a><br/></td></tr>
<tr><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WAbstractMedia.html#a1febdb153786dab906e473e4f908739b">WAbstractMedia</a> (<a class="el" href="classWt_1_1WContainerWidget.html">WContainerWidget</a> *parent=0)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Consctructor for a media widget. <a href="#a1febdb153786dab906e473e4f908739b"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WAbstractMedia.html#a503c27a4a854d69606ca34de88c2bf98">setOptions</a> (const WFlags< <a class="el" href="classWt_1_1WAbstractMedia.html#a5a25922d875102bce7f295b88986a102">Options</a> > &flags)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the media element options. <a href="#a503c27a4a854d69606ca34de88c2bf98"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a516be74718fdf639ec29ffab488cb069"></a><!-- doxytag: member="Wt::WAbstractMedia::getOptions" ref="a516be74718fdf639ec29ffab488cb069" args="() const " -->
WFlags< <a class="el" href="classWt_1_1WAbstractMedia.html#a5a25922d875102bce7f295b88986a102">Options</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WAbstractMedia.html#a516be74718fdf639ec29ffab488cb069">getOptions</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Retrieve the configured options. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ada703e988ddc6116ce0bcee2a6c4dd5d"></a><!-- doxytag: member="Wt::WAbstractMedia::setPreloadMode" ref="ada703e988ddc6116ce0bcee2a6c4dd5d" args="(PreloadMode mode)" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WAbstractMedia.html#ada703e988ddc6116ce0bcee2a6c4dd5d">setPreloadMode</a> (<a class="el" href="classWt_1_1WAbstractMedia.html#aa0285df6f72b088725a926354849ecb6">PreloadMode</a> mode)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the preload mode. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a743480e2db4bc967fb1abe27dd8101ac"></a><!-- doxytag: member="Wt::WAbstractMedia::preloadMode" ref="a743480e2db4bc967fb1abe27dd8101ac" args="() const " -->
<a class="el" href="classWt_1_1WAbstractMedia.html#aa0285df6f72b088725a926354849ecb6">PreloadMode</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WAbstractMedia.html#a743480e2db4bc967fb1abe27dd8101ac">preloadMode</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Retrieve the preload mode. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WAbstractMedia.html#ac70b946b707a8596d2f0bbcb3ae8f807">clearSources</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Removes all source elements. <a href="#ac70b946b707a8596d2f0bbcb3ae8f807"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WAbstractMedia.html#ae0bdedcd0136a29c05218ecab25dfa82">addSource</a> (const <a class="el" href="classWt_1_1WLink.html">WLink</a> &source, const std::string &type="", const std::string &media="")</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Add a media source. <a href="#ae0bdedcd0136a29c05218ecab25dfa82"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WAbstractMedia.html#a16e3c4a51ace8821725e009bfcf46d40">setAlternativeContent</a> (<a class="el" href="classWt_1_1WWidget.html">WWidget</a> *alternative)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Content to be shown when media cannot be played. <a href="#a16e3c4a51ace8821725e009bfcf46d40"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WAbstractMedia.html#a1b9bd122b3dd4bda181ca5aae920aa85">play</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Invoke <a class="el" href="classWt_1_1WAbstractMedia.html#a1b9bd122b3dd4bda181ca5aae920aa85" title="Invoke play() on the media element.">play()</a> on the media element. <a href="#a1b9bd122b3dd4bda181ca5aae920aa85"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WAbstractMedia.html#a17d403bce830fde764c3bbcb7809bdbf">pause</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Invoke <a class="el" href="classWt_1_1WAbstractMedia.html#a17d403bce830fde764c3bbcb7809bdbf" title="Invoke pause() on the media element.">pause()</a> on the media element. <a href="#a17d403bce830fde764c3bbcb7809bdbf"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af2b739bf3a29b91f87d8c55d7f1235fc"></a><!-- doxytag: member="Wt::WAbstractMedia::playing" ref="af2b739bf3a29b91f87d8c55d7f1235fc" args="() const " -->
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WAbstractMedia.html#af2b739bf3a29b91f87d8c55d7f1235fc">playing</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns whether the media is playing. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a63cbe3adee17a3d1a754b07e90c5c633"></a><!-- doxytag: member="Wt::WAbstractMedia::readyState" ref="a63cbe3adee17a3d1a754b07e90c5c633" args="() const " -->
<a class="el" href="classWt_1_1WAbstractMedia.html#acabdc224f494c1c9f80758d2c31f3f1f">ReadyState</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WAbstractMedia.html#a63cbe3adee17a3d1a754b07e90c5c633">readyState</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the media's readyState. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classWt_1_1EventSignal.html">EventSignal</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WAbstractMedia.html#ac1177ed0336641472462320aa13d666e">playbackStarted</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Event signal emitted when playback has begun. <a href="#ac1177ed0336641472462320aa13d666e"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classWt_1_1EventSignal.html">EventSignal</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WAbstractMedia.html#a21e8a3dad1da8ba9b7172a50107e9ce4">playbackPaused</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Event signal emitted when the playback has paused. <a href="#a21e8a3dad1da8ba9b7172a50107e9ce4"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classWt_1_1EventSignal.html">EventSignal</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WAbstractMedia.html#acbb224f37fd97cfd03213de9cde3e01a">ended</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Event signal emitted when the playback stopped because the end of the media was reached. <a href="#acbb224f37fd97cfd03213de9cde3e01a"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classWt_1_1EventSignal.html">EventSignal</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WAbstractMedia.html#a3d78112ce9482a6f0aa6dd7f78080159">timeUpdated</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Event signal emitted when the current playback position has changed. <a href="#a3d78112ce9482a6f0aa6dd7f78080159"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classWt_1_1EventSignal.html">EventSignal</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WAbstractMedia.html#a22eb198a6088a92d1371d16f862244f5">volumeChanged</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Event signal emitted when the playback volume has changed. <a href="#a22eb198a6088a92d1371d16f862244f5"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WAbstractMedia.html#a64a1df3d4505dea9f5cbe5329b1b0ad5">jsMediaRef</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the JavaScript reference to the media object, or null. <a href="#a64a1df3d4505dea9f5cbe5329b1b0ad5"></a><br/></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>Abstract baseclass for native media elements. </p>
<p>This class is an abstract base class for HTML5 media elements (<audio>, <video>).</p>
<dl class="note"><dt><b>Note:</b></dt><dd>Before Wt 3.1.11, this was called WHTML5Media, which still exists as a (deprecated) typedef. </dd></dl>
</div><hr/><h2>Member Enumeration Documentation</h2>
<a class="anchor" id="a5a25922d875102bce7f295b88986a102"></a><!-- doxytag: member="Wt::WAbstractMedia::Options" ref="a5a25922d875102bce7f295b88986a102" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="classWt_1_1WAbstractMedia.html#a5a25922d875102bce7f295b88986a102">Wt::WAbstractMedia::Options</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Enumeration for playback options. </p>
<dl><dt><b>Enumerator: </b></dt><dd><table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><em><a class="anchor" id="a5a25922d875102bce7f295b88986a102aaa22c5028f0561a520e5362ca346840b"></a><!-- doxytag: member="Autoplay" ref="a5a25922d875102bce7f295b88986a102aaa22c5028f0561a520e5362ca346840b" args="" -->Autoplay</em> </td><td>
<p>Start playing as soon as the video is loaded. </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="a5a25922d875102bce7f295b88986a102a6e93c0a4bbbd90c2cf121a0f2b6ae41f"></a><!-- doxytag: member="Loop" ref="a5a25922d875102bce7f295b88986a102a6e93c0a4bbbd90c2cf121a0f2b6ae41f" args="" -->Loop</em> </td><td>
<p>Enable loop mode. </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="a5a25922d875102bce7f295b88986a102a08c3ddfc98b66a69be399198bf0ac16b"></a><!-- doxytag: member="Controls" ref="a5a25922d875102bce7f295b88986a102a08c3ddfc98b66a69be399198bf0ac16b" args="" -->Controls</em> </td><td>
<p>Show video controls in the browser. </p>
</td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="aa0285df6f72b088725a926354849ecb6"></a><!-- doxytag: member="Wt::WAbstractMedia::PreloadMode" ref="aa0285df6f72b088725a926354849ecb6" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="classWt_1_1WAbstractMedia.html#aa0285df6f72b088725a926354849ecb6">Wt::WAbstractMedia::PreloadMode</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Enumeration for preload strategy. </p>
<dl><dt><b>Enumerator: </b></dt><dd><table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><em><a class="anchor" id="aa0285df6f72b088725a926354849ecb6aaf6f9bbb92981ac31c2d874483ca3528"></a><!-- doxytag: member="PreloadNone" ref="aa0285df6f72b088725a926354849ecb6aaf6f9bbb92981ac31c2d874483ca3528" args="" -->PreloadNone</em> </td><td>
<p>Hints that the user will probably not play the video. </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="aa0285df6f72b088725a926354849ecb6a4b5ea61e62e704ea152cdb360f81f571"></a><!-- doxytag: member="PreloadAuto" ref="aa0285df6f72b088725a926354849ecb6a4b5ea61e62e704ea152cdb360f81f571" args="" -->PreloadAuto</em> </td><td>
<p>Hints that it is ok to download the entire resource. </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="aa0285df6f72b088725a926354849ecb6a08fa52aba2bec649a45c2c80a0087d20"></a><!-- doxytag: member="PreloadMetadata" ref="aa0285df6f72b088725a926354849ecb6a08fa52aba2bec649a45c2c80a0087d20" args="" -->PreloadMetadata</em> </td><td>
<p>Hints that retrieving metadata is a good option. </p>
</td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="acabdc224f494c1c9f80758d2c31f3f1f"></a><!-- doxytag: member="Wt::WAbstractMedia::ReadyState" ref="acabdc224f494c1c9f80758d2c31f3f1f" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="classWt_1_1WAbstractMedia.html#acabdc224f494c1c9f80758d2c31f3f1f">Wt::WAbstractMedia::ReadyState</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>The HTML5 media ReadyState flag indicates how much of the media is loaded. </p>
<p>This is often used in conjunction with the > operator, e.g. <a class="el" href="classWt_1_1WAbstractMedia.html#a63cbe3adee17a3d1a754b07e90c5c633" title="Returns the media's readyState.">readyState()</a> > HaveCurrentData </p>
<dl><dt><b>Enumerator: </b></dt><dd><table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><em><a class="anchor" id="acabdc224f494c1c9f80758d2c31f3f1fac1b8d00f1cb2edbd826e2e471b67cf7a"></a><!-- doxytag: member="HaveNothing" ref="acabdc224f494c1c9f80758d2c31f3f1fac1b8d00f1cb2edbd826e2e471b67cf7a" args="" -->HaveNothing</em> </td><td>
<p>No information available. </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="acabdc224f494c1c9f80758d2c31f3f1faa50d2bf2fc67dae41ea42839dc69525e"></a><!-- doxytag: member="HaveMetaData" ref="acabdc224f494c1c9f80758d2c31f3f1faa50d2bf2fc67dae41ea42839dc69525e" args="" -->HaveMetaData</em> </td><td>
<p>Metadata loaded: duration, width, height. </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="acabdc224f494c1c9f80758d2c31f3f1fa340653b8e1af13e1e8f6b0f6d6ffcb78"></a><!-- doxytag: member="HaveCurrentData" ref="acabdc224f494c1c9f80758d2c31f3f1fa340653b8e1af13e1e8f6b0f6d6ffcb78" args="" -->HaveCurrentData</em> </td><td>
<p>Data at playback position is available. </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="acabdc224f494c1c9f80758d2c31f3f1fa6d94e2b35e9bdb49ce88baa2f9b6195b"></a><!-- doxytag: member="HaveFutureData" ref="acabdc224f494c1c9f80758d2c31f3f1fa6d94e2b35e9bdb49ce88baa2f9b6195b" args="" -->HaveFutureData</em> </td><td>
<p>Have data to play for a while. </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="acabdc224f494c1c9f80758d2c31f3f1fa24d6067cfc2900ac6a31d99bd3dc8f54"></a><!-- doxytag: member="HaveEnoughData" ref="acabdc224f494c1c9f80758d2c31f3f1fa24d6067cfc2900ac6a31d99bd3dc8f54" args="" -->HaveEnoughData</em> </td><td>
<p>Enough to reach the end without stalling. </p>
</td></tr>
</table>
</dd>
</dl>
</div>
</div>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a1febdb153786dab906e473e4f908739b"></a><!-- doxytag: member="Wt::WAbstractMedia::WAbstractMedia" ref="a1febdb153786dab906e473e4f908739b" args="(WContainerWidget *parent=0)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">WAbstractMedia::WAbstractMedia </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classWt_1_1WContainerWidget.html">WContainerWidget</a> * </td>
<td class="paramname"><em>parent</em> = <code>0</code></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Consctructor for a media widget. </p>
<p>A freshly constructed media widget has no options set, no media sources, and has preload mode set to PreloadAuto. </p>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="ae0bdedcd0136a29c05218ecab25dfa82"></a><!-- doxytag: member="Wt::WAbstractMedia::addSource" ref="ae0bdedcd0136a29c05218ecab25dfa82" args="(const WLink &source, const std::string &type="", const std::string &media="")" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void WAbstractMedia::addSource </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classWt_1_1WLink.html">WLink</a> & </td>
<td class="paramname"><em>source</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>type</em> = <code>""</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>media</em> = <code>""</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Add a media source. </p>
<p>This method specifies a media source (which may be a URL or dynamic resource). You may add as many media sources as you want. The browser will select the appropriate media stream to display to the user.</p>
<p>This method specifies a media source using the URL, the mime type, and the media attribute. HTML allows for empty type and media attributes. </p>
</div>
</div>
<a class="anchor" id="ac70b946b707a8596d2f0bbcb3ae8f807"></a><!-- doxytag: member="Wt::WAbstractMedia::clearSources" ref="ac70b946b707a8596d2f0bbcb3ae8f807" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void WAbstractMedia::clearSources </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Removes all source elements. </p>
<p>This method can be used to remove all media sources. Afterward, you may add new media sources with calls to <a class="el" href="classWt_1_1WAbstractMedia.html#ae0bdedcd0136a29c05218ecab25dfa82" title="Add a media source.">addSource()</a>.</p>
<p>Use this to reuse a <a class="el" href="classWt_1_1WAbstractMedia.html" title="Abstract baseclass for native media elements.">WAbstractMedia</a> instantiation to play something else. </p>
</div>
</div>
<a class="anchor" id="acbb224f37fd97cfd03213de9cde3e01a"></a><!-- doxytag: member="Wt::WAbstractMedia::ended" ref="acbb224f37fd97cfd03213de9cde3e01a" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classWt_1_1EventSignal.html">EventSignal</a> & WAbstractMedia::ended </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Event signal emitted when the playback stopped because the end of the media was reached. </p>
<dl class="note"><dt><b>Note:</b></dt><dd>When JavaScript is disabled, the signal will never fire. </dd></dl>
</div>
</div>
<a class="anchor" id="a64a1df3d4505dea9f5cbe5329b1b0ad5"></a><!-- doxytag: member="Wt::WAbstractMedia::jsMediaRef" ref="a64a1df3d4505dea9f5cbe5329b1b0ad5" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::string WAbstractMedia::jsMediaRef </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the JavaScript reference to the media object, or null. </p>
<p>It is possible, for browser compatibility reasons, that <a class="el" href="classWt_1_1WWidget.html#aa2b7078b3b43d53a85e5244b45d504f7" title="Returns a JavaScript expression to the corresponding DOM node.">jsRef()</a> is not the media element. <a class="el" href="classWt_1_1WAbstractMedia.html#a64a1df3d4505dea9f5cbe5329b1b0ad5" title="Returns the JavaScript reference to the media object, or null.">jsMediaRef()</a> is guaranteed to be an expression that evaluates to the media object. This expression may yield null, if the video object is not rendered at all (e.g. on older versions of Internet Explorer). </p>
</div>
</div>
<a class="anchor" id="a17d403bce830fde764c3bbcb7809bdbf"></a><!-- doxytag: member="Wt::WAbstractMedia::pause" ref="a17d403bce830fde764c3bbcb7809bdbf" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void WAbstractMedia::pause </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Invoke <a class="el" href="classWt_1_1WAbstractMedia.html#a17d403bce830fde764c3bbcb7809bdbf" title="Invoke pause() on the media element.">pause()</a> on the media element. </p>
<p>JavaScript must be available for this function to work. </p>
</div>
</div>
<a class="anchor" id="a1b9bd122b3dd4bda181ca5aae920aa85"></a><!-- doxytag: member="Wt::WAbstractMedia::play" ref="a1b9bd122b3dd4bda181ca5aae920aa85" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void WAbstractMedia::play </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Invoke <a class="el" href="classWt_1_1WAbstractMedia.html#a1b9bd122b3dd4bda181ca5aae920aa85" title="Invoke play() on the media element.">play()</a> on the media element. </p>
<p>JavaScript must be available for this function to work. </p>
</div>
</div>
<a class="anchor" id="a21e8a3dad1da8ba9b7172a50107e9ce4"></a><!-- doxytag: member="Wt::WAbstractMedia::playbackPaused" ref="a21e8a3dad1da8ba9b7172a50107e9ce4" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classWt_1_1EventSignal.html">EventSignal</a> & WAbstractMedia::playbackPaused </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Event signal emitted when the playback has paused. </p>
<dl class="note"><dt><b>Note:</b></dt><dd>When JavaScript is disabled, the signal will never fire. </dd></dl>
</div>
</div>
<a class="anchor" id="ac1177ed0336641472462320aa13d666e"></a><!-- doxytag: member="Wt::WAbstractMedia::playbackStarted" ref="ac1177ed0336641472462320aa13d666e" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classWt_1_1EventSignal.html">EventSignal</a> & WAbstractMedia::playbackStarted </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Event signal emitted when playback has begun. </p>
<p>This event fires when play was invoked, or when the media element starts playing because the Autoplay option was provided.</p>
<dl class="note"><dt><b>Note:</b></dt><dd>When JavaScript is disabled, the signal will never fire. </dd></dl>
</div>
</div>
<a class="anchor" id="a16e3c4a51ace8821725e009bfcf46d40"></a><!-- doxytag: member="Wt::WAbstractMedia::setAlternativeContent" ref="a16e3c4a51ace8821725e009bfcf46d40" args="(WWidget *alternative)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void WAbstractMedia::setAlternativeContent </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classWt_1_1WWidget.html">WWidget</a> * </td>
<td class="paramname"><em>alternative</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Content to be shown when media cannot be played. </p>
<p>As not all browsers are HTML5 compliant, it is a good idea to provide fallback options when the media cannot be displayed. If the media can be played by the browser, the alternative content will be suppressed.</p>
<p>The two reasons to display the alternative content are (1) the media tag is not supported, or (2) the media tag is supported, but none of the media sources are supported by the browser. In the first case, fall-back is automatic and does not rely on JavaScript in the browser; in the latter case, JavaScript is required to make the fallback work.</p>
<p>The alternative content can be any widget: you can set it to an alternative media player (QuickTime, Flash, ...), show a Flash movie, an animated gif, a text, a poster image, ... </p>
</div>
</div>
<a class="anchor" id="a503c27a4a854d69606ca34de88c2bf98"></a><!-- doxytag: member="Wt::WAbstractMedia::setOptions" ref="a503c27a4a854d69606ca34de88c2bf98" args="(const WFlags< Options > &flags)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void WAbstractMedia::setOptions </td>
<td>(</td>
<td class="paramtype">const WFlags< <a class="el" href="classWt_1_1WAbstractMedia.html#a5a25922d875102bce7f295b88986a102">Options</a> > & </td>
<td class="paramname"><em>flags</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Set the media element options. </p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1WAbstractMedia.html#a5a25922d875102bce7f295b88986a102" title="Enumeration for playback options.">Options</a> </dd></dl>
</div>
</div>
<a class="anchor" id="a3d78112ce9482a6f0aa6dd7f78080159"></a><!-- doxytag: member="Wt::WAbstractMedia::timeUpdated" ref="a3d78112ce9482a6f0aa6dd7f78080159" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classWt_1_1EventSignal.html">EventSignal</a> & WAbstractMedia::timeUpdated </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Event signal emitted when the current playback position has changed. </p>
<p>This event is fired when the playback position has changed, both when the media is in a normal playing mode, but also when it has changed discontinuously because of another reason.</p>
<dl class="note"><dt><b>Note:</b></dt><dd>When JavaScript is disabled, the signal will never fire. </dd></dl>
</div>
</div>
<a class="anchor" id="a22eb198a6088a92d1371d16f862244f5"></a><!-- doxytag: member="Wt::WAbstractMedia::volumeChanged" ref="a22eb198a6088a92d1371d16f862244f5" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classWt_1_1EventSignal.html">EventSignal</a> & WAbstractMedia::volumeChanged </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Event signal emitted when the playback volume has changed. </p>
<dl class="note"><dt><b>Note:</b></dt><dd>When JavaScript is disabled, the signal will never fire. </dd></dl>
</div>
</div>
</div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Enumerator</a></div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<hr size="1"><address style="text-align: right; margin: 3px"><small>
Generated on Fri Mar 30 2012 for <a href="http://www.webtoolkit.eu/wt">the
C++ Web Toolkit (Wt)</a> by <a
href="http://www.doxygen.org/index.html"><img src="doxygen.png"
alt="doxygen" border="0" style="vertical-align: middle; display:
inline-block; height: 2em"></a> 1.7.5.1</small></address>
</body>
</html>
|
