dan/ffmpeg-mappable-media
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Update API doc

Browse source
This commit is contained in:
Romain Neutron 2012-06-15 11:26:51 +02:00
commit 52b7ba1e60
9 changed files with 247 additions and 59 deletions
Download patch file Download diff file Expand all files Collapse all files

81
docs/source/API/API/FFMpeg/FFMpeg.html
View file

@ -66,6 +66,26 @@
</tr>
<tr>
<td class="type">
</td>
<td class="last">
<a href="#method_setThreads">setThreads</a>($threads)
<p></p>
</td>
<td></td>
</tr>
<tr>
<td class="type">
</td>
<td class="last">
<a href="#method_getThreads">getThreads</a>()
<p></p>
</td>
<td></td>
</tr>
<tr>
<td class="type">
<a href="../FFMpeg/FFMpeg.html"><abbr title="FFMpeg\FFMpeg">FFMpeg</abbr></a>
</td>
<td class="last">
@ -109,7 +129,7 @@
<a href="../FFMpeg/FFMpeg.html"><abbr title="FFMpeg\FFMpeg">FFMpeg</abbr></a>
</td>
<td class="last">
<a href="#method_encode">encode</a>(<a href="../FFMpeg/Format/Audio.html"><abbr title="FFMpeg\Format\Audio">Audio</abbr></a> $format, string $outputPathfile, integer $threads = 1)
<a href="#method_encode">encode</a>(<a href="../FFMpeg/Format/Audio.html"><abbr title="FFMpeg\Format\Audio">Audio</abbr></a> $format, string $outputPathfile)
<p>Encode the file to the specified format</p>
</td>
<td></td>
@ -150,7 +170,7 @@
</div>
<h3 id="method___destruct">
<div class="location">at line 39</div>
<div class="location">at line 40</div>
<code> public
<strong>__destruct</strong>()</code>
</h3>
@ -195,11 +215,51 @@
</div>
</div>
<h3 id="method_setThreads">
<div class="location">at line 46</div>
<code> public
<strong>setThreads</strong>($threads)</code>
</h3>
<div class="details">
<p></p>
<p></p>
<div class="tags">
<h4>Parameters</h4>
<table>
<tr>
<td></td>
<td>$threads</td>
<td></td>
</tr>
</table>
</div>
</div>
<h3 id="method_getThreads">
<div class="location">at line 57</div>
<code> public
<strong>getThreads</strong>()</code>
</h3>
<div class="details">
<p></p>
<p></p>
<div class="tags">
</div>
</div>
<h3 id="method_open">
<div class="location">at line 52</div>
<div class="location">at line 69</div>
<code> public <a href="../FFMpeg/FFMpeg.html"><abbr title="FFMpeg\FFMpeg">FFMpeg</abbr></a>
<strong>open</strong>(string $pathfile)</code>
</h3>
@ -242,7 +302,7 @@
</div>
<h3 id="method_setProber">
<div class="location">at line 72</div>
<div class="location">at line 89</div>
<code> public <a href="../FFMpeg/FFMpeg.html"><abbr title="FFMpeg\FFMpeg">FFMpeg</abbr></a>
<strong>setProber</strong>(<a href="../FFMpeg/FFProbe.html"><abbr title="FFMpeg\FFProbe">FFProbe</abbr></a> $prober)</code>
</h3>
@ -276,7 +336,7 @@
</div>
<h3 id="method_close">
<div class="location">at line 84</div>
<div class="location">at line 101</div>
<code> public <a href="../FFMpeg/FFMpeg.html"><abbr title="FFMpeg\FFMpeg">FFMpeg</abbr></a>
<strong>close</strong>()</code>
</h3>
@ -300,7 +360,7 @@
</div>
<h3 id="method_extractImage">
<div class="location">at line 102</div>
<div class="location">at line 119</div>
<code> public <a href="../FFMpeg/FFMpeg.html"><abbr title="FFMpeg\FFMpeg">FFMpeg</abbr></a>
<strong>extractImage</strong>(integer $time, string $output)</code>
</h3>
@ -352,9 +412,9 @@
</div>
<h3 id="method_encode">
<div class="location">at line 146</div>
<div class="location">at line 162</div>
<code> public <a href="../FFMpeg/FFMpeg.html"><abbr title="FFMpeg\FFMpeg">FFMpeg</abbr></a>
<strong>encode</strong>(<a href="../FFMpeg/Format/Audio.html"><abbr title="FFMpeg\Format\Audio">Audio</abbr></a> $format, string $outputPathfile, integer $threads = 1)</code>
<strong>encode</strong>(<a href="../FFMpeg/Format/Audio.html"><abbr title="FFMpeg\Format\Audio">Audio</abbr></a> $format, string $outputPathfile)</code>
</h3>
<div class="details">
<p>Encode the file to the specified format</p>
@ -372,11 +432,6 @@
<td>string</td>
<td>$outputPathfile</td>
<td>The pathfile where to write</td>
</tr>
<tr>
<td>integer</td>
<td>$threads</td>
<td>The number of threads to use</td>
</tr>
</table>

16
docs/source/API/API/FFMpeg/Format/Video/DefaultVideo.html
View file

