Updated docs and site
[sdlgit/SDL-Site.git] / pages / SDL-MPEG.html-inc
1 <div class="pod">
2 <!-- INDEX START -->
3 <h3 id="TOP">Index</h3>
4
5 <ul><li><a href="#NAME">NAME</a></li>
6 <li><a href="#CATEGORY">CATEGORY</a></li>
7 <li><a href="#SYNOPSIS">SYNOPSIS</a></li>
8 <li><a href="#DESCRIPTION">DESCRIPTION</a>
9 <ul><li><a href="#METHODS">METHODS </a></li>
10 </ul>
11 </li>
12 <li><a href="#AUTHOR">AUTHOR</a></li>
13 <li><a href="#SEE_ALSO">SEE ALSO</a>
14 </li>
15 </ul><hr />
16 <!-- INDEX END -->
17
18 <h1 id="NAME">NAME</h1><p><a href="#TOP" class="toplink">Top</a></p>
19 <div id="NAME_CONTENT">
20 <p>SDL::MPEG - a SDL perl extension</p>
21
22 </div>
23 <h1 id="CATEGORY">CATEGORY</h1><p><a href="#TOP" class="toplink">Top</a></p>
24 <div id="CATEGORY_CONTENT">
25 <p>TODO</p>
26
27 </div>
28 <h1 id="SYNOPSIS">SYNOPSIS</h1><p><a href="#TOP" class="toplink">Top</a></p>
29 <div id="SYNOPSIS_CONTENT">
30 <pre>  $info = SDL::MPEG-&gt;new( -from =&gt; $mpeg );
31
32 </pre>
33
34 </div>
35 <h1 id="DESCRIPTION">DESCRIPTION</h1><p><a href="#TOP" class="toplink">Top</a></p>
36 <div id="DESCRIPTION_CONTENT">
37 <p><code>SDL::MPEG</code> provides an interface to quering the status
38 of a SMPEG stream.  </p>
39
40 </div>
41 <h2 id="METHODS">METHODS </h2>
42 <div id="METHODS_CONTENT">
43 <ul>
44                 <li><code>SDL::MPEG::has_audio</code> returns true if it has audio track        </li>
45                 <li><code>SDL::MPEG::has_video</code> returns true if it has a video track      </li>
46                 <li><code>SDL::MPEG::width</code> returns the width of the video in pixels      </li>
47                 <li><code>SDL::MPEG::height</code> returns the height of the video in pixels    </li>
48                 <li><code>SDL::MPEG::size</code> returns the total size of the clip in bytes    </li>
49                 <li><code>SDL::MPEG::offset</code> returns the offset into the clip in bytes    </li>
50                 <li><code>SDL::MPEG::frame</code> returns the offset into the clip in fames     </li>
51                 <li><code>SDL::MPEG::fps</code> returns the play rate in frames per second      </li>
52                 <li><code>SDL::MPEG::time</code> returns the current play time in seconds       </li>
53                 <li><code>SDL::MPEG::length</code> returns the total play time in seconds</li>
54 </ul>
55
56
57 </div>
58 <h1 id="AUTHOR">AUTHOR</h1><p><a href="#TOP" class="toplink">Top</a></p>
59 <div id="AUTHOR_CONTENT">
60 <p>David J. Goehrig</p>
61
62 </div>
63 <h1 id="SEE_ALSO">SEE ALSO</h1><p><a href="#TOP" class="toplink">Top</a></p>
64 <div id="SEE_ALSO_CONTENT">
65 <p>perl(1) SDL::Video(3)</p>
66
67 </div>
68 </div>