Module Sound :: Class Sound
[frames | no frames]

Class Sound


The Sound object

This object gives access to Sounds in Blender.
Method Summary
  getAttenuation()
Get this sound's attenuation value.
string getFilename()
Get the filename of the sound file loaded into this Sound object.
string getName()
Get the name of this Sound object.
  getPitch()
Get this sound's pitch value.
  getVolume()
Get this sound's volume.
  play()
Play this sound.
  setAttenuation(f)
Set this sound's attenuation.
  setCurrent()
Make this the active sound in the sound buttons window (also redraws).
  setPitch(f)
Set this sound's pitch.
  setVolume(f)
Set this sound's volume.

Instance Variable Summary
  filename: The filename (path) to the sound file loaded into this Sound object.
  name: The name of this Sound object.

Method Details

getAttenuation()

Get this sound's attenuation value. rtype: float

getFilename()

Get the filename of the sound file loaded into this Sound object.
Returns:
string

getName()

Get the name of this Sound object.
Returns:
string

getPitch()

Get this sound's pitch value. rtype: float

getVolume()

Get this sound's volume. rtype: float

play()

Play this sound.

setAttenuation(f)

Set this sound's attenuation.
Parameters:
f - the new attenuation value in the range [0.0, 5.0].
           (type=float)

setCurrent()

Make this the active sound in the sound buttons window (also redraws).

setPitch(f)

Set this sound's pitch.
Parameters:
f - the new pitch value in the range [-12.0, 12.0].
           (type=float)

setVolume(f)

Set this sound's volume.
Parameters:
f - the new volume value in the range [0.0, 1.0].
           (type=float)

Instance Variable Details

filename

The filename (path) to the sound file loaded into this Sound object.

name

The name of this Sound object.

Generated by Epydoc 2.1 on Thu Dec 22 22:38:14 2005 http://epydoc.sf.net