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