Sound Class Reference

Sound generation interface. More...

#include <c++/Sound.H>

Static Public Member Functions

static void play (const note_t *notes)
 Play a list of notes (song). More...
 
static int playing ()
 Determine if a sound is currently playing. More...
 
static void beep ()
 Play the system_beep sound. More...
 
static void stop ()
 Stop a currently playing sound. More...
 
static void duration (const unsigned int len)
 Set the default duration. More...
 
static void internote (const unsigned int len)
 Set the amount of time between notes. More...
 

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

static void Sound::beep ( )
inlinestatic

Play the system_beep sound.

Returns
Nothing

Definition at line 57 of file Sound.H.

References DSOUND_BEEP, and dsound_system().

static void Sound::duration ( const unsigned int  len)
inlinestatic

Set the default duration.

Parameters
lenthe 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().

static void Sound::internote ( const unsigned int  len)
inlinestatic

Set the amount of time between notes.

Parameters
lenthe 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().

static void Sound::play ( const note_t notes)
inlinestatic

Play a list of notes (song).

Definition at line 46 of file Sound.H.

References dsound_play().

static int Sound::playing ( )
inlinestatic

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

static void Sound::stop ( )
inlinestatic

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-2005 by the authors.

Generated for brickOS Kernel Developer by doxygen 1.8.9.1