@ -556,7 +556,7 @@
</div>
<h3 id="method_setResizeMode">
<div class="location">at line 115</div>
<div class="location">at line 120</div>
<code> public
<strong>setResizeMode</strong>(string $mode)</code>
</h3>
@ -590,7 +590,7 @@
</div>
<h3 id="method_getResizeMode">
<div class="location">at line 135</div>
<div class="location">at line 140</div>
<code> public string
<strong>getResizeMode</strong>()</code>
</h3>
@ -614,7 +614,7 @@
</div>
<h3 id="method_getFrameRate">
<div class="location">at line 143</div>
<div class="location">at line 148</div>
<code> public integer
<strong>getFrameRate</strong>()</code>
</h3>
@ -638,7 +638,7 @@
</div>
<h3 id="method_setFrameRate">
<div class="location">at line 155</div>
<div class="location">at line 160</div>
<code> public
<strong>setFrameRate</strong>(integer $frameRate)</code>
</h3>
@ -672,7 +672,7 @@
</div>
<h3 id="method_getVideoCodec">
<div class="location">at line 169</div>
<div class="location">at line 174</div>
<code> public
<strong>getVideoCodec</strong>()</code>
</h3>
@ -687,7 +687,7 @@
</div>
<h3 id="method_setVideoCodec">
<div class="location">at line 181</div>
<div class="location">at line 186</div>
<code> public
<strong>setVideoCodec</strong>(string $videoCodec)</code>
</h3>
@ -721,7 +721,7 @@
</div>
<h3 id="method_getGOPsize">
<div class="location">at line 198</div>
<div class="location">at line 203</div>
<code> public
<strong>getGOPsize</strong>()</code>
</h3>
@ -736,7 +736,7 @@
</div>
<h3 id="method_setGOPsize">
<div class="location">at line 210</div>
<div class="location">at line 215</div>
<code> public
<strong>setGOPsize</strong>(integer $GOPsize)</code>
</h3>

45
docs/source/API/API/FFMpeg/Format/Video/Ogg.html
View file

@ -176,6 +176,16 @@
<tr>
<td class="type">
</td>
<td class="last">
<a href="#method_supportBFrames">supportBFrames</a>()
<p>{@inheritDoc}</p>
</td>
<td></td>
</tr>
<tr>
<td class="type">
</td>
<td class="last">
<a href="#method_getAvailableAudioCodecs">getAvailableAudioCodecs</a>()
@ -325,7 +335,7 @@
</div>
<h3 id="method_setResizeMode">
<div class="location">in <a href="../../../FFMpeg/Format/Video/DefaultVideo.html#method_setResizeMode"><abbr title="FFMpeg\Format\Video\DefaultVideo">DefaultVideo</abbr></a> at line 115</div>
<div class="location">in <a href="../../../FFMpeg/Format/Video/DefaultVideo.html#method_setResizeMode"><abbr title="FFMpeg\Format\Video\DefaultVideo">DefaultVideo</abbr></a> at line 120</div>
<code> public
<strong>setResizeMode</strong>(string $mode)</code>
</h3>
@ -359,7 +369,7 @@
</div>
<h3 id="method_getResizeMode">
<div class="location">in <a href="../../../FFMpeg/Format/Video/DefaultVideo.html#method_getResizeMode"><abbr title="FFMpeg\Format\Video\DefaultVideo">DefaultVideo</abbr></a> at line 135</div>
<div class="location">in <a href="../../../FFMpeg/Format/Video/DefaultVideo.html#method_getResizeMode"><abbr title="FFMpeg\Format\Video\DefaultVideo">DefaultVideo</abbr></a> at line 140</div>
<code> public string
<strong>getResizeMode</strong>()</code>
</h3>
@ -383,7 +393,7 @@
</div>
<h3 id="method_getFrameRate">
<div class="location">in <a href="../../../FFMpeg/Format/Video/DefaultVideo.html#method_getFrameRate"><abbr title="FFMpeg\Format\Video\DefaultVideo">DefaultVideo</abbr></a> at line 143</div>
<div class="location">in <a href="../../../FFMpeg/Format/Video/DefaultVideo.html#method_getFrameRate"><abbr title="FFMpeg\Format\Video\DefaultVideo">DefaultVideo</abbr></a> at line 148</div>
<code> public integer
<strong>getFrameRate</strong>()</code>
</h3>
@ -407,7 +417,7 @@
</div>
<h3 id="method_setFrameRate">
<div class="location">in <a href="../../../FFMpeg/Format/Video/DefaultVideo.html#method_setFrameRate"><abbr title="FFMpeg\Format\Video\DefaultVideo">DefaultVideo</abbr></a> at line 155</div>
<div class="location">in <a href="../../../FFMpeg/Format/Video/DefaultVideo.html#method_setFrameRate"><abbr title="FFMpeg\Format\Video\DefaultVideo">DefaultVideo</abbr></a> at line 160</div>
<code> public
<strong>setFrameRate</strong>(integer $frameRate)</code>
</h3>
@ -441,7 +451,7 @@
</div>
<h3 id="method_getVideoCodec">
<div class="location">in <a href="../../../FFMpeg/Format/Video/DefaultVideo.html#method_getVideoCodec"><abbr title="FFMpeg\Format\Video\DefaultVideo">DefaultVideo</abbr></a> at line 169</div>
<div class="location">in <a href="../../../FFMpeg/Format/Video/DefaultVideo.html#method_getVideoCodec"><abbr title="FFMpeg\Format\Video\DefaultVideo">DefaultVideo</abbr></a> at line 174</div>
<code> public
<strong>getVideoCodec</strong>()</code>
</h3>
@ -456,7 +466,7 @@
</div>
<h3 id="method_setVideoCodec">
<div class="location">in <a href="../../../FFMpeg/Format/Video/DefaultVideo.html#method_setVideoCodec"><abbr title="FFMpeg\Format\Video\DefaultVideo">DefaultVideo</abbr></a> at line 181</div>
<div class="location">in <a href="../../../FFMpeg/Format/Video/DefaultVideo.html#method_setVideoCodec"><abbr title="FFMpeg\Format\Video\DefaultVideo">DefaultVideo</abbr></a> at line 186</div>
<code> public
<strong>setVideoCodec</strong>(string $videoCodec)</code>
</h3>
@ -490,7 +500,7 @@
</div>
<h3 id="method_getGOPsize">
<div class="location">in <a href="../../../FFMpeg/Format/Video/DefaultVideo.html#method_getGOPsize"><abbr title="FFMpeg\Format\Video\DefaultVideo">DefaultVideo</abbr></a> at line 198</div>
<div class="location">in <a href="../../../FFMpeg/Format/Video/DefaultVideo.html#method_getGOPsize"><abbr title="FFMpeg\Format\Video\DefaultVideo">DefaultVideo</abbr></a> at line 203</div>
<code> public
<strong>getGOPsize</strong>()</code>
</h3>
@ -505,7 +515,7 @@
</div>
<h3 id="method_setGOPsize">
<div class="location">in <a href="../../../FFMpeg/Format/Video/DefaultVideo.html#method_setGOPsize"><abbr title="FFMpeg\Format\Video\DefaultVideo">DefaultVideo</abbr></a> at line 210</div>
<div class="location">in <a href="../../../FFMpeg/Format/Video/DefaultVideo.html#method_setGOPsize"><abbr title="FFMpeg\Format\Video\DefaultVideo">DefaultVideo</abbr></a> at line 215</div>
<code> public
<strong>setGOPsize</strong>(integer $GOPsize)</code>
</h3>
@ -538,9 +548,24 @@
</div>
</div>
<h3 id="method_getAvailableAudioCodecs">
<h3 id="method_supportBFrames">
<div class="location">at line 27</div>
<code> public
<strong>supportBFrames</strong>()</code>
</h3>
<div class="details">
<p>{@inheritDoc}</p>
<p></p>
<div class="tags">
</div>
</div>
<h3 id="method_getAvailableAudioCodecs">
<div class="location">at line 35</div>
<code> public
<strong>getAvailableAudioCodecs</strong>()</code>
</h3>
<div class="details">
@ -554,7 +579,7 @@
</div>
<h3 id="method_getAvailableVideoCodecs">
<div class="location">at line 35</div>
<div class="location">at line 43</div>
<code> public
<strong>getAvailableVideoCodecs</strong>()</code>
</h3>

