finch/gntsound.h

branch
soc.2013.gobjectification.plugins
changeset 37023
d9bcdc9a91e6
parent 37017
8e2b68c79fa1
child 37034
9d6765962b22
equal deleted inserted replaced
37022:d891503c8aa6 37023:d9bcdc9a91e6
34 /*@{*/ 34 /*@{*/
35 35
36 /** 36 /**
37 * Get the name of the active sound profile. 37 * Get the name of the active sound profile.
38 * 38 *
39 * Returns: The name of the profile 39 * @return The name of the profile
40 */ 40 */
41 const char *finch_sound_get_active_profile(void); 41 const char *finch_sound_get_active_profile(void);
42 42
43 /** 43 /**
44 * Set the active profile. If the profile doesn't exist, nothing is changed. 44 * Set the active profile. If the profile doesn't exist, nothing is changed.
45 * 45 *
46 * @name: The name of the profile 46 * @param name The name of the profile
47 */ 47 */
48 void finch_sound_set_active_profile(const char *name); 48 void finch_sound_set_active_profile(const char *name);
49 49
50 /** 50 /**
51 * Get a list of available sound profiles. 51 * Get a list of available sound profiles.
52 * 52 *
53 * Returns: A list of strings denoting sound profile names. 53 * @return A list of strings denoting sound profile names.
54 * Caller must free the list (but not the data). 54 * Caller must free the list (but not the data).
55 */ 55 */
56 GList *finch_sound_get_profiles(void); 56 GList *finch_sound_get_profiles(void);
57 57
58 /** 58 /**
59 * Determine whether any sound will be played or not. 59 * Determine whether any sound will be played or not.
60 * 60 *
61 * Returns: Returns FALSE if preference is set to 'No sound', or if volume is 61 * @return Returns FALSE if preference is set to 'No sound', or if volume is
62 * set to zero. 62 * set to zero.
63 */ 63 */
64 gboolean finch_sound_is_enabled(void); 64 gboolean finch_sound_is_enabled(void);
65 65
66 /** 66 /**
67 * Gets GNT sound UI ops. 67 * Gets GNT sound UI ops.
68 * 68 *
69 * Returns: The UI operations structure. 69 * @return The UI operations structure.
70 */ 70 */
71 PurpleSoundUiOps *finch_sound_get_ui_ops(void); 71 PurpleSoundUiOps *finch_sound_get_ui_ops(void);
72 72
73 /** 73 /**
74 * Show the sound settings dialog. 74 * Show the sound settings dialog.

mercurial