Package games.stendhal.client.sound.facade

Interface SoundGroup

All Known Implementing Classes:
ExtendedSoundManager.Group, NoSoundGroup
public interface SoundGroup
a group of sounds
Author:
hendrik

  • Method Details

    • loadSound

      boolean loadSound(String name, String fileURI, SoundFileType fileType, boolean enableStreaming)
      Loads a sound
      Parameters:
      name - name of sound
      fileURI - "audio:/"
      fileType - Type.OGG
      enableStreaming - should streaming be enabled?
      Returns:
      true, if the sound could be loaded; false otherwise.

    • play

      SoundHandle play(String soundName, int layerLevel, AudibleArea area, Time fadeInDuration, boolean autoRepeat, boolean clone)
      plays a sound
      Parameters:
      soundName - name of sound
      layerLevel - on which layer should the sound be played
      area - in which area is the sound hearable?
      fadeInDuration - time the sound will fade in
      autoRepeat - should the sound be played in a loop?
      clone - should the sound be cloned for manipulation?
      Returns:
      a handle to the sound, so that it can be cancled in case of looped sounds

    • play

      SoundHandle play(String soundName, float volume, int layerLevel, AudibleArea area, Time fadeInDuration, boolean autoRepeat, boolean clone)
      plays a sound
      Parameters:
      soundName - name of sound
      volume - volumne
      layerLevel - on which layer should the sound be played
      area - in which area is the sound hearable?
      fadeInDuration - time the sound will fade in
      autoRepeat - should the sound be played in a loop?
      clone - should the sound be cloned for manipulation?
      Returns:
      a handle to the sound, so that it can be cancled in case of looped sounds

    • getVolume

      float getVolume()
      gets the current volumne
      Returns:
      volumne

    • changeVolume

      void changeVolume(float volume)
      changes the volumne
      Parameters:
      volume - volume

    • enableStreaming

      void enableStreaming()
      enables streaming for this group.