54
docs/source/API/API/FFMpeg/Format/Video/Resamplable.html
View file

@ -44,6 +44,16 @@
<p>Returns the frame rate</p>
</td>
<td></td>
</tr>
<tr>
<td class="type">
Boolean
</td>
<td class="last">
<a href="#method_supportBFrames">supportBFrames</a>()
<p>Returns true if the current format supports B-Frames</p>
</td>
<td></td>
</tr>
<tr>
<td class="type">
@ -84,8 +94,41 @@
</div>
</div>
<h3 id="method_supportBFrames">
<div class="location">at line 40</div>
<code> public Boolean
<strong>supportBFrames</strong>()</code>
</h3>
<div class="details">
<p>Returns true if the current format supports B-Frames</p>
<p></p>
<div class="tags">
<h4>Return Value</h4>
<table>
<tr>
<td>Boolean</td>
<td></td>
</tr>
</table>
<h4>See also</h4>
<table>
<tr>
<td>https://wikipedia.org/wiki/Video_compression_picture_types</td>
<td></td>
</tr>
</table>
</div>
</div>
<h3 id="method_getGOPSize">
<div class="location">at line 38</div>
<div class="location">at line 49</div>
<code> public integer
<strong>getGOPSize</strong>()</code>
</h3>
@ -105,6 +148,15 @@
<h4>See also</h4>
<table>
<tr>
<td>https://wikipedia.org/wiki/Group_of_pictures</td>
<td></td>
</tr>
</table>
</div>
</div>

47
docs/source/API/API/FFMpeg/Format/Video/WebM.html
View file

