| pantson.mpeg: | Functions | Types | Modinfo | Source |

# MPEG

## Functions

Function CloseMPEG:Int(movie:Tmpeg)
Returns | true if succesful.
Description | Closes an MPEG file.

Function DrawMPEG:Int(movie:Tmpeg,pixmap:TPixmap)
Returns | True if a frame has been drawn.
Description | Check to see if a frame has been drawn on the specified pixmap.

Function DrawMPEGimage:Int(movie:Tmpeg,image:Timage,frame:Int=0)
Returns | True if a frame has been drawn.
Description | Check to see if a frame has been drawn on the specified image.

Function EOM:Int(movie:Tmpeg)
Returns | True if end of MPEG, false otherwise.
Description | Check to see if MPEG movie has ended.

Function MPEGfullscreen:Int(movie:Tmpeg)
Returns | This function auto calls the setscale command. Any drawing commands after setting this value will be affected too.
Description | Set the scale of the MPEG movie to fit the full screen.

Function MPEGheight:Int(movie:Tmpeg,width:Int=Null)
Returns | The height. If provided with a width, it will return a value that is in proportion.
Description | Get the height of an MPEG movie.

Function MPEGwidth:Int(movie:Tmpeg,height:Int=Null)
Returns | The width. If provided with a height, it will return a value that is in proportion.
Description | Get the width of an MPEG movie.

Function OpenMPEG:Tmpeg(filename:String,buffer_size:Int=8192)
Returns | A handle to the MPEG movie. NULL if the file doesn't exist.
Description | Opens an MPEG file ready.

Function PauseMPEG(movie:Tmpeg)
Returns | true if paused. false if resumed.
Description | Pauses or unpauses an MPEG movie.

Function StartMPEG:Int(movie:Tmpeg,seconds:Float=0)
Returns | true.
Description | Gets an MPEG ready for drawing. Can also be used for restarting an MPEG.

## Types

Type Tmpeg
Description | The MPEG type.

Method close()
Returns | true if succesful.
Description | Closes an MPEG file.

Method draw:Int(pixmap:TPixmap=Null)
Returns | True if a frame has been drawn.
Description | Check to see if a frame has been drawn on the specified pixmap.

Method open:Int(filename:String,buffer_size:Int)
Returns | A handle to the MPEG movie. NULL if the file doesn't exist.
Description | Opens an MPEG file ready for drawing.

Method pause:Int()
Returns | true if paused. false if resumed.
Description | Pauses or unpauses an MPEG movie.

Method start(t:Float=0)
Returns | true.
Description | Gets an MPEG ready For drawing. Can also be used For restarting an MPEG.

## Module Information

Version | 1.00
Author | Richard Hanson
Modserver | pantson
License | It is released under the terms of the GPL license.