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.
none	`pack()` Packs the sound into the current blend file.
	`play()` Play this sound.
	`setAttenuation(f)` Set this sound's attenuation.
	`setCurrent()` Make this the active sound in the sound buttons window (also redraws).
None	`setFilename()` Set the filename of the sound file loaded into this Sound object.
None	`setName()` Set the name of this Sound object.
	`setPitch(f)` Set this sound's pitch.
	`setVolume(f)` Set this sound's volume.
none	`unpack(mode)` Unpacks the sound to the samples filename.

Instance Variable Summary
bool	`fakeUser`: When set to True, this datablock wont be removed, even if nothing is using it.
	`filename`: The filename (path) to the sound file loaded into this Sound
string or None	`lib`: path to the blend file this datablock is stored in (readonly).
string	`name`: unique name within each blend file.
	`packed`: Boolean, True when the sample is packed (readonly).
`IDGroup`	`properties`: Returns an `IDGroup` reference to this datablocks's ID Properties.
bool	`tag`: A temporary tag that to flag data as being used within a loop.
int	`users`: The number of users this datablock has.

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

pack()

Packs the sound into the current blend file.

Returns:: nothing
(type=none)

Note: An error will be raised if the sound is already packed or the filename path does not exist.

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).

setFilename()

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

Returns:: None

setName()

Set the name of this Sound object.

Returns:: None

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)

unpack(mode)

Unpacks the sound to the samples filename.

Parameters:: mode - One of the values in Blender.Unpackmodes dict.
(type=int)

Returns:: nothing
(type=none)

Note: An error will be raised if the sound is not packed or the filename path does not exist.

Instance Variable Details

fakeUser

When set to True, this datablock wont be removed, even if nothing is using it. All data has this disabled by default except for Actions.

Type:: bool

filename

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

lib

path to the blend file this datablock is stored in (readonly).

lib will be None unless you are using external blend files with (File, Append/Link)

Note: the path may be relative, to get the full path use Blender.sys.expandpath

Type:: string or None

name

unique name within each blend file.

The name is case sensitive and 21 characters maximum length.

Note: a blend file may have naming collisions when external library data is used, be sure to check the value of lib.

Note: Setting a value longer then 21 characters will be shortened

Type:: string

packed

Boolean, True when the sample is packed (readonly).

properties

Returns an IDGroup reference to this datablocks's ID Properties.

Type:: IDGroup

users

The number of users this datablock has. (readonly) Zero user datablocks are de-allocated after reloading and saving.

Type:: int

Generated by Epydoc 2.1 on Thu May 10 20:31:59 2007

http://epydoc.sf.net