blob: e9af24dc87d3609854ce08fbd40d9f8339cb544c (
plain)
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
|
/* finch
*
* Finch 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
*/
/**
* SECTION:gntsound
* @section_id: finch-gntsound
* @short_description: <filename>gntsound.h</filename>
* @title: Sound API
*/
#ifndef _GNT_SOUND_H
#define _GNT_SOUND_H
#include "sound.h"
/**********************************************************************/
/** @name GNT Sound API */
/**********************************************************************/
/*@{*/
/**
* finch_sound_get_active_profile:
*
* Get the name of the active sound profile.
*
* Returns: The name of the profile
*/
const char *finch_sound_get_active_profile(void);
/**
* finch_sound_set_active_profile:
* @name: The name of the profile
*
* Set the active profile. If the profile doesn't exist, nothing is changed.
*/
void finch_sound_set_active_profile(const char *name);
/**
* finch_sound_get_profiles:
*
* Get a list of available sound profiles.
*
* Returns: A list of strings denoting sound profile names.
* Caller must free the list (but not the data).
*/
GList *finch_sound_get_profiles(void);
/**
* finch_sound_is_enabled:
*
* Determine whether any sound will be played or not.
*
* Returns: Returns FALSE if preference is set to 'No sound', or if volume is
* set to zero.
*/
gboolean finch_sound_is_enabled(void);
/**
* finch_sound_get_ui_ops:
*
* Gets GNT sound UI ops.
*
* Returns: The UI operations structure.
*/
PurpleSoundUiOps *finch_sound_get_ui_ops(void);
/**
* finch_sounds_show_all:
*
* Show the sound settings dialog.
*/
void finch_sounds_show_all(void);
/*@}*/
#endif
|
