Mercurial > pidgin

view doc/sound-signals.dox @ 32766:fd1b4bbefc6b

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Port to Farstream Farstream is the new name of Farsight. The changes to support Farstream are from ocrete. rlaager modified the patch to retain the Farsight code using #ifdef HAVE_FARSIGHT. committer: Richard Laager <rlaager@wiktel.com>
author olivier.crete@collabora.com
date Thu, 05 Apr 2012 03:18:40 +0000
parents e0613cf8c493
children
line wrap: on
line source

/** @page sound-signals Sound Signals

 @signals
  @signal playing-sound-event
 @endsignals

 @see sound.h

 <hr>

 @signaldef playing-sound-event
  @signalproto
gboolean (*playing_sound_event)(PurpleSoundEventID event, PurpleAccount *account);
  @endsignalproto
  @signaldesc
   Emitted when libpurple 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.doxygen tw=75 et