Player (Forge API)

java.lang.Object
-
- ibxm.Player
-

-
-

public class Player
-extends java.lang.Object

- -

- - -
Constructor Summary
- - - - - - - - -
Constructors
Constructor and Description
Player() -
Instantiate a new Player.
-
-

Constructors
Constructor and Description
`Player()` - Instantiate a new Player. -

- -

- - -

Method Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Methods
Modifier and Type	Method and Description
`static Module`	`load_module(java.io.InputStream input)` - Decode the data in the specified InputStream into a Module instance. -
`static void`	`main(java.lang.String[] args)` - Simple command-line test player. -
`void`	`play()` - Open the audio device and begin playback. -
`void`	`set_loop(boolean loop)` - If loop is true, playback will continue indefinitely, - otherwise the module will play through once and stop. -
`void`	`set_module(Module m)` - Set the Module instance to be played. -
`void`	`stop()` - Stop playback and close the audio device. -

- - -
Methods inherited from class java.lang.Object
-clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- -
- - - -
  Constructor Detail
  - - - -
  - -
    Player
    -
```
public Player()
-       throws javax.sound.sampled.LineUnavailableException
```
    -
    Instantiate a new Player.
    -
    Throws:
    -
    javax.sound.sampled.LineUnavailableException
    -
  -
- -
- - - -
  Method Detail
  - - - -
  - -
    main
    -
```
public static void main(java.lang.String[] args)
-                 throws java.lang.Exception
```
    -
    Simple command-line test player.
    -
    Throws:
    -
    java.lang.Exception
    -
  - - - -
  - -
    load_module
    -
```
public static Module load_module(java.io.InputStream input)
-                          throws java.lang.IllegalArgumentException,
-                                 java.io.IOException
```
    -
    Decode the data in the specified InputStream into a Module instance.
    -
    Parameters:
    input - an InputStream containing the module file to be decoded.
    -
    Throws:
    -
    java.lang.IllegalArgumentException - if the data is not recognised as a module file.
    -
    java.io.IOException
    -
  - - - -
  - -
    set_module
    -
```
public void set_module(Module m)
```
    -
    Set the Module instance to be played.
    -
  - - - -
  - -
    set_loop
    -
```
public void set_loop(boolean loop)
```
    -
    If loop is true, playback will continue indefinitely, - otherwise the module will play through once and stop.
    -
  - - - -
  - -
    play
    -
```
public void play()
```
    -
    Open the audio device and begin playback. - If a module is already playing it will be restarted.
    -
  - - - -
  - -
    stop
    -
```
public void stop()
```
    -
    Stop playback and close the audio device.
    -
  -
-

Class Player

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Player

Method Detail

main

load_module

set_module

set_loop

play

stop