Skip to content

Commit

Permalink
generated rdoc
Browse files Browse the repository at this point in the history
  • Loading branch information
@polly
polly committed Aug 5, 2009
1 parent 1e23cec commit 10fe526
Show file tree
Hide file tree
Showing 21 changed files with 3,882 additions and 0 deletions.
296 changes: 296 additions & 0 deletions rdoc/classes/FFMpeg.html
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,296 @@
<?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" xml:lang="en" lang="en">
<head>
<title>Module: FFMpeg</title>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
<meta http-equiv="Content-Script-Type" content="text/javascript" />
<link rel="stylesheet" href=".././rdoc-style.css" type="text/css" media="screen" />
<script type="text/javascript">
// <![CDATA[

function popupCode( url ) {
window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
}

function toggleCode( id ) {
if ( document.getElementById )
elem = document.getElementById( id );
else if ( document.all )
elem = eval( "document.all." + id );
else
return false;

elemStyle = elem.style;

if ( elemStyle.display != "block" ) {
elemStyle.display = "block"
} else {
elemStyle.display = "none"
}

return true;
}

// Make codeblocks hidden by default
document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )

// ]]>
</script>

</head>
<body>



<div id="classHeader">
<table class="header-table">
<tr class="top-aligned-row">
<td><strong>Module</strong></td>
<td class="class-name-in-header">FFMpeg</td>
</tr>
<tr class="top-aligned-row">
<td><strong>In:</strong></td>
<td>
<a href="../files/lib/ffmpeg/audio_options_rb.html">
lib/ffmpeg/audio_options.rb
</a>
<br />
<a href="../files/lib/ffmpeg/class_methods_rb.html">
lib/ffmpeg/class_methods.rb
</a>
<br />
<a href="../files/lib/ffmpeg/helper_methods_rb.html">
lib/ffmpeg/helper_methods.rb
</a>
<br />
<a href="../files/lib/ffmpeg/main_options_rb.html">
lib/ffmpeg/main_options.rb
</a>
<br />
<a href="../files/lib/ffmpeg/video_options_rb.html">
lib/ffmpeg/video_options.rb
</a>
<br />
<a href="../files/lib/ffmpeg_rb.html">
lib/ffmpeg.rb
</a>
<br />
</td>
</tr>

</table>
</div>
<!-- banner header -->

<div id="bodyContent">



<div id="contextContent">



</div>

<div id="method-list">
<h3 class="section-bar">Methods</h3>

<div class="name-list">
<a href="#M000006">convert</a>&nbsp;&nbsp;
<a href="#M000007">ffmpeg_path</a>&nbsp;&nbsp;
<a href="#M000005">included</a>&nbsp;&nbsp;
<a href="#M000008">run</a>&nbsp;&nbsp;
</div>
</div>

</div>


<!-- if includes -->
<div id="includes">
<h3 class="section-bar">Included Modules</h3>

<div id="includes-list">
<span class="include-name"><a href="FFMpeg/HelperMethods.html">HelperMethods</a></span>
<span class="include-name"><a href="FFMpeg/MainOptions.html">MainOptions</a></span>
<span class="include-name"><a href="FFMpeg/VideoOptions.html">VideoOptions</a></span>
<span class="include-name"><a href="FFMpeg/AudioOptions.html">AudioOptions</a></span>
</div>
</div>

<div id="section">

<div id="class-list">
<h3 class="section-bar">Classes and Modules</h3>

Module <a href="FFMpeg/AudioOptions.html" class="link">FFMpeg::AudioOptions</a><br />
Module <a href="FFMpeg/ClassMethods.html" class="link">FFMpeg::ClassMethods</a><br />
Module <a href="FFMpeg/HelperMethods.html" class="link">FFMpeg::HelperMethods</a><br />
Module <a href="FFMpeg/MainOptions.html" class="link">FFMpeg::MainOptions</a><br />
Module <a href="FFMpeg/VideoOptions.html" class="link">FFMpeg::VideoOptions</a><br />

</div>







<!-- if method_list -->
<div id="methods">
<h3 class="section-bar">Public Class methods</h3>

<div id="method-M000005" class="method-detail">
<a name="M000005"></a>

<div class="method-heading">
<a href="#M000005" class="method-signature">
<span class="method-name">included</span><span class="method-args">(klass)</span>
</a>
</div>

<div class="method-description">
<p>
When mixed into a class, extend it with the <a
href="FFMpeg/ClassMethods.html">ClassMethods</a> module
</p>
<p><a class="source-toggle" href="#"
onclick="toggleCode('M000005-source');return false;">[Source]</a></p>
<div class="method-source-code" id="M000005-source">
<pre>
<span class="ruby-comment cmt"># File lib/ffmpeg.rb, line 18</span>
18: <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">included</span>(<span class="ruby-identifier">klass</span>)
19: <span class="ruby-identifier">klass</span>.<span class="ruby-identifier">extend</span> <span class="ruby-constant">ClassMethods</span>
20:
21: <span class="ruby-comment cmt">#</span>
22: <span class="ruby-comment cmt"># Everytime a method is added to the</span>
23: <span class="ruby-comment cmt"># class, check for conflicts with existing</span>
24: <span class="ruby-comment cmt"># module methods</span>
25: <span class="ruby-comment cmt">#</span>
26: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">klass</span>.<span class="ruby-identifier">method_added</span>(<span class="ruby-identifier">name</span>)
27: <span class="ruby-identifier">check_method</span>(<span class="ruby-identifier">name</span>) <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">method_checking_enabled?</span>
28: <span class="ruby-keyword kw">end</span>
29: <span class="ruby-keyword kw">end</span>
</pre>
</div>
</div>
</div>

