Main Page | Class Hierarchy | Class List | File List | Class Members | File Members | Related Pages

Sound Class Reference

Sound generation interface. More...

#include <c++/Sound.H>

List of all members.

Static Public Member Functions

void play (const note_t *notes)
 Play a list of notes (song).

int playing ()
 Determine if a sound is currently playing.

void beep ()
 Play the system_beep sound.

void stop ()
 Stop a currently playing sound.

void duration (const unsigned int len)
 Set the default duration.

void internote (const unsigned int len)
 Set the amount of time between notes.


Detailed Description

Sound generation interface.

Sound Generation Class interface

See also:
The other control classes: Motor, MotorPair, Lamp

Definition at line 37 of file Sound.H.


Member Function Documentation

void Sound::beep  )  [inline, static]
 

Play the system_beep sound.

Returns:
Nothing

Definition at line 57 of file Sound.H.

References DSOUND_BEEP, and dsound_system().

void Sound::duration const unsigned int  len  )  [inline, static]
 

Set the default duration.

Parameters:
len the duration in mSec?
Returns:
Nothing
Todo:
get the real scoop here, then provde better description

Definition at line 69 of file Sound.H.

References dsound_set_duration().

void Sound::internote const unsigned int  len  )  [inline, static]
 

Set the amount of time between notes.

Parameters:
len the duration in mSec?
Returns:
Nothing
Todo:
get the real scoop here, then provde better description

Definition at line 76 of file Sound.H.

References dsound_set_internote().

void Sound::play const note_t notes  )  [inline, static]
 

Play a list of notes (song).

Definition at line 46 of file Sound.H.

References dsound_play().

int Sound::playing  )  [inline, static]
 

Determine if a sound is currently playing.

Returns:
T/F where T means a sound is playing
See also:
dsound_finished()

Definition at line 52 of file Sound.H.

References dsound_playing().

void Sound::stop  )  [inline, static]
 

Stop a currently playing sound.

Returns:
Nothing

Definition at line 62 of file Sound.H.

References dsound_stop().


The documentation for this class was generated from the following file:
brickOS is released under the Mozilla Public License.
Original code copyright 1998-2002 by the authors.

Generated on Mon Feb 16 21:02:08 2004 for brickOS C++ by doxygen 1.3.5