Tekkotsu Homepage | Demos | Overview | Downloads | Dev. Resources | Reference | Credits |
SoundNode Class Reference#include <SoundNode.h>
Inheritance diagram for SoundNode:
![]() Detailed DescriptionA simple StateNode that plays a sound upon startup and throws a status event on completion.Doesn't automatically preload the sound buffer - if you want the sound file to be preloaded, you'll have to make the SoundManager::loadFile() / SoundManager::releaseFile() calls yourself. By default, sound playback will continue even after this node has been deactivated. If this is not the behavior you desire, set the autostop flag (through setAutoStop()) Definition at line 17 of file SoundNode.h.
Constructor & Destructor Documentation
constructor, specify instance name and sound file to play
Definition at line 29 of file SoundNode.h.
Member Function Documentation
activate the node, starts playing the sound
Reimplemented from StateNode. Definition at line 33 of file SoundNode.h.
deactivate the node, doesn't stop the sound playback unless the autostop flag has been set
Reimplemented from StateNode. Definition at line 42 of file SoundNode.h.
receive audioEGID status event and throw stateMachineEGID status event
Reimplemented from BehaviorBase. Definition at line 50 of file SoundNode.h.
interrupts playing of the current sound
Definition at line 56 of file SoundNode.h. Referenced by DoStop().
returns the name of the sound file associated with this node
Definition at line 62 of file SoundNode.h.
sets the name of the sound file associated with this node
Definition at line 65 of file SoundNode.h.
Member Data Documentation
filename of sound to play, accessed through setFileName() and getFileName()
Definition at line 19 of file SoundNode.h. Referenced by DoStart(), getFileName(), and setFileName().
holds the playback identification so it can be halted any time
Definition at line 20 of file SoundNode.h. Referenced by DoStart(), processEvent(), and stopPlay().
if set to true by setAutoStop(), when this node is deactivated, playback will be halted. Otherwise, playback will continue even after the node is deactivated
Definition at line 21 of file SoundNode.h. Referenced by DoStop(), getAutoStop(), and setAutoStop().
The documentation for this class was generated from the following file: |
Tekkotsu v4.0 |
Generated Thu Nov 22 00:58:42 2007 by Doxygen 1.5.4 |