xref: /haiku/docs/user/support/Beep.dox (revision 837b16251d4b2b6249ebcaa19bb319cbe82c6126)
1/*
2 * Copyright 2007, Haiku, Inc. All Rights Reserved.
3 * Distributed under the terms of the MIT License.
4 *
5 * Documentation by:
6 *  Niels Sascha Reedijk <niels.reedijk@gmail.com>
7 * Corresponds to:
8 *   /trunk/headers/os/support/Beep.h  rev 19972
9 *   /trunk/src/kits/support/Beep.cpp rev 20711
10 */
11
12 /////!!!!!! Note that the workings of the beep still aren't completely clear
13 ///// and not completely implemented, so this needs revision if everything
14 ///// is finished.
15
16/*!
17  \file Beep.h
18  \brief Functions to generate sounds from the computer.
19*/
20
21/*!
22  \addtogroup support_globals
23*/
24
25//! @{
26
27/*!	\fn status_t beep()
28	\brief Invoke the standard system beep to alert users.
29
30	From Beep.h and in libbe.so.
31
32	\see system_beep() and add_system_beep_event()
33*/
34
35/*!	\fn status_t system_beep(const char* eventName)
36	\brief Invokes the sound for event \a eventName.
37
38	You can add the events using add_system_beep_event().
39
40	From Beep.h and in libbe.so.
41*/
42
43/*!	\fn status_t add_system_beep_event(const char* eventName, uint32 flags = 0)
44	\brief Adds an event to the media server.
45
46	Call this method to add a specific event to the media server.
47
48	From Beep.h and in libbe.so.
49
50	\param eventName The name of the event.
51	\param flags Currently unused. Pass \c 0.
52*/
53
54//! @}
55