aboutsummaryrefslogtreecommitdiff
path: root/libraries/phpvideotoolkit/adapters/ffmpeg-php/php-reader/docs/php-reader/ISO/ISO14496_Box_ILST.html
blob: 0dc4ab8aed4917757960fd3f03e1f2ac43ea4d12 (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
<?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_ILST</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_ILST</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">A container box for all the iTunes/iPod specific boxes. A list of well known  boxes is provided in the following table. The value for each box is contained  in a nested <a href="../../php-reader/ISO/ISO14496_Box_DATA.html">Data Box</a>.</p>
<p class="description"><p><ul><li><strong>_nam</strong> -- <em>Name of the track</em></li><li><strong>_ART</strong> -- <em>Name of the artist</em></li><li><strong>aART</strong> -- <em>Name of the album artist</em></li><li><strong>_alb</strong> -- <em>Name of the album</em></li><li><strong>_grp</strong> -- <em>Grouping</em></li><li><strong>_day</strong> -- <em>Year of publication</em></li><li><strong>trkn</strong> -- <em>Track number (number/total)</em></li><li><strong>disk</strong> -- <em>Disk number (number/total)</em></li><li><strong>tmpo</strong> -- <em>BPM tempo</em></li><li><strong>_wrt</strong> -- <em>Name of the composer</em></li><li><strong>_cmt</strong> -- <em>Comments</em></li><li><strong>_gen</strong> -- <em>Genre as string</em></li><li><strong>gnre</strong> -- <em>Genre as an ID3v1 code, added by one</em></li><li><strong>cpil</strong> -- <em>Part of a compilation (0/1)</em></li><li><strong>tvsh</strong> -- <em>Name of the (television) show</em></li><li><strong>sonm</strong> -- <em>Sort name of the track</em></li><li><strong>soar</strong> -- <em>Sort name of the artist</em></li><li><strong>soaa</strong> -- <em>Sort name of the album artist</em></li><li><strong>soal</strong> -- <em>Sort name of the album</em></li><li><strong>soco</strong> -- <em>Sort name of the composer</em></li><li><strong>sosn</strong> -- <em>Sort name of the show</em></li><li><strong>_lyr</strong> -- <em>Lyrics</em></li><li><strong>covr</strong> -- <em>Cover (or other) artwork binary data</em></li><li><strong>_too</strong> -- <em>Information about the software</em></li></ul></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: 101 $</li>
				<li><span class="field">copyright:</span> Copyright (c) 2008 The PHP Reader Project Workgroup</li>
				<li><span class="field">since:</span> iTunes/iPod specific</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---ILST.php.html">/ISO14496/Box/ILST.php</a> (line <span class="field">82</span>)
		</p>
		
				
		<pre><a href="../../php-reader/ISO/ISO14496_Box.html">ISO14496_Box</a>
   |
   --ISO14496_Box_ILST</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_ILST</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-default">null</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">mixed</span>
										<a href="#__get" title="details" class="method-name">__get</a>
											(<span class="var-type">string</span>&nbsp;<span class="var-name">$name</span>)
									</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">90</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_ILST</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-default">null</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="method__get" id="__get"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">__get</span> (line <span class="line-number">108</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Override magic function so that $obj-&gt;value on a box will return the data  box instead of the data container box.</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">mixed</span>
		<span class="method-name">
			__get
		</span>
					(<span class="var-type">string</span>&nbsp;<span class="var-name">$name</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$name</span><span class="var-description">: The box or field name.</span>			</li>
				</ul>
		
			<hr class="separator" />
		<div class="notes">Redefinition of:</div>
		<dl>
			<dt><a href="../../php-reader/ISO/ISO14496_Box.html#method__get">ISO14496_Box::__get()</a></dt>
						<dd>Magic function so that $obj-&gt;value will work. If called on a container box,  the method will first attempt to return the first contained box that  matches the identifier, and if not found, invoke a getter method.</dd>
					</dl>
			
	</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:53 +0300 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.1</a>
	</p>
	</div></body>
</html>