From dc3df3edd5843bde0c1335d6a8e460b2c832aa48 Mon Sep 17 00:00:00 2001 From: Foghrye4 Date: Sat, 17 Jun 2017 08:12:18 +0300 Subject: full project files --- javadoc/ibxm/Player.html | 355 +++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 355 insertions(+) create mode 100644 javadoc/ibxm/Player.html (limited to 'javadoc/ibxm/Player.html') diff --git a/javadoc/ibxm/Player.html b/javadoc/ibxm/Player.html new file mode 100644 index 0000000..781bfa8 --- /dev/null +++ b/javadoc/ibxm/Player.html @@ -0,0 +1,355 @@ + + + + + +Player (Forge API) + + + + + + + +
+ + + + + +
+ + + +
+
ibxm
+

Class Player

+
+
+ +
+
    +
  • +
    +
    +
    public class Player
    +extends java.lang.Object
    +
  • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      Player() +
      Instantiate a new Player.
      +
      +
    • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      static Moduleload_module(java.io.InputStream input) +
      Decode the data in the specified InputStream into a Module instance.
      +
      static voidmain(java.lang.String[] args) +
      Simple command-line test player.
      +
      voidplay() +
      Open the audio device and begin playback.
      +
      voidset_loop(boolean loop) +
      If loop is true, playback will continue indefinitely, + otherwise the module will play through once and stop.
      +
      voidset_module(Module m) +
      Set the Module instance to be played.
      +
      voidstop() +
      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.
        +
      • +
      +
    • +
    +
  • +
+
+
+ + +
+ + + + + +
+ + + + -- cgit v1.2.3