view doc/sound-signals.dox @ 14870:9f088b5844e3

[gaim-migrate @ 17639] Use the PACKAGE_NAME #define rather than hardcoding 'Gaim'. This should be no change for Gaim users, but means that compiling with a name of 'libgaim' reflects the user-agent properly, and that makes me a happy penguin. committer: Tailor Script <tailor@pidgin.im>
author Evan Schoenberg <evan.s@dreskin.net>
date Tue, 31 Oct 2006 20:47:51 +0000
parents b0582839cd6c
children 8cf53d7a0887
line wrap: on
line source

/** @page sound-signals Sound Signals

 @signals
  @signal playing-sound-event
 @endsignals

 <hr>

 @signaldef playing-sound-event
  @signalproto
gboolean (*playing_sound_event)(GaimSoundEventID event, GaimAccount *account);
  @endsignalproto
  @signaldesc
   Emitted when gaim is going to play a sound event. This can be used to cancel playing sound by returning TRUE.
  @param event   The event this sound represents.
  @param account The account the sound is being played for.
  @return @c TRUE if the sound should not be played, or @c FALSE otherwise.
 @endsignaldef

 */
// vim: syntax=c tw=75 et