YATS/Forge Documentation
 All Classes Namespaces Files Functions Variables Enumerator Pages
ibxm.Player Class Reference

Public Member Functions

 Player () throws LineUnavailableException
 
void set_module (Module m)
 
void set_loop (boolean loop)
 
void play ()
 
void stop ()
 

Static Public Member Functions

static void main (String[] args) throws Exception
 
static Module load_module (InputStream input) throws IllegalArgumentException, IOException
 

Constructor & Destructor Documentation

ibxm.Player.Player ( ) throws LineUnavailableException

Instantiate a new Player.

Member Function Documentation

static Module ibxm.Player.load_module ( InputStream  input) throws IllegalArgumentException, IOException
static

Decode the data in the specified InputStream into a Module instance.

Parameters
inputan InputStream containing the module file to be decoded.
Exceptions
IllegalArgumentExceptionif the data is not recognised as a module file.
static void ibxm.Player.main ( String[]  args) throws Exception
static

Simple command-line test player.

void ibxm.Player.play ( )

Open the audio device and begin playback. If a module is already playing it will be restarted.

void ibxm.Player.set_loop ( boolean  loop)

If loop is true, playback will continue indefinitely, otherwise the module will play through once and stop.

void ibxm.Player.set_module ( Module  m)

Set the Module instance to be played.

void ibxm.Player.stop ( )

Stop playback and close the audio device.


The documentation for this class was generated from the following file: