Package org.collebol.engine.audio

Class Sound

java.lang.Object
org.collebol.engine.audio.Sound
Direct Known Subclasses:
SoundPlayer.ModifySound
public class Sound extends Object
The Sound class represents an audio object which you can play. It handles loading sound files, setting audio properties, and managing OpenAL sources.

Usage:

     Sound sound = new Sound(new Sound.SoundBuilder()
         .path("path/to/sound.ogg")
         .id(1)
         .volume(1.0f)
         .pitch(1.0f)
         .maxDistance(100.0f)
         .rollOffFactor(1.0f)
     );
Since:
1.0-dev
Author:
ColleBol - contact@collebol.org

  • Constructor Details

    • Sound

      public Sound(Sound.SoundBuilder builder)
      Sound constructor.
      Parameters:
      builder - sound builder.

  • Method Details

    • getSource

      public int getSource()

    • getId

      public int getId()

    • getPath

      public String getPath()

    • getVolume

      public float getVolume()

    • getPitch

      public float getPitch()

    • getRefDistance

      public float getRefDistance()

    • getRollOffFactor

      public float getRollOffFactor()

    • getPosition

      public Vector2D getPosition()

    • setPosition

      public void setPosition(Vector2D position)

    • setVolume

      public void setVolume(float volume)

    • setPitch

      public void setPitch(float pitch)

    • setRefDistance

      public void setRefDistance(float refDistance)

    • setRollOffFactor

      public void setRollOffFactor(float rollOffFactor)