Package schule.ngb.zm.media

Class Sound

java.lang.Object
schule.ngb.zm.media.Sound
All Implemented Interfaces:
Audio
public class Sound extends Object implements Audio
Ein kurzer Soundclip, der mehrmals wiederverwendet werden kann.

In Spielen und anderen Projekten gibt es oftmals eine Reihe kurzer Soundclips, die zusammen mit bestimmten Aktionen wiedergegeben werden (zum Beispiel, wenn die Spielfigur springt, wenn zwei Objekte kollidieren, usw.). Sounds werden vollständig in den Speicher geladen und können immer wieder, als Schleife oder auch nur Abschnittsweise, abgespielt werden.

Für längere Musikstücke (beispielsweise Hintergrundmusik) bietet sich eher die Klasse Music an.

MP3-Dateien verwenden

Java kann nativ nur Waveform (.wav) Dateien wiedergeben. Um auch MP3-Dateien zu nutzen, müssen die Bibliotheken jlayer, tritonus-share und mp3spi eingebunden werden. Details zur Verwendung können in der Dokumentation der Zeichenmaschine nachgelesen werden.

  • Constructor Summary

    Constructors
    Constructor
    Description
    Sound(String source)
    Erstellt einen Sound aus der angegebene Quelle.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    addAudioListener(AudioListener listener)
    Fügt dem Medium das angegebene Objekt als AudioListener hinzu, der bei Start und Stopp der Wiedergabe informiert wird.
    void
    dispose()
    Stoppt die Wiedergabe und gibt alle Ressourcen, die für das Medium verwendet werden, frei.
    String
    getSource()
     
    double
    getVolume()
    Liefert die aktuelle Lautstärke dieses Mediums.
    boolean
    isLooping()
    Prüft, ob das Medium gerade in einer Schleife abgespielt wird.
    boolean
    isPlaying()
    Prüft, ob das Medium gerade abgespielt wird.
    void
    loop()
    Spielt das Medium in einer kontinuierlichen Schleife ab.
    void
    loop(int count)
    Wiederholt den Sound die angegebene Anzahl an Wiederholungen und stoppt die Wiedergabe dann.
    void
    play()
    Startet die Wiedergabe des Mediums.
    void
    playAndWait()
    Startet die Wiedergabe des Mediums und blockiert das Programm, bis die Wiedergabe beendet ist.
    void
    playOnce()
    Spielt den Sound einmal ab und gibt danach alle Ressourcen des Clips frei.
    void
    playOnceAndWait()
    Spielt den Sound einmal ab und gibt danach alle Ressourcen des Clips frei.
    void
    removeAudioListener(AudioListener listener)
    Entfernt den angegebenen AudioListener vom Medium.
    void
    setVolume(double volume)
    Legt die Lautstärke des Mediums beim Abspielen fest.
    void
    stop()
    Stoppt die Wiedergabe.

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Constructor Details

  • Method Details

    • getSource

      public String getSource()
      Specified by:
      getSource in interface Audio
      Returns:
      Die Quelle, aus der das Medium geladen wurde.

    • isPlaying

      public boolean isPlaying()
      Description copied from interface: Audio
      Prüft, ob das Medium gerade abgespielt wird.
      Specified by:
      isPlaying in interface Audio
      Returns:
      true, wenn das Medium abgespielt wird, false sonst.

    • isLooping

      public boolean isLooping()
      Description copied from interface: Audio
      Prüft, ob das Medium gerade in einer Schleife abgespielt wird. Wenn isLooping() == true gilt, dann muss auch immer isPlaying() == true gelten.
      Specified by:
      isLooping in interface Audio
      Returns:
      true, wenn das Medium in einer Schleife abgespielt wird, false sonst.

    • setVolume

      public void setVolume(double volume)
      Description copied from interface: Audio
      Legt die Lautstärke des Mediums beim Abspielen fest.

      Die Lautstärke wird auf einer linearen Skale festgelegt, wobei 0 kein Ton und 1 volle Lautstärke bedeutet. Werte über 1 verstärken den Ton des Mediums. Negative Werte setzen die Lautstärke aud 0.

      Specified by:
      setVolume in interface Audio
      Parameters:
      volume - Die neue Lautstärke zwischen 0 und 1.
      See Also:

    • getVolume

      public double getVolume()
      Description copied from interface: Audio
      Liefert die aktuelle Lautstärke dieses Mediums.

      Die Lautstärke wird auf einer linearen Skale angegeben, wobei 0 kein Ton und 1 volle Lautstärke bedeutet. Werte über 1 verstärken den Ton des Mediums.

      Specified by:
      getVolume in interface Audio
      Returns:
      Die Lautstärke als linear skalierter Wert.

    • stop

      public void stop()
      Description copied from interface: Audio
      Stoppt die Wiedergabe. Wird das Medium gerade nicht abgespielt (isPlaying() == false), dann passiert nichts.
      Specified by:
      stop in interface Audio

    • play

      public void play()
      Description copied from interface: Audio
      Startet die Wiedergabe des Mediums. Das Audio-Medium wird einmal abgespielt und stoppt dann.

      Die Methode beendet sofort und die Wiedergabe erfolgt im Hintergrund. Soll die Programmausführung erst nach Wiedergabe des Mediums fortgesetzt werden, sollte Audio.playAndWait() verwendet werden.

      Soll die Wiedergabe im Hintergrund ablaufen, aber dennoch auf das Ende reagiert werden, kann ein AudioListener verwendet werden.

      Specified by:
      play in interface Audio

    • playAndWait

      public void playAndWait()
      Description copied from interface: Audio
      Startet die Wiedergabe des Mediums und blockiert das Programm, bis die Wiedergabe beendet ist.
      Specified by:
      playAndWait in interface Audio

    • playOnce

      public void playOnce()
      Spielt den Sound einmal ab und gibt danach alle Ressourcen des Clips frei.

      Der Aufruf ist effektiv gleich zu 

      
 clip.playAndWait();
 clip.dispose();
      allerdings wird der aufrufende Thread nicht blockiert und dispose() automatisch am Ende aufgerufen.

    • playOnceAndWait

      public void playOnceAndWait()
      Spielt den Sound einmal ab und gibt danach alle Ressourcen des Clips frei.

      Der Aufruf entspricht 

      
 clip.playAndWait();
 clip.dispose();

    • loop

      public void loop()
      Description copied from interface: Audio
      Spielt das Medium in einer kontinuierlichen Schleife ab. Die Methode startet die Wiedergabe im Hintergrund und beendet dann sofort. Um die Wiedergabe zu stoppen, muss Audio.stop() aufgerufen werden.
      Specified by:
      loop in interface Audio

    • loop

      public void loop(int count)
      Wiederholt den Sound die angegebene Anzahl an Wiederholungen und stoppt die Wiedergabe dann.

      Wird count auf Clip.LOOP_CONTINUOUSLY gesetzt (-1), wird der Clip unendlich oft wiederholt. Der Aufruf entspricht dann loop().

      Parameters:
      count - Anzahl der Wiederholungen.

    • dispose

      public void dispose()
      Description copied from interface: Audio
      Stoppt die Wiedergabe und gibt alle Ressourcen, die für das Medium verwendet werden, frei.
      Specified by:
      dispose in interface Audio

    • addAudioListener

      public void addAudioListener(AudioListener listener)
      Description copied from interface: Audio
      Fügt dem Medium das angegebene Objekt als AudioListener hinzu, der bei Start und Stopp der Wiedergabe informiert wird.
      Specified by:
      addAudioListener in interface Audio
      Parameters:
      listener - Das Listener-Objekt.

    • removeAudioListener

      public void removeAudioListener(AudioListener listener)
      Description copied from interface: Audio
      Entfernt den angegebenen AudioListener vom Medium.
      Specified by:
      removeAudioListener in interface Audio
      Parameters:
      listener - Das Listener-Objekt.