@ -176,6 +176,16 @@
<tr>
<td class="type">
</td>
<td class="last">
<a href="#method_supportBFrames">supportBFrames</a>()
<p>{@inheritDoc}</p>
</td>
<td></td>
</tr>
<tr>
<td class="type">
</td>
<td class="last">
<a href="#method_getExtraParams">getExtraParams</a>()
@ -335,7 +345,7 @@
</div>
<h3 id="method_setResizeMode">
<div class="location">in <a href="../../../FFMpeg/Format/Video/DefaultVideo.html#method_setResizeMode"><abbr title="FFMpeg\Format\Video\DefaultVideo">DefaultVideo</abbr></a> at line 115</div>
<div class="location">in <a href="../../../FFMpeg/Format/Video/DefaultVideo.html#method_setResizeMode"><abbr title="FFMpeg\Format\Video\DefaultVideo">DefaultVideo</abbr></a> at line 120</div>
<code> public
<strong>setResizeMode</strong>(string $mode)</code>
</h3>
@ -369,7 +379,7 @@
</div>
<h3 id="method_getResizeMode">
<div class="location">in <a href="../../../FFMpeg/Format/Video/DefaultVideo.html#method_getResizeMode"><abbr title="FFMpeg\Format\Video\DefaultVideo">DefaultVideo</abbr></a> at line 135</div>
<div class="location">in <a href="../../../FFMpeg/Format/Video/DefaultVideo.html#method_getResizeMode"><abbr title="FFMpeg\Format\Video\DefaultVideo">DefaultVideo</abbr></a> at line 140</div>
<code> public string
<strong>getResizeMode</strong>()</code>
</h3>
@ -393,7 +403,7 @@
</div>
<h3 id="method_getFrameRate">
<div class="location">in <a href="../../../FFMpeg/Format/Video/DefaultVideo.html#method_getFrameRate"><abbr title="FFMpeg\Format\Video\DefaultVideo">DefaultVideo</abbr></a> at line 143</div>
<div class="location">in <a href="../../../FFMpeg/Format/Video/DefaultVideo.html#method_getFrameRate"><abbr title="FFMpeg\Format\Video\DefaultVideo">DefaultVideo</abbr></a> at line 148</div>
<code> public integer
<strong>getFrameRate</strong>()</code>
</h3>
@ -417,7 +427,7 @@
</div>
<h3 id="method_setFrameRate">
<div class="location">in <a href="../../../FFMpeg/Format/Video/DefaultVideo.html#method_setFrameRate"><abbr title="FFMpeg\Format\Video\DefaultVideo">DefaultVideo</abbr></a> at line 155</div>
<div class="location">in <a href="../../../FFMpeg/Format/Video/DefaultVideo.html#method_setFrameRate"><abbr title="FFMpeg\Format\Video\DefaultVideo">DefaultVideo</abbr></a> at line 160</div>
<code> public
<strong>setFrameRate</strong>(integer $frameRate)</code>
</h3>
@ -451,7 +461,7 @@
</div>
<h3 id="method_getVideoCodec">
<div class="location">in <a href="../../../FFMpeg/Format/Video/DefaultVideo.html#method_getVideoCodec"><abbr title="FFMpeg\Format\Video\DefaultVideo">DefaultVideo</abbr></a> at line 169</div>
<div class="location">in <a href="../../../FFMpeg/Format/Video/DefaultVideo.html#method_getVideoCodec"><abbr title="FFMpeg\Format\Video\DefaultVideo">DefaultVideo</abbr></a> at line 174</div>
<code> public
<strong>getVideoCodec</strong>()</code>
</h3>
@ -466,7 +476,7 @@
</div>
<h3 id="method_setVideoCodec">
<div class="location">in <a href="../../../FFMpeg/Format/Video/DefaultVideo.html#method_setVideoCodec"><abbr title="FFMpeg\Format\Video\DefaultVideo">DefaultVideo</abbr></a> at line 181</div>
<div class="location">in <a href="../../../FFMpeg/Format/Video/DefaultVideo.html#method_setVideoCodec"><abbr title="FFMpeg\Format\Video\DefaultVideo">DefaultVideo</abbr></a> at line 186</div>
<code> public
<strong>setVideoCodec</strong>(string $videoCodec)</code>
</h3>
@ -500,7 +510,7 @@
</div>
<h3 id="method_getGOPsize">
<div class="location">in <a href="../../../FFMpeg/Format/Video/DefaultVideo.html#method_getGOPsize"><abbr title="FFMpeg\Format\Video\DefaultVideo">DefaultVideo</abbr></a> at line 198</div>
<div class="location">in <a href="../../../FFMpeg/Format/Video/DefaultVideo.html#method_getGOPsize"><abbr title="FFMpeg\Format\Video\DefaultVideo">DefaultVideo</abbr></a> at line 203</div>
<code> public
<strong>getGOPsize</strong>()</code>
</h3>
@ -515,7 +525,7 @@
</div>
<h3 id="method_setGOPsize">
<div class="location">in <a href="../../../FFMpeg/Format/Video/DefaultVideo.html#method_setGOPsize"><abbr title="FFMpeg\Format\Video\DefaultVideo">DefaultVideo</abbr></a> at line 210</div>
<div class="location">in <a href="../../../FFMpeg/Format/Video/DefaultVideo.html#method_setGOPsize"><abbr title="FFMpeg\Format\Video\DefaultVideo">DefaultVideo</abbr></a> at line 215</div>
<code> public
<strong>setGOPsize</strong>(integer $GOPsize)</code>
</h3>
@ -548,9 +558,24 @@
</div>
</div>
<h3 id="method_getExtraParams">
<h3 id="method_supportBFrames">
<div class="location">at line 27</div>
<code> public
<strong>supportBFrames</strong>()</code>
</h3>
<div class="details">
<p>{@inheritDoc}</p>
<p></p>
<div class="tags">
</div>
</div>
<h3 id="method_getExtraParams">
<div class="location">at line 35</div>
<code> public
<strong>getExtraParams</strong>()</code>
</h3>
<div class="details">
@ -564,7 +589,7 @@
</div>
<h3 id="method_getAvailableAudioCodecs">
<div class="location">at line 35</div>
<div class="location">at line 43</div>
<code> public
<strong>getAvailableAudioCodecs</strong>()</code>
</h3>
@ -579,7 +604,7 @@
</div>
<h3 id="method_getAvailableVideoCodecs">
<div class="location">at line 43</div>
<div class="location">at line 51</div>
<code> public
<strong>getAvailableVideoCodecs</strong>()</code>
</h3>

45
docs/source/API/API/FFMpeg/Format/Video/X264.html
View file

