1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
|
/**
* @file sound.h Sound API
* @ingroup core
* @see @ref sound-signals
*/
/* purple
*
* Purple is the legal property of its developers, whose names are too numerous
* to list here. Please refer to the COPYRIGHT file distributed with this
* source distribution.
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02111-1301 USA
*/
#ifndef _PURPLE_SOUND_H_
#define _PURPLE_SOUND_H_
#include "account.h"
/**************************************************************************/
/** Data Structures */
/**************************************************************************/
/**
* A type of sound.
*/
typedef enum _PurpleSoundEventID
{
PURPLE_SOUND_BUDDY_ARRIVE = 0, /**< Buddy signs on. */
PURPLE_SOUND_BUDDY_LEAVE, /**< Buddy signs off. */
PURPLE_SOUND_RECEIVE, /**< Receive an IM. */
PURPLE_SOUND_FIRST_RECEIVE, /**< Receive an IM that starts a conv. */
PURPLE_SOUND_SEND, /**< Send an IM. */
PURPLE_SOUND_CHAT_JOIN, /**< Someone joins a chat. */
PURPLE_SOUND_CHAT_LEAVE, /**< Someone leaves a chat. */
PURPLE_SOUND_CHAT_YOU_SAY, /**< You say something in a chat. */
PURPLE_SOUND_CHAT_SAY, /**< Someone else says somthing in a chat. */
PURPLE_SOUND_POUNCE_DEFAULT, /**< Default sound for a buddy pounce. */
PURPLE_SOUND_CHAT_NICK, /**< Someone says your name in a chat. */
PURPLE_SOUND_GOT_ATTENTION, /**< Got an attention */
PURPLE_NUM_SOUNDS /**< Total number of sounds. */
} PurpleSoundEventID;
/** Operations used by the core to request that particular sound files, or the
* sound associated with a particular event, should be played.
*/
typedef struct _PurpleSoundUiOps
{
void (*init)(void);
void (*uninit)(void);
void (*play_file)(const char *filename);
void (*play_event)(PurpleSoundEventID event);
void (*_purple_reserved1)(void);
void (*_purple_reserved2)(void);
void (*_purple_reserved3)(void);
void (*_purple_reserved4)(void);
} PurpleSoundUiOps;
#ifdef __cplusplus
extern "C" {
#endif
/**************************************************************************/
/** @name Sound API */
/**************************************************************************/
/*@{*/
/**
* Plays the specified sound file.
*
* @param filename The file to play.
* @param account The account that this sound is associated with, or
* NULL if the sound is not associated with any specific
* account. This is needed for the "sounds while away?"
* preference to work correctly.
*/
void purple_sound_play_file(const char *filename, const PurpleAccount *account);
/**
* Plays the sound associated with the specified event.
*
* @param event The event.
* @param account The account that this sound is associated with, or
* NULL if the sound is not associated with any specific
* account. This is needed for the "sounds while away?"
* preference to work correctly.
*/
void purple_sound_play_event(PurpleSoundEventID event, const PurpleAccount *account);
/**
* Sets the UI sound operations
*
* @param ops The UI sound operations structure.
*/
void purple_sound_set_ui_ops(PurpleSoundUiOps *ops);
/**
* Gets the UI sound operations
*
* @return The UI sound operations structure.
*/
PurpleSoundUiOps *purple_sound_get_ui_ops(void);
/**
* Initializes the sound subsystem
*/
void purple_sound_init(void);
/**
* Shuts down the sound subsystem
*/
void purple_sound_uninit(void);
/**
* Returns the sound subsystem handle.
*
* @return The sound subsystem handle.
*/
void *purple_sounds_get_handle(void);
/*@}*/
#ifdef __cplusplus
}
#endif
#endif /* _PURPLE_SOUND_H_ */
|