<h3 class="section-bar">Public Instance methods</h3>

<div id="method-M000006" class="method-detail">
<a name="M000006"></a>

<div class="method-heading">
<a href="#M000006" class="method-signature">
<span class="method-name">convert</span><span class="method-args">(from_file, to_file = {}) {|if block_given?| ...}</span>
</a>
</div>

<div class="method-description">
<p>
Sets up an FFmpegCommand for converting files:
</p>
<pre>
convert &quot;file1.ext&quot;, :to =&gt; &quot;file2.ext&quot; do
seek &quot;00:03:00&quot;
duration &quot;01:10:00&quot;
resolution &quot;800x600&quot;
end
</pre>
<p><a class="source-toggle" href="#"
onclick="toggleCode('M000006-source');return false;">[Source]</a></p>
<div class="method-source-code" id="M000006-source">
<pre>
<span class="ruby-comment cmt"># File lib/ffmpeg.rb, line 40</span>
40: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">convert</span><span class="ruby-identifier">convert</span>(<span class="ruby-identifier">from_file</span>, <span class="ruby-identifier">to_file</span> = {})
41: <span class="ruby-constant">FFMpegCommand</span> <span class="ruby-operator">&lt;&lt;</span> <span class="ruby-node">&quot;-i #{from_file}&quot;</span>
42: <span class="ruby-keyword kw">begin</span>
43: <span class="ruby-keyword kw">yield</span> <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">block_given?</span>
44: <span class="ruby-keyword kw">rescue</span> <span class="ruby-constant">Exception</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-identifier">exception</span>
45: <span class="ruby-identifier">disable_method_checking!</span>
46: <span class="ruby-identifier">raise</span> <span class="ruby-identifier">exception</span>
47: <span class="ruby-keyword kw">end</span>
48: <span class="ruby-constant">FFMpegCommand</span> <span class="ruby-operator">&lt;&lt;</span> <span class="ruby-node">&quot;#{to_file[:to]}&quot;</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">to_file</span>[<span class="ruby-identifier">:to</span>].<span class="ruby-identifier">nil?</span>
49: <span class="ruby-keyword kw">end</span>
</pre>
</div>
</div>
</div>

<div id="method-M000007" class="method-detail">
<a name="M000007"></a>

<div class="method-heading">
<a href="#M000007" class="method-signature">
<span class="method-name">ffmpeg_path</span><span class="method-args">(path)</span>
</a>
</div>

<div class="method-description">
<p>
Explicitly set ffmpeg path
</p>
<p><a class="source-toggle" href="#"
onclick="toggleCode('M000007-source');return false;">[Source]</a></p>
<div class="method-source-code" id="M000007-source">
<pre>
<span class="ruby-comment cmt"># File lib/ffmpeg.rb, line 54</span>
54: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">ffmpeg_path</span>(<span class="ruby-identifier">path</span>)
55: <span class="ruby-ivar">@@ffmpeg_path</span> = <span class="ruby-identifier">path</span>
56: <span class="ruby-keyword kw">end</span>
</pre>
</div>
</div>
</div>

<div id="method-M000008" class="method-detail">
<a name="M000008"></a>

<div class="method-heading">
<a href="#M000008" class="method-signature">
<span class="method-name">run</span><span class="method-args">()</span>
</a>
</div>

<div class="method-description">
<p>
Ru§ns ffmpeg
</p>
<p><a class="source-toggle" href="#"
onclick="toggleCode('M000008-source');return false;">[Source]</a></p>
<div class="method-source-code" id="M000008-source">
<pre>
<span class="ruby-comment cmt"># File lib/ffmpeg.rb, line 61</span>
61: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">run</span>
62: <span class="ruby-ivar">@@ffmpeg_path</span> <span class="ruby-operator">||=</span> <span class="ruby-identifier">locate_ffmpeg</span>
63: <span class="ruby-keyword kw">unless</span> <span class="ruby-ivar">@@ffmpeg_path</span>.<span class="ruby-identifier">empty?</span>
64: <span class="ruby-identifier">execute_command</span> <span class="ruby-constant">FFMpegCommand</span>.<span class="ruby-identifier">command</span>(<span class="ruby-ivar">@@ffmpeg_path</span>)
65: <span class="ruby-keyword kw">else</span>
66: <span class="ruby-identifier">$stderr</span>.<span class="ruby-identifier">puts</span> <span class="ruby-value str">&quot;Couldn't locate ffmpeg, try to specify an explicit path
67: with the ffmpeg_path(path) method&quot;</span>
68: <span class="ruby-keyword kw">end</span>
69: <span class="ruby-keyword kw">end</span>
</pre>
</div>
</div>
</div>


</div>


</div>


<div id="validator-badges">
<p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
</div>

</body>
</html>
Loading

0 comments on commit 10fe526

Please sign in to comment.