Mercurial > pidgin.yaz
annotate src/sound.h @ 9802:acf175d9f79b
[gaim-migrate @ 10670]
A wee bit o' cleanup. Rrrrrrr. Avast.
committer: Tailor Script <tailor@pidgin.im>
author | Mark Doliner <mark@kingant.net> |
---|---|
date | Sat, 21 Aug 2004 17:20:48 +0000 |
parents | db62420a53a2 |
children | 524a7f8efba3 |
rev | line source |
---|---|
4561 | 1 /** |
2 * @file sound.h Sound API | |
3 * | |
4 * gaim | |
5 * | |
8046 | 6 * Gaim is the legal property of its developers, whose names are too numerous |
7 * to list here. Please refer to the COPYRIGHT file distributed with this | |
8 * source distribution. | |
4561 | 9 * |
10 * This program is free software; you can redistribute it and/or modify | |
11 * it under the terms of the GNU General Public License as published by | |
12 * the Free Software Foundation; either version 2 of the License, or | |
13 * (at your option) any later version. | |
14 * | |
15 * This program is distributed in the hope that it will be useful, | |
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of | |
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
18 * GNU General Public License for more details. | |
19 * | |
20 * You should have received a copy of the GNU General Public License | |
21 * along with this program; if not, write to the Free Software | |
22 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA | |
23 */ | |
4581 | 24 #ifndef _GAIM_SOUND_H_ |
25 #define _GAIM_SOUND_H_ | |
4561 | 26 |
27 /**************************************************************************/ | |
28 /** Data Structures */ | |
29 /**************************************************************************/ | |
30 | |
31 | |
32 /** | |
5684 | 33 * A type of sound. |
4561 | 34 */ |
35 | |
36 typedef enum _GaimSoundEventID | |
37 { | |
38 GAIM_SOUND_BUDDY_ARRIVE = 0, /**< Buddy signs on. */ | |
39 GAIM_SOUND_BUDDY_LEAVE, /**< Buddy signs off. */ | |
40 GAIM_SOUND_RECEIVE, /**< Receive an IM. */ | |
41 GAIM_SOUND_FIRST_RECEIVE, /**< Receive an IM that starts a conv. */ | |
42 GAIM_SOUND_SEND, /**< Send an IM. */ | |
43 GAIM_SOUND_CHAT_JOIN, /**< Someone joins a chat. */ | |
44 GAIM_SOUND_CHAT_LEAVE, /**< Someone leaves a chat. */ | |
45 GAIM_SOUND_CHAT_YOU_SAY, /**< You say something in a chat. */ | |
46 GAIM_SOUND_CHAT_SAY, /**< Someone else says somthing in a chat. */ | |
47 GAIM_SOUND_POUNCE_DEFAULT, /**< Default sound for a buddy pounce. */ | |
48 GAIM_SOUND_CHAT_NICK, /**< Someone says your name in a chat. */ | |
49 GAIM_NUM_SOUNDS /**< Total number of sounds. */ | |
5944
158196b2db19
[gaim-migrate @ 6385]
Christian Hammond <chipx86@chipx86.com>
parents:
5684
diff
changeset
|
50 |
4561 | 51 } GaimSoundEventID; |
52 | |
5684 | 53 typedef struct _GaimSoundUiOps |
54 { | |
55 void (*init)(void); | |
56 void (*shutdown)(void); | |
57 void (*play_file)(const char *filename); | |
58 void (*play_event)(GaimSoundEventID event); | |
59 | |
60 } GaimSoundUiOps; | |
61 | |
5944
158196b2db19
[gaim-migrate @ 6385]
Christian Hammond <chipx86@chipx86.com>
parents:
5684
diff
changeset
|
62 #ifdef __cplusplus |
158196b2db19
[gaim-migrate @ 6385]
Christian Hammond <chipx86@chipx86.com>
parents:
5684
diff
changeset
|
63 extern "C" { |
158196b2db19
[gaim-migrate @ 6385]
Christian Hammond <chipx86@chipx86.com>
parents:
5684
diff
changeset
|
64 #endif |
158196b2db19
[gaim-migrate @ 6385]
Christian Hammond <chipx86@chipx86.com>
parents:
5684
diff
changeset
|
65 |
4561 | 66 /**************************************************************************/ |
67 /** @name Sound API */ | |
68 /**************************************************************************/ | |
69 /*@{*/ | |
70 | |
71 /** | |
5684 | 72 * Sets the UI sound operations |
73 * | |
74 * @param ops The UI sound operations structure. | |
4561 | 75 */ |
7035
feb3d21a7794
[gaim-migrate @ 7598]
Christian Hammond <chipx86@chipx86.com>
parents:
5944
diff
changeset
|
76 void gaim_sound_set_ui_ops(GaimSoundUiOps *ops); |
4561 | 77 |
78 /** | |
5684 | 79 * Gets the UI sound operations |
80 * | |
81 * @return The UI sound operations structure. | |
4561 | 82 */ |
7035
feb3d21a7794
[gaim-migrate @ 7598]
Christian Hammond <chipx86@chipx86.com>
parents:
5944
diff
changeset
|
83 GaimSoundUiOps *gaim_sound_get_ui_ops(void); |
5684 | 84 |
85 /** | |
86 * Initializes the sound subsystem | |
87 */ | |
88 void gaim_sound_init(void); | |
89 | |
90 /** | |
91 * Shuts down the sound subsystem | |
92 */ | |
93 void gaim_sound_shutdown(void); | |
4561 | 94 |
95 /** | |
96 * Plays the specified sound file. | |
97 * | |
98 * @param filename The file to play. | |
99 */ | |
5684 | 100 void gaim_sound_play_file(const char *filename); |
4561 | 101 |
102 /** | |
103 * Plays the sound associated with the specified event. | |
104 * | |
105 * @param event The event. | |
106 */ | |
107 void gaim_sound_play_event(GaimSoundEventID event); | |
108 | |
109 /*@}*/ | |
110 | |
5944
158196b2db19
[gaim-migrate @ 6385]
Christian Hammond <chipx86@chipx86.com>
parents:
5684
diff
changeset
|
111 #ifdef __cplusplus |
158196b2db19
[gaim-migrate @ 6385]
Christian Hammond <chipx86@chipx86.com>
parents:
5684
diff
changeset
|
112 } |
158196b2db19
[gaim-migrate @ 6385]
Christian Hammond <chipx86@chipx86.com>
parents:
5684
diff
changeset
|
113 #endif |
158196b2db19
[gaim-migrate @ 6385]
Christian Hammond <chipx86@chipx86.com>
parents:
5684
diff
changeset
|
114 |
4581 | 115 #endif /* _GAIM_SOUND_H_ */ |