@ -176,6 +176,16 @@
<tr>
<td class="type">
</td>
<td class="last">
<a href="#method_supportBFrames">supportBFrames</a>()
<p>{@inheritDoc}</p>
</td>
<td></td>
</tr>
<tr>
<td class="type">
</td>
<td class="last">
<a href="#method_getAvailableAudioCodecs">getAvailableAudioCodecs</a>()
@ -325,7 +335,7 @@
</div>
<h3 id="method_setResizeMode">
<div class="location">in <a href="../../../FFMpeg/Format/Video/DefaultVideo.html#method_setResizeMode"><abbr title="FFMpeg\Format\Video\DefaultVideo">DefaultVideo</abbr></a> at line 115</div>
<div class="location">in <a href="../../../FFMpeg/Format/Video/DefaultVideo.html#method_setResizeMode"><abbr title="FFMpeg\Format\Video\DefaultVideo">DefaultVideo</abbr></a> at line 120</div>
<code> public
<strong>setResizeMode</strong>(string $mode)</code>
</h3>
@ -359,7 +369,7 @@
</div>
<h3 id="method_getResizeMode">
<div class="location">in <a href="../../../FFMpeg/Format/Video/DefaultVideo.html#method_getResizeMode"><abbr title="FFMpeg\Format\Video\DefaultVideo">DefaultVideo</abbr></a> at line 135</div>
<div class="location">in <a href="../../../FFMpeg/Format/Video/DefaultVideo.html#method_getResizeMode"><abbr title="FFMpeg\Format\Video\DefaultVideo">DefaultVideo</abbr></a> at line 140</div>
<code> public string
<strong>getResizeMode</strong>()</code>
</h3>
@ -383,7 +393,7 @@
</div>
<h3 id="method_getFrameRate">
<div class="location">in <a href="../../../FFMpeg/Format/Video/DefaultVideo.html#method_getFrameRate"><abbr title="FFMpeg\Format\Video\DefaultVideo">DefaultVideo</abbr></a> at line 143</div>
<div class="location">in <a href="../../../FFMpeg/Format/Video/DefaultVideo.html#method_getFrameRate"><abbr title="FFMpeg\Format\Video\DefaultVideo">DefaultVideo</abbr></a> at line 148</div>
<code> public integer
<strong>getFrameRate</strong>()</code>
</h3>
@ -407,7 +417,7 @@
</div>
<h3 id="method_setFrameRate">
<div class="location">in <a href="../../../FFMpeg/Format/Video/DefaultVideo.html#method_setFrameRate"><abbr title="FFMpeg\Format\Video\DefaultVideo">DefaultVideo</abbr></a> at line 155</div>
<div class="location">in <a href="../../../FFMpeg/Format/Video/DefaultVideo.html#method_setFrameRate"><abbr title="FFMpeg\Format\Video\DefaultVideo">DefaultVideo</abbr></a> at line 160</div>
<code> public
<strong>setFrameRate</strong>(integer $frameRate)</code>
</h3>
@ -441,7 +451,7 @@
</div>
<h3 id="method_getVideoCodec">
<div class="location">in <a href="../../../FFMpeg/Format/Video/DefaultVideo.html#method_getVideoCodec"><abbr title="FFMpeg\Format\Video\DefaultVideo">DefaultVideo</abbr></a> at line 169</div>
<div class="location">in <a href="../../../FFMpeg/Format/Video/DefaultVideo.html#method_getVideoCodec"><abbr title="FFMpeg\Format\Video\DefaultVideo">DefaultVideo</abbr></a> at line 174</div>
<code> public
<strong>getVideoCodec</strong>()</code>
</h3>
@ -456,7 +466,7 @@
</div>
<h3 id="method_setVideoCodec">
<div class="location">in <a href="../../../FFMpeg/Format/Video/DefaultVideo.html#method_setVideoCodec"><abbr title="FFMpeg\Format\Video\DefaultVideo">DefaultVideo</abbr></a> at line 181</div>
<div class="location">in <a href="../../../FFMpeg/Format/Video/DefaultVideo.html#method_setVideoCodec"><abbr title="FFMpeg\Format\Video\DefaultVideo">DefaultVideo</abbr></a> at line 186</div>
<code> public
<strong>setVideoCodec</strong>(string $videoCodec)</code>
</h3>
@ -490,7 +500,7 @@
</div>
<h3 id="method_getGOPsize">
<div class="location">in <a href="../../../FFMpeg/Format/Video/DefaultVideo.html#method_getGOPsize"><abbr title="FFMpeg\Format\Video\DefaultVideo">DefaultVideo</abbr></a> at line 198</div>
<div class="location">in <a href="../../../FFMpeg/Format/Video/DefaultVideo.html#method_getGOPsize"><abbr title="FFMpeg\Format\Video\DefaultVideo">DefaultVideo</abbr></a> at line 203</div>
<code> public
<strong>getGOPsize</strong>()</code>
</h3>
@ -505,7 +515,7 @@
</div>
<h3 id="method_setGOPsize">
<div class="location">in <a href="../../../FFMpeg/Format/Video/DefaultVideo.html#method_setGOPsize"><abbr title="FFMpeg\Format\Video\DefaultVideo">DefaultVideo</abbr></a> at line 210</div>
<div class="location">in <a href="../../../FFMpeg/Format/Video/DefaultVideo.html#method_setGOPsize"><abbr title="FFMpeg\Format\Video\DefaultVideo">DefaultVideo</abbr></a> at line 215</div>
<code> public
<strong>setGOPsize</strong>(integer $GOPsize)</code>
</h3>
@ -538,9 +548,24 @@
</div>
</div>
<h3 id="method_getAvailableAudioCodecs">
<h3 id="method_supportBFrames">
<div class="location">at line 27</div>
<code> public
<strong>supportBFrames</strong>()</code>
</h3>
<div class="details">
<p>{@inheritDoc}</p>
<p></p>
<div class="tags">
</div>
</div>
<h3 id="method_getAvailableAudioCodecs">
<div class="location">at line 35</div>
<code> public
<strong>getAvailableAudioCodecs</strong>()</code>
</h3>
<div class="details">
@ -554,7 +579,7 @@
</div>
<h3 id="method_getAvailableVideoCodecs">
<div class="location">at line 35</div>
<div class="location">at line 43</div>
<code> public
<strong>getAvailableVideoCodecs</strong>()</code>
</h3>

12
docs/source/API/API/doc-index.html
View file

