scratch – Blame information for rev

Subversion Repositories:
Rev:
Rev Author Line No. Line
115 office 1 <!DOCTYPE html>
2 <html lang="en">
3 <head>
4 <meta charset="UTF-8" />
5 <meta name="robots" content="index, follow, all" />
6 <title>FFMpeg\FFProbe\DataMapping\Stream | PHP-FFMpeg API</title>
7 <link rel="stylesheet" type="text/css" href="../../../stylesheet.css">
8 </head>
9 <body id="class">
10 <div class="header">
11 <ul>
12 <li><a href="../../../classes.html">Classes</a></li>
13 <li><a href="../../../namespaces.html">Namespaces</a></li>
14 <li><a href="../../../interfaces.html">Interfaces</a></li>
15 <li><a href="../../../traits.html">Traits</a></li>
16 <li><a href="../../../doc-index.html">Index</a></li>
17  
18 </ul>
19  
20 <div id="title">PHP-FFMpeg API</div>
21  
22 <div class="type">Class</div>
23 <h1><a href="../../../FFMpeg/FFProbe/DataMapping.html">FFMpeg\FFProbe\DataMapping</a>\Stream</h1>
24 </div>
25 <div class="content">
26 <p> class
27 <strong>Stream</strong> extends <a href="../../../FFMpeg/FFProbe/DataMapping/AbstractData.html"><abbr title="FFMpeg\FFProbe\DataMapping\AbstractData">AbstractData</abbr></a></p>
28  
29  
30  
31  
32 <h2>Methods</h2>
33  
34 <table>
35 <tr>
36 <td class="type">
37  
38 </td>
39 <td class="last">
40 <a href="#method___construct">__construct</a>(array $properties)
41 <p>
42 </p>
43 </td>
44 <td><small>from&nbsp;<a href="../../../FFMpeg/FFProbe/DataMapping/AbstractData.html#method___construct"><abbr title="FFMpeg\FFProbe\DataMapping\AbstractData">AbstractData</abbr></a></small></td>
45 </tr>
46 <tr>
47 <td class="type">
48 Boolean
49 </td>
50 <td class="last">
51 <a href="#method_has">has</a>(string $property)
52 <p>Returns true if data has property.</p>
53 </td>
54 <td><small>from&nbsp;<a href="../../../FFMpeg/FFProbe/DataMapping/AbstractData.html#method_has"><abbr title="FFMpeg\FFProbe\DataMapping\AbstractData">AbstractData</abbr></a></small></td>
55 </tr>
56 <tr>
57 <td class="type">
58 mixed
59 </td>
60 <td class="last">
61 <a href="#method_get">get</a>(string $property)
62 <p>Returns the property value given its name.</p>
63 </td>
64 <td><small>from&nbsp;<a href="../../../FFMpeg/FFProbe/DataMapping/AbstractData.html#method_get"><abbr title="FFMpeg\FFProbe\DataMapping\AbstractData">AbstractData</abbr></a></small></td>
65 </tr>
66 <tr>
67 <td class="type">
68 <a href="../../../FFMpeg/FFProbe/DataMapping/AbstractData.html"><abbr title="FFMpeg\FFProbe\DataMapping\AbstractData">AbstractData</abbr></a>
69 </td>
70 <td class="last">
71 <a href="#method_set">set</a>(string $property, mixed $value)
72 <p>Sets the property value given its name.</p>
73 </td>
74 <td><small>from&nbsp;<a href="../../../FFMpeg/FFProbe/DataMapping/AbstractData.html#method_set"><abbr title="FFMpeg\FFProbe\DataMapping\AbstractData">AbstractData</abbr></a></small></td>
75 </tr>
76 <tr>
77 <td class="type">
78 array
79 </td>
80 <td class="last">
81 <a href="#method_keys">keys</a>()
82 <p>Returns all property names.</p>
83 </td>
84 <td><small>from&nbsp;<a href="../../../FFMpeg/FFProbe/DataMapping/AbstractData.html#method_keys"><abbr title="FFMpeg\FFProbe\DataMapping\AbstractData">AbstractData</abbr></a></small></td>
85 </tr>
86 <tr>
87 <td class="type">
88 array
89 </td>
90 <td class="last">
91 <a href="#method_all">all</a>()
92 <p>Returns all properties and their values.</p>
93 </td>
94 <td><small>from&nbsp;<a href="../../../FFMpeg/FFProbe/DataMapping/AbstractData.html#method_all"><abbr title="FFMpeg\FFProbe\DataMapping\AbstractData">AbstractData</abbr></a></small></td>
95 </tr>
96 <tr>
97 <td class="type">
98  
99 </td>
100 <td class="last">
101 <a href="#method_count">count</a>()
102 <p>{@inheritdoc}</p>
103 </td>
104 <td><small>from&nbsp;<a href="../../../FFMpeg/FFProbe/DataMapping/AbstractData.html#method_count"><abbr title="FFMpeg\FFProbe\DataMapping\AbstractData">AbstractData</abbr></a></small></td>
105 </tr>
106 <tr>
107 <td class="type">
108 Boolean
109 </td>
110 <td class="last">
111 <a href="#method_isAudio">isAudio</a>()
112 <p>Returns true if the stream is an audio stream.</p>
113 </td>
114 <td></td>
115 </tr>
116 <tr>
117 <td class="type">
118 Boolean
119 </td>
120 <td class="last">
121 <a href="#method_isVideo">isVideo</a>()
122 <p>Returns true if the stream is a video stream.</p>
123 </td>
124 <td></td>
125 </tr>
126 <tr>
127 <td class="type">
128 <a href="../../../FFMpeg/Coordinate/Dimension.html"><abbr title="FFMpeg\Coordinate\Dimension">Dimension</abbr></a>
129 </td>
130 <td class="last">
131 <a href="#method_getDimensions">getDimensions</a>()
132 <p>Returns the dimension of the video stream.</p>
133 </td>
134 <td></td>
135 </tr>
136 </table>
137  
138  
139 <h2>Details</h2>
140  
141 <h3 id="method___construct">
142 <div class="location">in <a href="../../../FFMpeg/FFProbe/DataMapping/AbstractData.html#method___construct"><abbr title="FFMpeg\FFProbe\DataMapping\AbstractData">AbstractData</abbr></a> at line 20</div>
143 <code> public
144 <strong>__construct</strong>(array $properties)</code>
145 </h3>
146 <div class="details">
147 <p>
148 </p>
149 <p>
150 </p>
151 <div class="tags">
152 <h4>Parameters</h4>
153  
154 <table>
155 <tr>
156 <td>array</td>
157 <td>$properties</td>
158 <td>
159 </td>
160 </tr>
161 </table>
162  
163  
164  
165  
166 </div>
167 </div>
168  
169 <h3 id="method_has">
170 <div class="location">in <a href="../../../FFMpeg/FFProbe/DataMapping/AbstractData.html#method_has"><abbr title="FFMpeg\FFProbe\DataMapping\AbstractData">AbstractData</abbr></a> at line 31</div>
171 <code> public Boolean
172 <strong>has</strong>(string $property)</code>
173 </h3>
174 <div class="details">
175 <p>Returns true if data has property.</p>
176 <p>
177 </p>
178 <div class="tags">
179 <h4>Parameters</h4>
180  
181 <table>
182 <tr>
183 <td>string</td>
184 <td>$property</td>
185 <td>
186 </td>
187 </tr>
188 </table>
189  
190  
191 <h4>Return Value</h4>
192  
193 <table>
194 <tr>
195 <td>Boolean</td>
196 <td>
197 </td>
198 </tr>
199 </table>
200  
201  
202  
203 </div>
204 </div>
205  
206 <h3 id="method_get">
207 <div class="location">in <a href="../../../FFMpeg/FFProbe/DataMapping/AbstractData.html#method_get"><abbr title="FFMpeg\FFProbe\DataMapping\AbstractData">AbstractData</abbr></a> at line 44</div>
208 <code> public mixed
209 <strong>get</strong>(string $property)</code>
210 </h3>
211 <div class="details">
212 <p>Returns the property value given its name.</p>
213 <p>
214 </p>
215 <div class="tags">
216 <h4>Parameters</h4>
217  
218 <table>
219 <tr>
220 <td>string</td>
221 <td>$property</td>
222 <td>
223 </td>
224 </tr>
225 </table>
226  
227  
228 <h4>Return Value</h4>
229  
230 <table>
231 <tr>
232 <td>mixed</td>
233 <td>
234 </td>
235 </tr>
236 </table>
237  
238  
239 <h4>Exceptions</h4>
240  
241 <table>
242 <tr>
243 <td><a href="http://php.net/InvalidArgumentException"><abbr title="InvalidArgumentException">InvalidArgumentException</abbr></a></td>
244 <td>In case the data does not have the property</td>
245 </tr>
246 </table>
247  
248  
249 </div>
250 </div>
251  
252 <h3 id="method_set">
253 <div class="location">in <a href="../../../FFMpeg/FFProbe/DataMapping/AbstractData.html#method_set"><abbr title="FFMpeg\FFProbe\DataMapping\AbstractData">AbstractData</abbr></a> at line 61</div>
254 <code> public <a href="../../../FFMpeg/FFProbe/DataMapping/AbstractData.html"><abbr title="FFMpeg\FFProbe\DataMapping\AbstractData">AbstractData</abbr></a>
255 <strong>set</strong>(string $property, mixed $value)</code>
256 </h3>
257 <div class="details">
258 <p>Sets the property value given its name.</p>
259 <p>
260 </p>
261 <div class="tags">
262 <h4>Parameters</h4>
263  
264 <table>
265 <tr>
266 <td>string</td>
267 <td>$property</td>
268 <td>
269 </td>
270 </tr>
271 <tr>
272 <td>mixed</td>
273 <td>$value</td>
274 <td>
275 </td>
276 </tr>
277 </table>
278  
279  
280 <h4>Return Value</h4>
281  
282 <table>
283 <tr>
284 <td><a href="../../../FFMpeg/FFProbe/DataMapping/AbstractData.html"><abbr title="FFMpeg\FFProbe\DataMapping\AbstractData">AbstractData</abbr></a></td>
285 <td>
286 </td>
287 </tr>
288 </table>
289  
290  
291  
292 </div>
293 </div>
294  
295 <h3 id="method_keys">
296 <div class="location">in <a href="../../../FFMpeg/FFProbe/DataMapping/AbstractData.html#method_keys"><abbr title="FFMpeg\FFProbe\DataMapping\AbstractData">AbstractData</abbr></a> at line 73</div>
297 <code> public array
298 <strong>keys</strong>()</code>
299 </h3>
300 <div class="details">
301 <p>Returns all property names.</p>
302 <p>
303 </p>
304 <div class="tags">
305  
306 <h4>Return Value</h4>
307  
308 <table>
309 <tr>
310 <td>array</td>
311 <td>
312 </td>
313 </tr>
314 </table>
315  
316  
317  
318 </div>
319 </div>
320  
321 <h3 id="method_all">
322 <div class="location">in <a href="../../../FFMpeg/FFProbe/DataMapping/AbstractData.html#method_all"><abbr title="FFMpeg\FFProbe\DataMapping\AbstractData">AbstractData</abbr></a> at line 83</div>
323 <code> public array
324 <strong>all</strong>()</code>
325 </h3>
326 <div class="details">
327 <p>Returns all properties and their values.</p>
328 <p>
329 </p>
330 <div class="tags">
331  
332 <h4>Return Value</h4>
333  
334 <table>
335 <tr>
336 <td>array</td>
337 <td>
338 </td>
339 </tr>
340 </table>
341  
342  
343  
344 </div>
345 </div>
346  
347 <h3 id="method_count">
348 <div class="location">in <a href="../../../FFMpeg/FFProbe/DataMapping/AbstractData.html#method_count"><abbr title="FFMpeg\FFProbe\DataMapping\AbstractData">AbstractData</abbr></a> at line 91</div>
349 <code> public
350 <strong>count</strong>()</code>
351 </h3>
352 <div class="details">
353 <p>{@inheritdoc}</p>
354 <p>
355 </p>
356 <div class="tags">
357  
358  
359  
360 </div>
361 </div>
362  
363 <h3 id="method_isAudio">
364 <div class="location">at line 25</div>
365 <code> public Boolean
366 <strong>isAudio</strong>()</code>
367 </h3>
368 <div class="details">
369 <p>Returns true if the stream is an audio stream.</p>
370 <p>
371 </p>
372 <div class="tags">
373  
374 <h4>Return Value</h4>
375  
376 <table>
377 <tr>
378 <td>Boolean</td>
379 <td>
380 </td>
381 </tr>
382 </table>
383  
384  
385  
386 </div>
387 </div>
388  
389 <h3 id="method_isVideo">
390 <div class="location">at line 35</div>
391 <code> public Boolean
392 <strong>isVideo</strong>()</code>
393 </h3>
394 <div class="details">
395 <p>Returns true if the stream is a video stream.</p>
396 <p>
397 </p>
398 <div class="tags">
399  
400 <h4>Return Value</h4>
401  
402 <table>
403 <tr>
404 <td>Boolean</td>
405 <td>
406 </td>
407 </tr>
408 </table>
409  
410  
411  
412 </div>
413 </div>
414  
415 <h3 id="method_getDimensions">
416 <div class="location">at line 48</div>
417 <code> public <a href="../../../FFMpeg/Coordinate/Dimension.html"><abbr title="FFMpeg\Coordinate\Dimension">Dimension</abbr></a>
418 <strong>getDimensions</strong>()</code>
419 </h3>
420 <div class="details">
421 <p>Returns the dimension of the video stream.</p>
422 <p>
423 </p>
424 <div class="tags">
425  
426 <h4>Return Value</h4>
427  
428 <table>
429 <tr>
430 <td><a href="../../../FFMpeg/Coordinate/Dimension.html"><abbr title="FFMpeg\Coordinate\Dimension">Dimension</abbr></a></td>
431 <td>
432 </td>
433 </tr>
434 </table>
435  
436  
437 <h4>Exceptions</h4>
438  
439 <table>
440 <tr>
441 <td><a href="http://php.net/LogicException"><abbr title="LogicException">LogicException</abbr></a></td>
442 <td>In case the stream is not a video stream.</td>
443 </tr>
444 <tr>
445 <td><a href="http://php.net/RuntimeException"><abbr title="RuntimeException">RuntimeException</abbr></a></td>
446 <td>In case the dimensions can not be extracted.</td>
447 </tr>
448 </table>
449  
450  
451 </div>
452 </div>
453  
454  
455 </div>
456 <div id="footer">
457 Generated by <a href="http://sami.sensiolabs.org/" target="_top">Sami, the API Documentation Generator</a>.
458 </div>
459 </body>
460 </html>