Sound Class Reference

Sound generation interface. More...

#include <c++/Sound.H>

List of all members.

Static Public Member Functions
static void	play (const note_t *notes)
	Play a list of notes (song).
static int	playing ()
	Determine if a sound is currently playing.
static void	beep ()
	Play the system_beep sound.
static void	stop ()
	Stop a currently playing sound.
static void	duration (const unsigned int len)
	Set the default duration.
static 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

static void Sound::play

(

const note_t *

notes

)

[inline, static]

Play a list of notes (song).

• to poll for playing complete try Sound::playing()
• to wait for playing complete try dsound_finished()

  Parameters:

  notes

  pointer to an array of note_t elements

  Returns:

  Nothing

Definition at line 46 of file Sound.H.

References dsound_play().

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

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

static void Sound::stop

(

)

[inline, static]

Stop a currently playing sound.

Returns:

Nothing

Definition at line 62 of file Sound.H.

References dsound_stop().

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

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

---

The documentation for this class was generated from the following file:

• include/c++/Sound.H

---

brickOS is released under the Mozilla Public License. Original code copyright 1998-2005 by the authors.

---

Generated on Fri Jan 25 08:13:52 2008 for brickOS Kernel Developer by 1.5.4