@ -69,7 +69,8 @@
<dd>FFMpeg driver</dd><dt><a href="FFMpeg/FFProbe.html"><abbr title="FFMpeg\FFProbe">FFProbe</abbr></a> &mdash; <em>Class in namespace <a href="FFMpeg.html">FFMpeg</a></em></dt>
<dd>FFProbe driver</dd><dt><a href="FFMpeg/Format/Audio/Flac.html"><abbr title="FFMpeg\Format\Audio\Flac">Flac</abbr></a> &mdash; <em>Class in namespace <a href="FFMpeg/Format/Audio.html">FFMpeg\Format\Audio</a></em></dt>
<dd>The Flac audio format</dd> </dl><h2 id="letterG">G</h2>
<dl id="index"><dt><a href="FFMpeg/Format/Audio.html#method_getKiloBitrate"><abbr title="FFMpeg\Format\Audio">Audio</abbr>::getKiloBitrate</a>() &mdash; <em>Method in class <a href="FFMpeg/Format/Audio.html"><abbr title="FFMpeg\Format\Audio">Audio</abbr></a></em></dt>
<dl id="index"><dt><a href="FFMpeg/FFMpeg.html#method_getThreads"><abbr title="FFMpeg\FFMpeg">FFMpeg</abbr>::getThreads</a>() &mdash; <em>Method in class <a href="FFMpeg/FFMpeg.html"><abbr title="FFMpeg\FFMpeg">FFMpeg</abbr></a></em></dt>
<dd></dd><dt><a href="FFMpeg/Format/Audio.html#method_getKiloBitrate"><abbr title="FFMpeg\Format\Audio">Audio</abbr>::getKiloBitrate</a>() &mdash; <em>Method in class <a href="FFMpeg/Format/Audio.html"><abbr title="FFMpeg\Format\Audio">Audio</abbr></a></em></dt>
<dd>Get the kiloBitrate value</dd><dt><a href="FFMpeg/Format/Audio.html#method_getExtraParams"><abbr title="FFMpeg\Format\Audio">Audio</abbr>::getExtraParams</a>() &mdash; <em>Method in class <a href="FFMpeg/Format/Audio.html"><abbr title="FFMpeg\Format\Audio">Audio</abbr></a></em></dt>
<dd>Give som extra parameters to add to ffmpeg commandline Parameters MUST be escaped</dd><dt><a href="FFMpeg/Format/Audio/DefaultAudio.html#method_getExtraParams"><abbr title="FFMpeg\Format\Audio\DefaultAudio">DefaultAudio</abbr>::getExtraParams</a>() &mdash; <em>Method in class <a href="FFMpeg/Format/Audio/DefaultAudio.html"><abbr title="FFMpeg\Format\Audio\DefaultAudio">DefaultAudio</abbr></a></em></dt>
<dd>Returns extra parameters for the encoding</dd><dt><a href="FFMpeg/Format/Audio/DefaultAudio.html#method_getAudioCodec"><abbr title="FFMpeg\Format\Audio\DefaultAudio">DefaultAudio</abbr>::getAudioCodec</a>() &mdash; <em>Method in class <a href="FFMpeg/Format/Audio/DefaultAudio.html"><abbr title="FFMpeg\Format\Audio\DefaultAudio">DefaultAudio</abbr></a></em></dt>
@ -123,7 +124,8 @@
<dd>The resamplable audio interface</dd><dt><a href="FFMpeg/Format/Video/Resamplable.html"><abbr title="FFMpeg\Format\Video\Resamplable">Resamplable</abbr></a> &mdash; <em>Class in namespace <a href="FFMpeg/Format/Video.html">FFMpeg\Format\Video</a></em></dt>
<dd>The resamplable video interface</dd><dt><a href="FFMpeg/Format/Video/Resizable.html"><abbr title="FFMpeg\Format\Video\Resizable">Resizable</abbr></a> &mdash; <em>Class in namespace <a href="FFMpeg/Format/Video.html">FFMpeg\Format\Video</a></em></dt>
<dd>The resizable video interface</dd> </dl><h2 id="letterS">S</h2>
<dl id="index"><dt><a href="FFMpeg/FFMpeg.html#method_setProber"><abbr title="FFMpeg\FFMpeg">FFMpeg</abbr>::setProber</a>() &mdash; <em>Method in class <a href="FFMpeg/FFMpeg.html"><abbr title="FFMpeg\FFMpeg">FFMpeg</abbr></a></em></dt>
<dl id="index"><dt><a href="FFMpeg/FFMpeg.html#method_setThreads"><abbr title="FFMpeg\FFMpeg">FFMpeg</abbr>::setThreads</a>() &mdash; <em>Method in class <a href="FFMpeg/FFMpeg.html"><abbr title="FFMpeg\FFMpeg">FFMpeg</abbr></a></em></dt>
<dd></dd><dt><a href="FFMpeg/FFMpeg.html#method_setProber"><abbr title="FFMpeg\FFMpeg">FFMpeg</abbr>::setProber</a>() &mdash; <em>Method in class <a href="FFMpeg/FFMpeg.html"><abbr title="FFMpeg\FFMpeg">FFMpeg</abbr></a></em></dt>
<dd>Set a prober</dd><dt><a href="FFMpeg/Format/Audio/DefaultAudio.html#method_setAudioCodec"><abbr title="FFMpeg\Format\Audio\DefaultAudio">DefaultAudio</abbr>::setAudioCodec</a>() &mdash; <em>Method in class <a href="FFMpeg/Format/Audio/DefaultAudio.html"><abbr title="FFMpeg\Format\Audio\DefaultAudio">DefaultAudio</abbr></a></em></dt>
<dd>Set the audio codec, Should be in the available ones, otherwise an exception is thrown</dd><dt><a href="FFMpeg/Format/Audio/DefaultAudio.html#method_setAudioSampleRate"><abbr title="FFMpeg\Format\Audio\DefaultAudio">DefaultAudio</abbr>::setAudioSampleRate</a>() &mdash; <em>Method in class <a href="FFMpeg/Format/Audio/DefaultAudio.html"><abbr title="FFMpeg\Format\Audio\DefaultAudio">DefaultAudio</abbr></a></em></dt>
<dd>Set the audio sample rate</dd><dt><a href="FFMpeg/Format/Audio/DefaultAudio.html#method_setKiloBitrate"><abbr title="FFMpeg\Format\Audio\DefaultAudio">DefaultAudio</abbr>::setKiloBitrate</a>() &mdash; <em>Method in class <a href="FFMpeg/Format/Audio/DefaultAudio.html"><abbr title="FFMpeg\Format\Audio\DefaultAudio">DefaultAudio</abbr></a></em></dt>
@ -132,7 +134,11 @@
<dd>Set the resize mode</dd><dt><a href="FFMpeg/Format/Video/DefaultVideo.html#method_setFrameRate"><abbr title="FFMpeg\Format\Video\DefaultVideo">DefaultVideo</abbr>::setFrameRate</a>() &mdash; <em>Method in class <a href="FFMpeg/Format/Video/DefaultVideo.html"><abbr title="FFMpeg\Format\Video\DefaultVideo">DefaultVideo</abbr></a></em></dt>
<dd>Set the framerate</dd><dt><a href="FFMpeg/Format/Video/DefaultVideo.html#method_setVideoCodec"><abbr title="FFMpeg\Format\Video\DefaultVideo">DefaultVideo</abbr>::setVideoCodec</a>() &mdash; <em>Method in class <a href="FFMpeg/Format/Video/DefaultVideo.html"><abbr title="FFMpeg\Format\Video\DefaultVideo">DefaultVideo</abbr></a></em></dt>
<dd>Set the video codec, Should be in the available ones, otherwise an exception is thrown</dd><dt><a href="FFMpeg/Format/Video/DefaultVideo.html#method_setGOPsize"><abbr title="FFMpeg\Format\Video\DefaultVideo">DefaultVideo</abbr>::setGOPsize</a>() &mdash; <em>Method in class <a href="FFMpeg/Format/Video/DefaultVideo.html"><abbr title="FFMpeg\Format\Video\DefaultVideo">DefaultVideo</abbr></a></em></dt>
<dd>Set the GOP size</dd> </dl><h2 id="letterT">T</h2>
<dd>Set the GOP size</dd><dt><a href="FFMpeg/Format/Video/Ogg.html#method_supportBFrames"><abbr title="FFMpeg\Format\Video\Ogg">Ogg</abbr>::supportBFrames</a>() &mdash; <em>Method in class <a href="FFMpeg/Format/Video/Ogg.html"><abbr title="FFMpeg\Format\Video\Ogg">Ogg</abbr></a></em></dt>
<dd>{@inheritDoc}</dd><dt><a href="FFMpeg/Format/Video/Resamplable.html#method_supportBFrames"><abbr title="FFMpeg\Format\Video\Resamplable">Resamplable</abbr>::supportBFrames</a>() &mdash; <em>Method in class <a href="FFMpeg/Format/Video/Resamplable.html"><abbr title="FFMpeg\Format\Video\Resamplable">Resamplable</abbr></a></em></dt>
<dd>Returns true if the current format supports B-Frames</dd><dt><a href="FFMpeg/Format/Video/WebM.html#method_supportBFrames"><abbr title="FFMpeg\Format\Video\WebM">WebM</abbr>::supportBFrames</a>() &mdash; <em>Method in class <a href="FFMpeg/Format/Video/WebM.html"><abbr title="FFMpeg\Format\Video\WebM">WebM</abbr></a></em></dt>
<dd>{@inheritDoc}</dd><dt><a href="FFMpeg/Format/Video/X264.html#method_supportBFrames"><abbr title="FFMpeg\Format\Video\X264">X264</abbr>::supportBFrames</a>() &mdash; <em>Method in class <a href="FFMpeg/Format/Video/X264.html"><abbr title="FFMpeg\Format\Video\X264">X264</abbr></a></em></dt>
<dd>{@inheritDoc}</dd> </dl><h2 id="letterT">T</h2>
<dl id="index"><dt><a href="FFMpeg/Format/Audio/Transcodable.html"><abbr title="FFMpeg\Format\Audio\Transcodable">Transcodable</abbr></a> &mdash; <em>Class in namespace <a href="FFMpeg/Format/Audio.html">FFMpeg\Format\Audio</a></em></dt>
<dd></dd><dt><a href="FFMpeg/Format/Video/Transcodable.html"><abbr title="FFMpeg\Format\Video\Transcodable">Transcodable</abbr></a> &mdash; <em>Class in namespace <a href="FFMpeg/Format/Video.html">FFMpeg\Format\Video</a></em></dt>
<dd></dd> </dl><h2 id="letterV">V</h2>

