Mercurial > pidgin
annotate src/sound.h @ 8150:20262ccefdd8
[gaim-migrate @ 8862]
Nope, it's humor. Trust me, I know--I define it.
Oh, also, this should make oscar ssi lists take precedence over
local lists. So if you sign on while you're in Rome and delete
someone, the next time you sign in with Gaim the dude will be
deleted from your local list as well.
committer: Tailor Script <tailor@pidgin.im>
author | Mark Doliner <mark@kingant.net> |
---|---|
date | Tue, 20 Jan 2004 15:27:33 +0000 |
parents | fa6395637e2c |
children | db62420a53a2 |
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 */ | |
24 | |
4581 | 25 #ifndef _GAIM_SOUND_H_ |
26 #define _GAIM_SOUND_H_ | |
4561 | 27 |
28 /**************************************************************************/ | |
29 /** Data Structures */ | |
30 /**************************************************************************/ | |
31 | |
32 | |
33 /** | |
5684 | 34 * A type of sound. |
4561 | 35 */ |
36 | |
37 typedef enum _GaimSoundEventID | |
38 { | |
39 GAIM_SOUND_BUDDY_ARRIVE = 0, /**< Buddy signs on. */ | |
40 GAIM_SOUND_BUDDY_LEAVE, /**< Buddy signs off. */ | |
41 GAIM_SOUND_RECEIVE, /**< Receive an IM. */ | |
42 GAIM_SOUND_FIRST_RECEIVE, /**< Receive an IM that starts a conv. */ | |
43 GAIM_SOUND_SEND, /**< Send an IM. */ | |
44 GAIM_SOUND_CHAT_JOIN, /**< Someone joins a chat. */ | |
45 GAIM_SOUND_CHAT_LEAVE, /**< Someone leaves a chat. */ | |
46 GAIM_SOUND_CHAT_YOU_SAY, /**< You say something in a chat. */ | |
47 GAIM_SOUND_CHAT_SAY, /**< Someone else says somthing in a chat. */ | |
48 GAIM_SOUND_POUNCE_DEFAULT, /**< Default sound for a buddy pounce. */ | |
49 GAIM_SOUND_CHAT_NICK, /**< Someone says your name in a chat. */ | |
50 GAIM_NUM_SOUNDS /**< Total number of sounds. */ | |
5944
158196b2db19
[gaim-migrate @ 6385]
Christian Hammond <chipx86@chipx86.com>
parents:
5684
diff
changeset
|
51 |
4561 | 52 } GaimSoundEventID; |
53 | |
5684 | 54 typedef struct _GaimSoundUiOps |
55 { | |
56 void (*init)(void); | |
57 void (*shutdown)(void); | |
58 void (*play_file)(const char *filename); | |
59 void (*play_event)(GaimSoundEventID event); | |
60 | |
61 } GaimSoundUiOps; | |
62 | |
5944
158196b2db19
[gaim-migrate @ 6385]
Christian Hammond <chipx86@chipx86.com>
parents:
5684
diff
changeset
|
63 #ifdef __cplusplus |
158196b2db19
[gaim-migrate @ 6385]
Christian Hammond <chipx86@chipx86.com>
parents:
5684
diff
changeset
|
64 extern "C" { |
158196b2db19
[gaim-migrate @ 6385]
Christian Hammond <chipx86@chipx86.com>
parents:
5684
diff
changeset
|
65 #endif |
158196b2db19
[gaim-migrate @ 6385]
Christian Hammond <chipx86@chipx86.com>
parents:
5684
diff
changeset
|
66 |
4561 | 67 /**************************************************************************/ |
68 /** @name Sound API */ | |
69 /**************************************************************************/ | |
70 /*@{*/ | |
71 | |
72 /** | |
5684 | 73 * Sets the UI sound operations |
74 * | |
75 * @param ops The UI sound operations structure. | |
4561 | 76 */ |
7035
feb3d21a7794
[gaim-migrate @ 7598]
Christian Hammond <chipx86@chipx86.com>
parents:
5944
diff
changeset
|
77 void gaim_sound_set_ui_ops(GaimSoundUiOps *ops); |
4561 | 78 |
79 /** | |
5684 | 80 * Gets the UI sound operations |
81 * | |
82 * @return The UI sound operations structure. | |
4561 | 83 */ |
7035
feb3d21a7794
[gaim-migrate @ 7598]
Christian Hammond <chipx86@chipx86.com>
parents:
5944
diff
changeset
|
84 GaimSoundUiOps *gaim_sound_get_ui_ops(void); |
5684 | 85 |
86 /** | |
87 * Initializes the sound subsystem | |
88 */ | |
89 void gaim_sound_init(void); | |
90 | |
91 /** | |
92 * Shuts down the sound subsystem | |
93 */ | |
94 void gaim_sound_shutdown(void); | |
4561 | 95 |
96 /** | |
97 * Plays the specified sound file. | |
98 * | |
99 * @param filename The file to play. | |
100 */ | |
5684 | 101 void gaim_sound_play_file(const char *filename); |
4561 | 102 |
103 /** | |
104 * Plays the sound associated with the specified event. | |
105 * | |
106 * @param event The event. | |
107 */ | |
108 void gaim_sound_play_event(GaimSoundEventID event); | |
109 | |
110 /*@}*/ | |
111 | |
5944
158196b2db19
[gaim-migrate @ 6385]
Christian Hammond <chipx86@chipx86.com>
parents:
5684
diff
changeset
|
112 #ifdef __cplusplus |
158196b2db19
[gaim-migrate @ 6385]
Christian Hammond <chipx86@chipx86.com>
parents:
5684
diff
changeset
|
113 } |
158196b2db19
[gaim-migrate @ 6385]
Christian Hammond <chipx86@chipx86.com>
parents:
5684
diff
changeset
|
114 #endif |
158196b2db19
[gaim-migrate @ 6385]
Christian Hammond <chipx86@chipx86.com>
parents:
5684
diff
changeset
|
115 |
4581 | 116 #endif /* _GAIM_SOUND_H_ */ |