Package pi.resources.sound

Class Playback

java.lang.Object
pi.resources.sound.Playback
All Implemented Interfaces:
Runnable
Direct Known Subclasses:
MusicPlayback, SoundPlayback
public abstract class Playback extends Object implements Runnable
The SoundPlayback class is a wrapper SourceDataLine on which a Sound playback can be carried out.
See Also:
  • play(Sound)

  • Field Details

  • Method Details

    • start

      public void start()
      Starts playing the audio.
      Throws:
      IllegalStateException - if the audio has already been started

    • addSoundPlaybackListener

      public void addSoundPlaybackListener(SoundPlaybackListener listener)
      Adds a SoundPlaybackListener to this instance.
      Parameters:
      listener - The SoundPlaybackListener to be added.

    • removeSoundPlaybackListener

      public void removeSoundPlaybackListener(SoundPlaybackListener listener)
      Removes a SoundPlaybackListener from this instance.
      Parameters:
      listener - The SoundPlaybackListener to be removed.

    • setPaused

      public void setPaused(boolean paused)
      Sets the paused state of this playback to the provided value.
      Parameters:
      paused - Whether to pause or resume this playback

    • pausePlayback

      public void pausePlayback()
      Pauses this playback. If this playback is already paused, this call has no effect.

    • resumePlayback

      public void resumePlayback()
      Resumes this playback. If this playback is already playing, this call has no effect.

    • isPaused

      public boolean isPaused()
      Determines if this playback is paused.
      Returns:
      Whether this playback is paused

    • isPlaying

      public boolean isPlaying()
      Determines if this playback has sound to play. If it is paused but still in the middle of playback, it will return true, but it will return false if it has finished or it has been cancelled.
      Returns:
      Whether this playback has sound to play

    • cancel

      public void cancel()
      Attempts to cancel the playback of this audio. If the playback was successfully cancelled, it will notify listeners.

    • getMasterVolume

      public float getMasterVolume()
      Gets the current volume of this playback, considering all VolumeControl objects created for it.
      Returns:
      The current volume.

    • getVolume

      public float getVolume()
      Gets the current master volume of this playback. This will be approximately equal to the value set by a previous call to setVolume, though rounding errors may occur.
      Returns:
      The settable volume.

    • setVolume

      public void setVolume(float volume)
      Sets the master volume of this playback.
      Parameters:
      volume - The new volume.

    • createVolumeControl

      public Playback.VolumeControl createVolumeControl()

    • getVolumeControls

      public Collection<Playback.VolumeControl> getVolumeControls()