Home       Trees       Indices       Help   
Blender
Module Sound :: Class Sound
[frames] | no frames]

Class Sound

The Sound object

This object gives access to Sounds in Blender.

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

getVolume()

 

Get this sound's volume. rtype: float

setVolume(f)

 

Set this sound's volume.

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

getAttenuation()

 

Get this sound's attenuation value. rtype: float

setAttenuation(f)

 

Set this sound's attenuation.

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

getPitch()

 

Get this sound's pitch value. rtype: float

setPitch(f)

 

Set this sound's pitch.

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

pack()

 

Packs the sound into the current blend file.

Returns: none
nothing

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

unpack(mode)

 

Unpacks the sound to the samples filename.

Parameters:
  • mode (int) - One of the values in Blender.Unpackmodes dict.
Returns: none
nothing

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

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

tag

A temporary tag that to flag data as being used within a loop. always set all tags to True or False before using since blender uses this flag for its own internal operations.
Type:
bool

users

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

   Home       Trees       Indices       Help   
Blender
Generated by Epydoc 3.0 on Mon Aug 31 23:12:24 2009 http://epydoc.sourceforge.net