Class RMSound

  • All Implemented Interfaces:
    RMArchiver.Archiving, java.lang.Cloneable

    public class RMSound
    extends RMShape
    This class represents a sound in a document.
    • Constructor Detail

      • RMSound

        public RMSound()
        Creates an empty sound shape.
      • RMSound

        public RMSound​(java.lang.Object aSource)
        Creates a sound shape from a given source (File, String path, InputStream, byte array, etc.).
    • Method Detail

      • getSoundData

        public RMSoundData getSoundData()
        Returns the sound data for this sound shape.
      • setSoundData

        public void setSoundData​(RMSoundData aSoundData)
        Sets the sound data for this sound shape.
      • getKey

        public java.lang.String getKey()
        Returns the RPG key for this sound shape.
      • setKey

        public void setKey​(java.lang.String aKey)
        Sets the RPG key for this sound shape.
      • getDelay

        public float getDelay()
        Returns the delay after which this sound is supposed to start to play.
      • setDelay

        public void setDelay​(float aValue)
        Sets the delay after which this sound is supposed to start to play.
      • getLoopCount

        public int getLoopCount()
        Returns the number of loops that this sound should play before stopping.
      • setLoopCount

        public void setLoopCount​(int aValue)
        Returns the number of loops that this sound should play before stopping.
      • getOverlap

        public boolean getOverlap()
        Returns whether this sound should overlap other sounds.
      • setOverlap

        public void setOverlap​(boolean aValue)
        Returns whether this sound should overlap other sounds.
      • rpgClone

        public RMShape rpgClone​(ReportMill reportMill)
        Returns a copy of this shape for report generation - might include getting new sound data using RPG key.
        Overrides:
        rpgClone in class RMShape
      • equals

        public boolean equals​(java.lang.Object anObj)
        Standard equals implementation.
        Overrides:
        equals in class RMShape