2
docs/source/API/API/renderer.index
View file

@ -1 +1 @@
C:19:"Sami\Renderer\Index":2336:{a:3:{i:0;a:26:{s:23:"FFMpeg\AdapterInterface";s:40:"692055cd227655999c71a444af1aca35a74b4bef";s:13:"FFMpeg\Binary";s:40:"f8d36cb52f6907aca66bfb0d6c5a28f1c7c808ff";s:40:"FFMpeg\Exception\BinaryNotFoundException";s:40:"87f8f8a978534ffac0938c80140f53937be42b20";s:26:"FFMpeg\Exception\Exception";s:40:"f34b568cf514a3e72dd2f6b85ccb72985173fd04";s:41:"FFMpeg\Exception\InvalidArgumentException";s:40:"7c8fce1704e07a412e53455727b4fb3b76add274";s:31:"FFMpeg\Exception\LogicException";s:40:"312d742fa4413eb0bbc96cc9a5878c3a882a7d9e";s:33:"FFMpeg\Exception\RuntimeException";s:40:"4eb84ded48af1748aac5d58f5386c489fccd7b41";s:13:"FFMpeg\FFMpeg";s:40:"c287f9e4cd23a46daa1258ec1effb1e0c021ab93";s:14:"FFMpeg\FFProbe";s:40:"61d111513afc0ab1b113c679951213f9b92edf01";s:19:"FFMpeg\Format\Audio";s:40:"de3bd45cfbe199120004b172937c2424519c2ed0";s:32:"FFMpeg\Format\Audio\DefaultAudio";s:40:"046d63981e0d45fe78ae0218504085aded8e4465";s:24:"FFMpeg\Format\Audio\Flac";s:40:"dd42337e79f87bf1e65107553d718ddd9620fdaf";s:31:"FFMpeg\Format\Audio\Interactive";s:40:"c690469cd7aff29b71406326c0895c0669d02855";s:23:"FFMpeg\Format\Audio\Mp3";s:40:"0636d17bef3adb55c8ed0ab0ef2c855bf62321db";s:31:"FFMpeg\Format\Audio\Resamplable";s:40:"24be9dee2b1bf9a8d658fdf0d9a45866f1763aa1";s:32:"FFMpeg\Format\Audio\Transcodable";s:40:"bbf9a19a6dfb3c305826cc7922aab24a9c03afd1";s:23:"FFMpeg\Format\Dimension";s:40:"cdcd388588cee5c6886fba118f358c9abe36f00a";s:19:"FFMpeg\Format\Video";s:40:"eca501be9309a062e98afcb5d68a4372a39ebc63";s:32:"FFMpeg\Format\Video\DefaultVideo";s:40:"d6394d85ac5bf1a5fea22995014a21926051cccd";s:31:"FFMpeg\Format\Video\Interactive";s:40:"36c13c440c19994100f1d442ac36079ef65052c7";s:23:"FFMpeg\Format\Video\Ogg";s:40:"ce478b19a35f29852ddb4fc2bc32e1f6c63e4764";s:31:"FFMpeg\Format\Video\Resamplable";s:40:"d84d06719d9a4b1a9693a0f9617e3ddce43e379a";s:29:"FFMpeg\Format\Video\Resizable";s:40:"500e975f6a744fdcbb15c1012598025b3699c877";s:32:"FFMpeg\Format\Video\Transcodable";s:40:"c9a038aabc4e2f3ca993b65851a215e6ce3f93bd";s:24:"FFMpeg\Format\Video\WebM";s:40:"b1c9fe2408d2a10b3c4fa86fa7201cc7fa1cbd6c";s:24:"FFMpeg\Format\Video\X264";s:40:"00f10c808abe7abf914b4c40bdfaa493db24cc05";}i:1;a:1:{i:0;s:6:"master";}i:2;a:5:{i:0;s:6:"FFMpeg";i:1;s:16:"FFMpeg\Exception";i:2;s:13:"FFMpeg\Format";i:3;s:19:"FFMpeg\Format\Audio";i:4;s:19:"FFMpeg\Format\Video";}}}
C:19:"Sami\Renderer\Index":2336:{a:3:{i:0;a:26:{s:23:"FFMpeg\AdapterInterface";s:40:"692055cd227655999c71a444af1aca35a74b4bef";s:13:"FFMpeg\Binary";s:40:"f8d36cb52f6907aca66bfb0d6c5a28f1c7c808ff";s:40:"FFMpeg\Exception\BinaryNotFoundException";s:40:"87f8f8a978534ffac0938c80140f53937be42b20";s:26:"FFMpeg\Exception\Exception";s:40:"f34b568cf514a3e72dd2f6b85ccb72985173fd04";s:41:"FFMpeg\Exception\InvalidArgumentException";s:40:"7c8fce1704e07a412e53455727b4fb3b76add274";s:31:"FFMpeg\Exception\LogicException";s:40:"312d742fa4413eb0bbc96cc9a5878c3a882a7d9e";s:33:"FFMpeg\Exception\RuntimeException";s:40:"4eb84ded48af1748aac5d58f5386c489fccd7b41";s:13:"FFMpeg\FFMpeg";s:40:"905f049ce59818433a6cf2a5d04a18b07b97a033";s:14:"FFMpeg\FFProbe";s:40:"f87511d2e814fb6babca5fe51b312fa90a1f56e9";s:19:"FFMpeg\Format\Audio";s:40:"de3bd45cfbe199120004b172937c2424519c2ed0";s:32:"FFMpeg\Format\Audio\DefaultAudio";s:40:"046d63981e0d45fe78ae0218504085aded8e4465";s:24:"FFMpeg\Format\Audio\Flac";s:40:"dd42337e79f87bf1e65107553d718ddd9620fdaf";s:31:"FFMpeg\Format\Audio\Interactive";s:40:"c690469cd7aff29b71406326c0895c0669d02855";s:23:"FFMpeg\Format\Audio\Mp3";s:40:"0636d17bef3adb55c8ed0ab0ef2c855bf62321db";s:31:"FFMpeg\Format\Audio\Resamplable";s:40:"24be9dee2b1bf9a8d658fdf0d9a45866f1763aa1";s:32:"FFMpeg\Format\Audio\Transcodable";s:40:"bbf9a19a6dfb3c305826cc7922aab24a9c03afd1";s:23:"FFMpeg\Format\Dimension";s:40:"fe4fb8353f1a170ee8d47b02d1d1191ad1da39c3";s:19:"FFMpeg\Format\Video";s:40:"eca501be9309a062e98afcb5d68a4372a39ebc63";s:32:"FFMpeg\Format\Video\DefaultVideo";s:40:"e84cc619bf30ee9793f61478e3812403c30394af";s:31:"FFMpeg\Format\Video\Interactive";s:40:"36c13c440c19994100f1d442ac36079ef65052c7";s:23:"FFMpeg\Format\Video\Ogg";s:40:"21a4630b36a411a622ad99201545e3d7fcfa75e6";s:31:"FFMpeg\Format\Video\Resamplable";s:40:"b3af34bb13a73f82994589fa99c5ed0d647f320a";s:29:"FFMpeg\Format\Video\Resizable";s:40:"500e975f6a744fdcbb15c1012598025b3699c877";s:32:"FFMpeg\Format\Video\Transcodable";s:40:"c9a038aabc4e2f3ca993b65851a215e6ce3f93bd";s:24:"FFMpeg\Format\Video\WebM";s:40:"162abdf0e0e688a8e5a0cc53cfeddde869a302b1";s:24:"FFMpeg\Format\Video\X264";s:40:"c235f5ff052386b78fe42c6b10cdfecb3a655394";}i:1;a:1:{i:0;s:6:"master";}i:2;a:5:{i:0;s:6:"FFMpeg";i:1;s:16:"FFMpeg\Exception";i:2;s:13:"FFMpeg\Format";i:3;s:19:"FFMpeg\Format\Audio";i:4;s:19:"FFMpeg\Format\Video";}}}

4
docs/source/API/API/search_index.js
View file

File diff suppressed because one or more lines are too long