Module Sound :: Class Sound

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.

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

Method Details

Get this sound's attenuation value. rtype: float

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

Get the name of this Sound object.

Get this sound's pitch value. rtype: float

Get this sound's volume. rtype: float

Play this sound.

Set this sound's attenuation.

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

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

Set this sound's pitch.

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

Set this sound's volume.

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

Class Variable Details

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

The name of this Sound object.

Generated by Epydoc 2.1 on Mon Jun 13 15:31:23 2005