These pages are auto-generated from self-documenting comments embedded in class files.
For more information on breve and steve, refer to the breve homepage.

Abstract : Tone

Class description:

A Tone is an object which plays a constant tone. You can set the volume, frequency and left-right balance of the tone. Creating the object will automatically start playing the tone. Deleting the object will cause the tone to stop playing.

A tone can also be effectively stopped by setting its volume to 0.

Methods:

  • setBalance
  • setFrequency
  • setVolume
    setBalance( self, newBalance )

    Sets the left/right balance of the sinewave to newBalance, a value between 0 and 1. .5 is perfectly balanced, while 1.0 plays the tone completely on the right channel and 0.0 plays the tone entirely on the left channel.

    setFrequency( self, newFrequency )

    Sets the frequency of the tone to newFrequency.

    setVolume( self, newVolume )

    Sets the volume of the tone to newVolume. Volume is specified on a scale from 0.0 to 1.0.