aboutsummaryrefslogtreecommitdiff
path: root/libraries/phpvideotoolkit/adapters/ffmpeg-php/php-reader/docs/php-reader/ISO/ISO14496_Box_ILOC.html
blob: 1db3406b1f2bfd564ac5e6212a6eb303f5703f1a (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
<?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 ISO14496_Box_ILOC</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 ISO14496_Box_ILOC</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>)
						
					</div>
	<div class="info-box-body">
        		<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">The <em>The Item Location Box</em> provides a directory of resources in this or</p>
<p class="description"><p>other files, by locating their containing file, their offset within that  file, and their length. Placing this in binary format enables common handling  of this data, even by systems which do not understand the particular metadata  system (handler) used. For example, a system might integrate all the  externally referenced metadata resources into one file, re-adjusting file  offsets and file references accordingly.</p><p>Items may be stored fragmented into extents, e.g. to enable interleaving. An  extent is a contiguous subset of the bytes of the resource; the resource is  formed by concatenating the extents. If only one extent is used then either  or both of the offset and length may be implied:</p><p><ul><li>If the offset is not identified (the field has a length of zero), then
     the beginning of the file (offset 0) is implied.</li></ul>     or items divided into more than one extent, should have an explicit      offset and length, or use a MIME type requiring a different      interpretation of the file, to avoid infinite recursion.</p><p>The size of the item is the sum of the extentLengths. Note: extents may be  interleaved with the chunks defined by the sample tables of tracks.</p><p>The dataReferenceIndex may take the value 0, indicating a reference into the  same file as this metadata, or an index into the dataReference table.</p><p>Some referenced data may itself use offset/length techniques to address  resources within it (e.g. an MP4 file might be included in this way).  Normally such offsets are relative to the beginning of the containing file.  The field base offset provides an additional offset for offset calculations  within that contained data. For example, if an MP4 file is included within a  file formatted to this specification, then normally data-offsets within that  MP4 section are relative to the beginning of file; baseOffset adds to those  offsets.</p></p>
	<ul class="tags">
				<li><span class="field">author:</span> Sven Vollbehr &lt;<a href="mailto:svollbehr@gmail.com">svollbehr@gmail.com</a>&gt;</li>
				<li><span class="field">version:</span> $Rev: 92 $</li>
				<li><span class="field">copyright:</span> Copyright (c) 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="_ISO14496---Box---ILOC.php.html">/ISO14496/Box/ILOC.php</a> (line <span class="field">86</span>)
		</p>
		
				
		<pre><a href="../../php-reader/ISO/ISO14496_Box.html">ISO14496_Box</a>
   |
   --ISO14496_Box_ILOC</pre>
	
			</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-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">ISO14496_Box_ILOC</span>
										<a href="#__construct" title="details" class="method-name">__construct</a>
											(<span class="var-type"><a href="../../php-reader/Reader.html">Reader</a></span>&nbsp;<span class="var-name">$reader</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">&$options</span> = <span class="var-default">array()</span>])
									</div>
																<div class="method-definition">
											<span class="method-result">Array</span>
										<a href="#getItems" title="details" class="method-name">getItems</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-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/ISO/ISO14496_Box.html">ISO14496_Box</a></span></p>
					<blockquote>
													<span class="var-title">
								<span class="var-name"><a href="../../php-reader/ISO/ISO14496_Box.html#var$_reader">ISO14496_Box::$_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-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="evenrow">
	
	<div class="method-header">
		<span class="method-title">Constructor __construct</span> (line <span class="line-number">97</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Constructs the class with given parameters and reads box related data from  the ISO Base Media file.</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">ISO14496_Box_ILOC</span>
		<span class="method-name">
			__construct
		</span>
					(<span class="var-type"><a href="../../php-reader/Reader.html">Reader</a></span>&nbsp;<span class="var-name">$reader</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">&$options</span> = <span class="var-default">array()</span>])
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type"><a href="../../php-reader/Reader.html">Reader</a></span>
				<span class="var-name">$reader</span><span class="var-description">: The reader object.</span>			</li>
					<li>
				<span class="var-type"></span>
				<span class="var-name">&$options</span>			</li>
				</ul>
		
			<hr class="separator" />
		<div class="notes">Redefinition of:</div>
		<dl>
			<dt><a href="../../php-reader/ISO/ISO14496_Box.html#method__construct">ISO14496_Box::__construct()</a></dt>
						<dd>Constructs the class with given parameters and options.</dd>
					</dl>
			
	</div>
<a name="methodgetItems" id="getItems"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">getItems</span> (line <span class="line-number">133</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Returns the array of items. Each entry has the following keys set: itemId,  dataReferenceIndex, baseOffset, and extents.</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">
			getItems
		</span>
				()
			</div>
	
		
			
	</div>
							<h4>Inherited Methods</h4>
				<a name='inherited_methods'><!-- --></a>	
									<!-- =========== Summary =========== -->
					<p>Inherited From <span class="classname"><a href="../../php-reader/ISO/ISO14496_Box.html">ISO14496_Box</a></span></p>
					<blockquote>
													<span class="method-name"><a href="../../php-reader/ISO/ISO14496_Box.html#method__construct">ISO14496_Box::__construct()</a></span><br>
													<span class="method-name"><a href="../../php-reader/ISO/ISO14496_Box.html#methodaddBox">ISO14496_Box::addBox()</a></span><br>
													<span class="method-name"><a href="../../php-reader/ISO/ISO14496_Box.html#methodconstructBoxes">ISO14496_Box::constructBoxes()</a></span><br>
													<span class="method-name"><a href="../../php-reader/ISO/ISO14496_Box.html#methodgetBoxes">ISO14496_Box::getBoxes()</a></span><br>
													<span class="method-name"><a href="../../php-reader/ISO/ISO14496_Box.html#methodgetBoxesByIdentifier">ISO14496_Box::getBoxesByIdentifier()</a></span><br>
													<span class="method-name"><a href="../../php-reader/ISO/ISO14496_Box.html#methodgetContainer">ISO14496_Box::getContainer()</a></span><br>
													<span class="method-name"><a href="../../php-reader/ISO/ISO14496_Box.html#methodgetOffset">ISO14496_Box::getOffset()</a></span><br>
													<span class="method-name"><a href="../../php-reader/ISO/ISO14496_Box.html#methodgetOption">ISO14496_Box::getOption()</a></span><br>
													<span class="method-name"><a href="../../php-reader/ISO/ISO14496_Box.html#methodgetOptions">ISO14496_Box::getOptions()</a></span><br>
													<span class="method-name"><a href="../../php-reader/ISO/ISO14496_Box.html#methodgetParent">ISO14496_Box::getParent()</a></span><br>
													<span class="method-name"><a href="../../php-reader/ISO/ISO14496_Box.html#methodgetSize">ISO14496_Box::getSize()</a></span><br>
													<span class="method-name"><a href="../../php-reader/ISO/ISO14496_Box.html#methodgetType">ISO14496_Box::getType()</a></span><br>
													<span class="method-name"><a href="../../php-reader/ISO/ISO14496_Box.html#methodhasBox">ISO14496_Box::hasBox()</a></span><br>
													<span class="method-name"><a href="../../php-reader/ISO/ISO14496_Box.html#methodisContainer">ISO14496_Box::isContainer()</a></span><br>
													<span class="method-name"><a href="../../php-reader/ISO/ISO14496_Box.html#methodsetContainer">ISO14496_Box::setContainer()</a></span><br>
													<span class="method-name"><a href="../../php-reader/ISO/ISO14496_Box.html#methodsetOffset">ISO14496_Box::setOffset()</a></span><br>
													<span class="method-name"><a href="../../php-reader/ISO/ISO14496_Box.html#methodsetOption">ISO14496_Box::setOption()</a></span><br>
													<span class="method-name"><a href="../../php-reader/ISO/ISO14496_Box.html#methodsetOptions">ISO14496_Box::setOptions()</a></span><br>
													<span class="method-name"><a href="../../php-reader/ISO/ISO14496_Box.html#methodsetParent">ISO14496_Box::setParent()</a></span><br>
													<span class="method-name"><a href="../../php-reader/ISO/ISO14496_Box.html#methodsetSize">ISO14496_Box::setSize()</a></span><br>
													<span class="method-name"><a href="../../php-reader/ISO/ISO14496_Box.html#methodsetType">ISO14496_Box::setType()</a></span><br>
													<span class="method-name"><a href="../../php-reader/ISO/ISO14496_Box.html#method__get">ISO14496_Box::__get()</a></span><br>
													<span class="method-name"><a href="../../php-reader/ISO/ISO14496_Box.html#method__isset">ISO14496_Box::__isset()</a></span><br>
													<span class="method-name"><a href="../../php-reader/ISO/ISO14496_Box.html#method__set">ISO14496_Box::__set()</a></span><br>
													<span class="method-name"><a href="../../php-reader/ISO/ISO14496_Box.html#method__toString">ISO14496_Box::__toString()</a></span><br>
													<span class="method-name"><a href="../../php-reader/ISO/ISO14496_Box.html#method__unset">ISO14496_Box::__unset()</a></span><br>
											</blockquote>
										
		</div>
	</div>


	<p class="notes" id="credit">
		Documentation generated on Fri, 05 Sep 2008 20:18:52 +0300 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.1</a>
	</p>
	</div></body>
</html>