Qtopia library API Documentation

Sound Class Reference

The Sound class plays WAVE sound files and can invoke the audible alarm. More...

List of all members.

Public Member Functions

 Sound (const QString &name)
 ~Sound ()
void play ()
void playLoop ()
void stop ()
bool isFinished () const

Static Public Member Functions

void soundAlarm ()


Detailed Description

The Sound class plays WAVE sound files and can invoke the audible alarm.

The Sound class is constructed with the .wav music file name. The Sound class retrieves the sound file from the shared Resource class. This class ties together QSound and the available sound resources.

To sound an audible system alarm, call the static method soundAlarm()

Definition at line 26 of file sound.h.


Constructor & Destructor Documentation

Sound::Sound const QString name  ) 
 

Opens a wave sound file name for playing Resource is used for finding the file

Definition at line 154 of file sound.cpp.

Sound::~Sound  ) 
 

Destroys the sound

Definition at line 162 of file sound.cpp.


Member Function Documentation

void Sound::play  ) 
 

Play the sound once

Definition at line 170 of file sound.cpp.

void Sound::playLoop  ) 
 

Play the sound, repeatedly until stop() is called

Definition at line 178 of file sound.cpp.

void Sound::stop  ) 
 

Do not repeat the sound after it finishes. This will end a playLoop()

Definition at line 187 of file sound.cpp.

void Sound::soundAlarm  )  [static]
 

Sounds the audible system alarm. This is used for applications such as Calendar when it needs to alarm the user of an event.

Definition at line 206 of file sound.cpp.


The documentation for this class was generated from the following files:
KDE Logo
This file is part of the documentation for OPIE Version 1.5.5.
Documentation copyright © 1997-2003 the KDE developers. 2003 OPIE developers
Generated on Tue Feb 10 20:24:25 2004 by doxygen 1.3.5 written by Dimitri van Heesch, © 1997-2001