xref: /haiku/docs/user/support/Beep.dox (revision 1deede7388b04dbeec5af85cae7164735ea9e70d)
1/*
2 * Copyright 2007-2014 Haiku, Inc. All rights reserved.
3 * Distributed under the terms of the MIT License.
4 *
5 * Authors:
6 *		Niels Sascha Reedijk, niels.reedijk@gmail.com
7 *		John Scipione, jscipione@gmail.com
8 *
9 * Corresponds to:
10 *		headers/os/support/Beep.h	rev 19972
11 *		src/kits/support/Beep.cpp	rev 34602
12 */
13
14
15/////!!!!!! Note that the workings of the beep still aren't completely clear
16///// and not completely implemented, so this needs revision if everything
17///// is finished.
18
19
20/*!
21	\file Beep.h
22	\ingroup support
23	\ingroup libbe
24	\brief Functions to generate sounds from the computer.
25
26	\since BeOS R3
27*/
28
29
30/*!
31	\addtogroup support_globals
32*/
33
34
35//! @{
36
37
38/*!
39	\fn status_t beep()
40	\brief Invoke the standard system beep to alert users.
41
42	From Beep.h and in libbe.so.
43
44	\see system_beep() and add_system_beep_event()
45
46	\since BeOS R3
47*/
48
49
50/*!
51	\fn status_t system_beep(const char* eventName)
52	\brief Invokes the sound for event \a eventName.
53
54	You can add the events using add_system_beep_event().
55	From Beep.h and in libbe.so.
56
57	\since BeOS R5
58*/
59
60
61/*!
62	\fn status_t add_system_beep_event(const char* eventName, uint32 flags = 0)
63	\brief Adds an event to the media server.
64
65	Call this method to add a specific event to the media server.
66	From Beep.h and in libbe.so.
67
68	\param eventName The name of the event.
69	\param flags Currently unused. Pass \c 0.
70
71	\since BeOS R5
72*/
73
74
75//! @}
76