blob: ddb1abe56dfdcdb4762fbc34fd8b6f8114a9f2bd (
plain)
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
|
<?xml version="1.0" encoding="iso-8859-1"?>
<!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>
<!-- template designed by Marco Von Ballmoos -->
<title>Docs For Class ASF</title>
<link rel="stylesheet" href="../../media/stylesheet.css" />
<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
</head>
<body>
<div class="page-body">
<h2 class="class-name">Class ASF</h2>
<a name="sec-description"></a>
<div class="info-box">
<div class="info-box-title">Description</div>
<div class="nav-bar">
<span class="disabled">Description</span> |
<a href="#sec-vars">Vars</a>
| <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
<a href="#sec-const-summary">Constants</a> (<a href="#sec-consts">details</a>)
</div>
<div class="info-box-body">
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">This class represents a file in Advanced Systems Format (ASF) as described in</p>
<p class="description"><p><a href="http://go.microsoft.com/fwlink/?LinkId=31334">The Advanced Systems
Format (ASF) Specification</a>. It is a file format that can contain various types of information ranging from audio and video to script commands and developer defined custom streams.</p><p>The ASF file consists of code blocks that are called content objects. Each of these objects have a format of their own. They may contain other objects or other specific data. Each supported object has been implemented as their own classes to ease the correct use of the information.</p></p>
<ul class="tags">
<li><span class="field">author:</span> Sven Vollbehr <<a href="mailto:svollbehr@gmail.com">svollbehr@gmail.com</a>></li>
<li><span class="field">version:</span> $Rev: 108 $</li>
<li><span class="field">copyright:</span> Copyright (c) 2006-2008 The PHP Reader Project Workgroup</li>
<li><span class="field">license:</span> <a href="http://code.google.com/p/php-reader/wiki/License">New BSD License</a></li>
</ul>
<p class="notes">
Located in <a class="field" href="_ASF.php.html">/ASF.php</a> (line <span class="field">63</span>)
</p>
<pre><a href="../../php-reader/ASF/ASF_Object.html">ASF_Object</a>
|
--<a href="../../php-reader/ASF/ASF_Object_Container.html">ASF_Object_Container</a>
|
--ASF</pre>
</div>
</div>
<a name="sec-const-summary"></a>
<div class="info-box">
<div class="info-box-title">Class Constant Summary</span></div>
<div class="nav-bar">
<a href="#sec-description">Description</a> |
<span class="disabled">Constants</span> (<a href="#sec-consts">details</a>)
<a href="#sec-vars">Vars</a>
|
|
<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
</div>
<div class="info-box-body">
<div class="const-summary">
<div class="const-title">
<img src="../../media/images/Constant.png" alt=" " />
<a href="#DATA" title="details" class="const-name">DATA</a> = <span class="var-type"> "75b22636-668e-11cf-a6d9-00aa0062ce6c"</span>
</div>
<div class="const-title">
<img src="../../media/images/Constant.png" alt=" " />
<a href="#HEADER" title="details" class="const-name">HEADER</a> = <span class="var-type"> "75b22630-668e-11cf-a6d9-00aa0062ce6c"</span>
</div>
<div class="const-title">
<img src="../../media/images/Constant.png" alt=" " />
<a href="#INDEX" title="details" class="const-name">INDEX</a> = <span class="var-type"> "d6e229d3-35da-11d1-9034-00a0c90349be"</span>
</div>
<div class="const-title">
<img src="../../media/images/Constant.png" alt=" " />
<a href="#MEDIA_OBJECT_INDEX" title="details" class="const-name">MEDIA_OBJECT_INDEX</a> = <span class="var-type"> "feb103f8-12ad-4c64-840f-2a1d2f7ad48c"</span>
</div>
<div class="const-title">
<img src="../../media/images/Constant.png" alt=" " />
<a href="#SIMPLE_INDEX" title="details" class="const-name">SIMPLE_INDEX</a> = <span class="var-type"> "33000890-e5b1-11cf-89f4-00a0c90349cb"</span>
</div>
<div class="const-title">
<img src="../../media/images/Constant.png" alt=" " />
<a href="#TIMECODE_INDEX" title="details" class="const-name">TIMECODE_INDEX</a> = <span class="var-type"> "3cb73fd0-0c4a-4803-953d-edf7b6228f0c"</span>
</div>
</div>
</div>
</div>
<a name="sec-method-summary"></a>
<div class="info-box">
<div class="info-box-title">Method Summary</span></div>
<div class="nav-bar">
<a href="#sec-description">Description</a> |
<a href="#sec-const-summary">Constants</a> (<a href="#sec-consts">details</a>)
<a href="#sec-vars">Vars</a>
|
<span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
</div>
<div class="info-box-body">
<div class="method-summary">
<div class="method-definition">
<span class="method-result">ASF</span>
<a href="#__construct" title="details" class="method-name">__construct</a>
(<span class="var-type">string</span> <span class="var-name">$filename</span>, [<span class="var-type">Array</span> <span class="var-name">$options</span> = <span class="var-default">array()</span>])
</div>
<div class="method-definition">
<span class="method-result"><a href="../../php-reader/ASF/ASF_Object_Data.html">ASF_Object_Data</a></span>
<a href="#getData" title="details" class="method-name">getData</a>
()
</div>
<div class="method-definition">
<span class="method-result"><a href="../../php-reader/ASF/ASF_Object_Header.html">ASF_Object_Header</a></span>
<a href="#getHeader" title="details" class="method-name">getHeader</a>
()
</div>
<div class="method-definition">
<span class="method-result">Array</span>
<a href="#getIndices" title="details" class="method-name">getIndices</a>
()
</div>
<div class="method-definition">
<span class="method-result">void</span>
<a href="#write" title="details" class="method-name">write</a>
()
</div>
</div>
</div>
</div>
<a name="sec-vars"></a>
<div class="info-box">
<div class="info-box-title">Variables</div>
<div class="nav-bar">
<a href="#sec-description">Description</a> |
<a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>)
<a href="#sec-const-summary">Constants</a> (<a href="#sec-consts">details</a>)
|
<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
</div>
<div class="info-box-body">
<h4>Inherited Variables</h4>
<A NAME='inherited_vars'><!-- --></A>
<p>Inherited from <span class="classname"><a href="../../php-reader/ASF/ASF_Object.html">ASF_Object</a></span></p>
<blockquote>
<span class="var-title">
<span class="var-name"><a href="../../php-reader/ASF/ASF_Object.html#var$_options">ASF_Object::$_options</a></span><br>
</span>
<span class="var-title">
<span class="var-name"><a href="../../php-reader/ASF/ASF_Object.html#var$_reader">ASF_Object::$_reader</a></span><br>
</span>
</blockquote>
</div>
</div>
<a name="sec-methods"></a>
<div class="info-box">
<div class="info-box-title">Methods</div>
<div class="nav-bar">
<a href="#sec-description">Description</a> |
<a href="#sec-vars">Vars</a>
<a href="#sec-const-summary">Constants</a> (<a href="#sec-consts">details</a>)
<a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
</div>
<div class="info-box-body">
<A NAME='method_detail'></A>
<a name="method__construct" id="__construct"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<span class="method-title">Constructor __construct</span> (line <span class="line-number">89</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Constructs the ASF class with given file and options.</p>
<p class="description"><p>The following options are currently recognized: <ul><li>encoding -- Indicates the encoding that all the texts are presented
with. By default this is set to utf-8. See the documentation of iconv
for accepted values.</li></ul> or another source it cannot be written back to.</p></p>
<ul class="tags">
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">ASF</span>
<span class="method-name">
__construct
</span>
(<span class="var-type">string</span> <span class="var-name">$filename</span>, [<span class="var-type">Array</span> <span class="var-name">$options</span> = <span class="var-default">array()</span>])
</div>
<ul class="parameters">
<li>
<span class="var-type">string</span>
<span class="var-name">$filename</span><span class="var-description">: The path to the file or file descriptor of an opened file.</span> </li>
<li>
<span class="var-type">Array</span>
<span class="var-name">$options</span><span class="var-description">: The options array.</span> </li>
</ul>
<hr class="separator" />
<div class="notes">Redefinition of:</div>
<dl>
<dt><a href="../../php-reader/ASF/ASF_Object.html#method__construct">ASF_Object::__construct()</a></dt>
<dd>Constructs the class with given parameters and options.</dd>
</dl>
</div>
<a name="methodgetData" id="getData"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">getData</span> (line <span class="line-number">123</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Returns the mandatory data object contained in this file.</p>
<ul class="tags">
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result"><a href="../../php-reader/ASF/ASF_Object_Data.html">ASF_Object_Data</a></span>
<span class="method-name">
getData
</span>
()
</div>
</div>
<a name="methodgetHeader" id="getHeader"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<span class="method-title">getHeader</span> (line <span class="line-number">112</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Returns the mandatory header object contained in this file.</p>
<ul class="tags">
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result"><a href="../../php-reader/ASF/ASF_Object_Header.html">ASF_Object_Header</a></span>
<span class="method-name">
getHeader
</span>
()
</div>
</div>
<a name="methodgetIndices" id="getIndices"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">getIndices</span> (line <span class="line-number">134</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Returns an array of index objects contained in this file.</p>
<ul class="tags">
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">Array</span>
<span class="method-name">
getIndices
</span>
()
</div>
</div>
<a name="methodwrite" id="write"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<span class="method-title">write</span> (line <span class="line-number">147</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Writes the changes back to the original media file.</p>
<p class="description"><p>Please note: currently the method writes only Content Description and Extended Content Description Objects.</p></p>
<ul class="tags">
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">void</span>
<span class="method-name">
write
</span>
()
</div>
</div>
<h4>Inherited Methods</h4>
<a name='inherited_methods'><!-- --></a>
<!-- =========== Summary =========== -->
<p>Inherited From <span class="classname"><a href="../../php-reader/ASF/ASF_Object_Container.html">ASF_Object_Container</a></span></p>
<blockquote>
<span class="method-name"><a href="../../php-reader/ASF/ASF_Object_Container.html#methodaddObject">ASF_Object_Container::addObject()</a></span><br>
<span class="method-name"><a href="../../php-reader/ASF/ASF_Object_Container.html#methodconstructObjects">ASF_Object_Container::constructObjects()</a></span><br>
<span class="method-name"><a href="../../php-reader/ASF/ASF_Object_Container.html#methodgetObjects">ASF_Object_Container::getObjects()</a></span><br>
<span class="method-name"><a href="../../php-reader/ASF/ASF_Object_Container.html#methodgetObjectsByIdentifier">ASF_Object_Container::getObjectsByIdentifier()</a></span><br>
<span class="method-name"><a href="../../php-reader/ASF/ASF_Object_Container.html#methodhasObject">ASF_Object_Container::hasObject()</a></span><br>
<span class="method-name"><a href="../../php-reader/ASF/ASF_Object_Container.html#method__get">ASF_Object_Container::__get()</a></span><br>
<span class="method-name"><a href="../../php-reader/ASF/ASF_Object_Container.html#method__isset">ASF_Object_Container::__isset()</a></span><br>
</blockquote>
<!-- =========== Summary =========== -->
<p>Inherited From <span class="classname"><a href="../../php-reader/ASF/ASF_Object.html">ASF_Object</a></span></p>
<blockquote>
<span class="method-name"><a href="../../php-reader/ASF/ASF_Object.html#method__construct">ASF_Object::__construct()</a></span><br>
<span class="method-name"><a href="../../php-reader/ASF/ASF_Object.html#methodgetIdentifier">ASF_Object::getIdentifier()</a></span><br>
<span class="method-name"><a href="../../php-reader/ASF/ASF_Object.html#methodgetOffset">ASF_Object::getOffset()</a></span><br>
<span class="method-name"><a href="../../php-reader/ASF/ASF_Object.html#methodgetOption">ASF_Object::getOption()</a></span><br>
<span class="method-name"><a href="../../php-reader/ASF/ASF_Object.html#methodgetOptions">ASF_Object::getOptions()</a></span><br>
<span class="method-name"><a href="../../php-reader/ASF/ASF_Object.html#methodgetParent">ASF_Object::getParent()</a></span><br>
<span class="method-name"><a href="../../php-reader/ASF/ASF_Object.html#methodgetSize">ASF_Object::getSize()</a></span><br>
<span class="method-name"><a href="../../php-reader/ASF/ASF_Object.html#methodsetIdentifier">ASF_Object::setIdentifier()</a></span><br>
<span class="method-name"><a href="../../php-reader/ASF/ASF_Object.html#methodsetOffset">ASF_Object::setOffset()</a></span><br>
<span class="method-name"><a href="../../php-reader/ASF/ASF_Object.html#methodsetOption">ASF_Object::setOption()</a></span><br>
<span class="method-name"><a href="../../php-reader/ASF/ASF_Object.html#methodsetOptions">ASF_Object::setOptions()</a></span><br>
<span class="method-name"><a href="../../php-reader/ASF/ASF_Object.html#methodsetParent">ASF_Object::setParent()</a></span><br>
<span class="method-name"><a href="../../php-reader/ASF/ASF_Object.html#methodsetSize">ASF_Object::setSize()</a></span><br>
<span class="method-name"><a href="../../php-reader/ASF/ASF_Object.html#method__get">ASF_Object::__get()</a></span><br>
<span class="method-name"><a href="../../php-reader/ASF/ASF_Object.html#method__set">ASF_Object::__set()</a></span><br>
</blockquote>
</div>
</div>
<a name="sec-consts"></a>
<div class="info-box">
<div class="info-box-title">Class Constants</div>
<div class="nav-bar">
<a href="#sec-description">Description</a> |
<a href="#sec-var-summary">Constants</a> (<span class="disabled">details</span>)
<a href="#sec-vars">Vars</a>
|
<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
</div>
<div class="info-box-body">
<a name="constDATA" id="DATA"><!-- --></A>
<div class="evenrow">
<div class="const-header">
<img src="../../media/images/Variable.png" />
<span class="const-title">
<span class="const-name">DATA</span>
= <span class="const-default"> "75b22636-668e-11cf-a6d9-00aa0062ce6c"</span>
(line <span class="line-number">66</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
</div>
<a name="constHEADER" id="HEADER"><!-- --></A>
<div class="oddrow">
<div class="const-header">
<img src="../../media/images/Variable.png" />
<span class="const-title">
<span class="const-name">HEADER</span>
= <span class="const-default"> "75b22630-668e-11cf-a6d9-00aa0062ce6c"</span>
(line <span class="line-number">65</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
</div>
<a name="constINDEX" id="INDEX"><!-- --></A>
<div class="evenrow">
<div class="const-header">
<img src="../../media/images/Variable.png" />
<span class="const-title">
<span class="const-name">INDEX</span>
= <span class="const-default"> "d6e229d3-35da-11d1-9034-00a0c90349be"</span>
(line <span class="line-number">68</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
</div>
<a name="constMEDIA_OBJECT_INDEX" id="MEDIA_OBJECT_INDEX"><!-- --></A>
<div class="oddrow">
<div class="const-header">
<img src="../../media/images/Variable.png" />
<span class="const-title">
<span class="const-name">MEDIA_OBJECT_INDEX</span>
= <span class="const-default"> "feb103f8-12ad-4c64-840f-2a1d2f7ad48c"</span>
(line <span class="line-number">69</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
</div>
<a name="constSIMPLE_INDEX" id="SIMPLE_INDEX"><!-- --></A>
<div class="evenrow">
<div class="const-header">
<img src="../../media/images/Variable.png" />
<span class="const-title">
<span class="const-name">SIMPLE_INDEX</span>
= <span class="const-default"> "33000890-e5b1-11cf-89f4-00a0c90349cb"</span>
(line <span class="line-number">67</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
</div>
<a name="constTIMECODE_INDEX" id="TIMECODE_INDEX"><!-- --></A>
<div class="oddrow">
<div class="const-header">
<img src="../../media/images/Variable.png" />
<span class="const-title">
<span class="const-name">TIMECODE_INDEX</span>
= <span class="const-default"> "3cb73fd0-0c4a-4803-953d-edf7b6228f0c"</span>
(line <span class="line-number">70</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
</div>
</div>
</div>
<p class="notes" id="credit">
Documentation generated on Fri, 05 Sep 2008 20:18:18 +0300 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.1</a>
</p>
</div></body>
</html>
|
