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