ffmpeg-mappable-media/docs/source/API/API/FFMpeg/FFProbe.html
2012-05-31 15:57:33 +02:00

271 lines
8.8 KiB
HTML

<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8" />
<meta name="robots" content="index, follow, all" />
<title>FFMpeg\FFProbe | PHP-FFMpeg API</title>
<link rel="stylesheet" type="text/css" href="../stylesheet.css">
</head>
<body id="class">
<div class="header">
<ul>
<li><a href="../classes.html">Classes</a></li>
<li><a href="../namespaces.html">Namespaces</a></li>
<li><a href="../interfaces.html">Interfaces</a></li>
<li><a href="../doc-index.html">Index</a></li>
</ul>
<div id="title">PHP-FFMpeg API</div>
<div class="type">Class</div>
<h1><a href="../FFMpeg.html">FFMpeg</a>\FFProbe</h1>
</div>
<div class="content">
<p>class <strong>FFProbe</strong> extends <a href="../FFMpeg/Binary.html"><abbr title="FFMpeg\Binary">Binary</abbr></a></p>
<div class="description">
<p>FFProbe driver</p>
<p></p>
</div>
<h2>Methods</h2>
<table>
<tr>
<td class="type">
</td>
<td class="last">
<a href="#method___construct">__construct</a>(<abbr title="FFMpeg\type">type</abbr> $binary, <abbr title="Monolog\Logger">Logger</abbr> $logger)
<p>Binary constructor</p>
</td>
<td><small>from&nbsp;<a href="../FFMpeg/Binary.html#method___construct"><abbr title="FFMpeg\Binary">Binary</abbr></a></small></td>
</tr>
<tr>
<td class="type">
</td>
<td class="last">
<a href="#method___destruct">__destruct</a>()
<p>Destructor</p>
</td>
<td><small>from&nbsp;<a href="../FFMpeg/Binary.html#method___destruct"><abbr title="FFMpeg\Binary">Binary</abbr></a></small></td>
</tr>
<tr>
<td class="type">
static&nbsp;<a href="../FFMpeg/Binary.html"><abbr title="FFMpeg\Binary">Binary</abbr></a>
</td>
<td class="last">
<a href="#method_load">load</a>(<abbr title="Monolog\Logger">Logger</abbr> $logger)
<p>Loads the adapter</p>
</td>
<td><small>from&nbsp;<a href="../FFMpeg/Binary.html#method_load"><abbr title="FFMpeg\Binary">Binary</abbr></a></small></td>
</tr>
<tr>
<td class="type">
string
</td>
<td class="last">
<a href="#method_probeFormat">probeFormat</a>(string $pathfile)
<p>Probe the format of a given file</p>
</td>
<td></td>
</tr>
<tr>
<td class="type">
array
</td>
<td class="last">
<a href="#method_probeStreams">probeStreams</a>(string $pathfile)
<p>Probe the streams contained in a given file</p>
</td>
<td></td>
</tr>
</table>
<h2>Details</h2>
<h3 id="method___construct">
<div class="location">in <a href="../FFMpeg/Binary.html#method___construct"><abbr title="FFMpeg\Binary">Binary</abbr></a> at line 39</div>
<code> public
<strong>__construct</strong>(<abbr title="FFMpeg\type">type</abbr> $binary, <abbr title="Monolog\Logger">Logger</abbr> $logger)</code>
</h3>
<div class="details">
<p>Binary constructor</p>
<p></p>
<div class="tags">
<h4>Parameters</h4>
<table>
<tr>
<td><abbr title="FFMpeg\type">type</abbr></td>
<td>$binary</td>
<td>The path file to the binary</td>
</tr>
<tr>
<td><abbr title="Monolog\Logger">Logger</abbr></td>
<td>$logger</td>
<td>A logger</td>
</tr>
</table>
</div>
</div>
<h3 id="method___destruct">
<div class="location">in <a href="../FFMpeg/Binary.html#method___destruct"><abbr title="FFMpeg\Binary">Binary</abbr></a> at line 48</div>
<code> public
<strong>__destruct</strong>()</code>
</h3>
<div class="details">
<p>Destructor</p>
<p></p>
<div class="tags">
</div>
</div>
<h3 id="method_load">
<div class="location">in <a href="../FFMpeg/Binary.html#method_load"><abbr title="FFMpeg\Binary">Binary</abbr></a> at line 61</div>
<code> static public <a href="../FFMpeg/Binary.html"><abbr title="FFMpeg\Binary">Binary</abbr></a>
<strong>load</strong>(<abbr title="Monolog\Logger">Logger</abbr> $logger)</code>
</h3>
<div class="details">
<p>Loads the adapter</p>
<p></p>
<div class="tags">
<h4>Parameters</h4>
<table>
<tr>
<td><abbr title="Monolog\Logger">Logger</abbr></td>
<td>$logger</td>
<td>A logger</td>
</tr>
</table>
<h4>Return Value</h4>
<table>
<tr>
<td><a href="../FFMpeg/Binary.html"><abbr title="FFMpeg\Binary">Binary</abbr></a></td>
<td>The binary</td>
</tr>
</table>
</div>
</div>
<h3 id="method_probeFormat">
<div class="location">at line 35</div>
<code> public string
<strong>probeFormat</strong>(string $pathfile)</code>
</h3>
<div class="details">
<p>Probe the format of a given file</p>
<p></p>
<div class="tags">
<h4>Parameters</h4>
<table>
<tr>
<td>string</td>
<td>$pathfile</td>
<td></td>
</tr>
</table>
<h4>Return Value</h4>
<table>
<tr>
<td>string</td>
<td>A Json object containing the key/values of the probe output</td>
</tr>
</table>
<h4>Exceptions</h4>
<table>
<tr>
<td><a href="http://php.net/InvalidArgumentException"><abbr title="InvalidArgumentException">InvalidArgumentException</abbr></a></td>
<td></td>
</tr>
<tr>
<td><a href="http://php.net/RuntimeException"><abbr title="RuntimeException">RuntimeException</abbr></a></td>
<td></td>
</tr>
</table>
</div>
</div>
<h3 id="method_probeStreams">
<div class="location">at line 81</div>
<code> public array
<strong>probeStreams</strong>(string $pathfile)</code>
</h3>
<div class="details">
<p>Probe the streams contained in a given file</p>
<p></p>
<div class="tags">
<h4>Parameters</h4>
<table>
<tr>
<td>string</td>
<td>$pathfile</td>
<td></td>
</tr>
</table>
<h4>Return Value</h4>
<table>
<tr>
<td>array</td>
<td>An array of streams array</td>
</tr>
</table>
<h4>Exceptions</h4>
<table>
<tr>
<td><a href="http://php.net/InvalidArgumentException"><abbr title="InvalidArgumentException">InvalidArgumentException</abbr></a></td>
<td></td>
</tr>
<tr>
<td><a href="http://php.net/RuntimeException"><abbr title="RuntimeException">RuntimeException</abbr></a></td>
<td></td>
</tr>
</table>
</div>
</div>
</div>
<div id="footer">
Generated by <a href="http://sami.sensiolabs.org/" target="_top">Sami, the API Documentation Generator</a>.
</div>
</body>
</html>