Main Page | Modules | Alphabetical List | Data Structures | File List | Data Fields | Globals | Related Pages

sound.h File Reference

Sound API. More...

Go to the source code of this file.

Data Structures

struct  _GaimSoundUiOps

Sound API

void gaim_sound_set_ui_ops (GaimSoundUiOps *ops)
 Sets the UI sound operations.
GaimSoundUiOps * gaim_sound_get_ui_ops (void)
 Gets the UI sound operations.
void gaim_sound_init (void)
 Initializes the sound subsystem.
void gaim_sound_shutdown (void)
 Shuts down the sound subsystem.
void gaim_sound_play_file (const char *filename)
 Plays the specified sound file.
void gaim_sound_play_event (GaimSoundEventID event)
 Plays the sound associated with the specified event.

Typedefs

typedef enum _GaimSoundEventID GaimSoundEventID
 A type of sound.
typedef _GaimSoundUiOps GaimSoundUiOps

Enumerations

enum  _GaimSoundEventID {
  GAIM_SOUND_BUDDY_ARRIVE = 0, GAIM_SOUND_BUDDY_LEAVE, GAIM_SOUND_RECEIVE, GAIM_SOUND_FIRST_RECEIVE,
  GAIM_SOUND_SEND, GAIM_SOUND_CHAT_JOIN, GAIM_SOUND_CHAT_LEAVE, GAIM_SOUND_CHAT_YOU_SAY,
  GAIM_SOUND_CHAT_SAY, GAIM_SOUND_POUNCE_DEFAULT, GAIM_SOUND_CHAT_NICK, GAIM_NUM_SOUNDS
}
 A type of sound. More...


Detailed Description

Sound API.

gaim

Gaim 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., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA


Enumeration Type Documentation

enum _GaimSoundEventID
 

A type of sound.

Enumeration values:
GAIM_SOUND_BUDDY_ARRIVE  Buddy signs on.
GAIM_SOUND_BUDDY_LEAVE  Buddy signs off.
GAIM_SOUND_RECEIVE  Receive an IM.
GAIM_SOUND_FIRST_RECEIVE  Receive an IM that starts a conv.
GAIM_SOUND_SEND  Send an IM.
GAIM_SOUND_CHAT_JOIN  Someone joins a chat.
GAIM_SOUND_CHAT_LEAVE  Someone leaves a chat.
GAIM_SOUND_CHAT_YOU_SAY  You say something in a chat.
GAIM_SOUND_CHAT_SAY  Someone else says somthing in a chat.
GAIM_SOUND_POUNCE_DEFAULT  Default sound for a buddy pounce.
GAIM_SOUND_CHAT_NICK  Someone says your name in a chat.
GAIM_NUM_SOUNDS  Total number of sounds.


Function Documentation

GaimSoundUiOps* gaim_sound_get_ui_ops void   ) 
 

Gets the UI sound operations.

Returns:
The UI sound operations structure.

void gaim_sound_play_event GaimSoundEventID  event  ) 
 

Plays the sound associated with the specified event.

Parameters:
event The event.

void gaim_sound_play_file const char *  filename  ) 
 

Plays the specified sound file.

Parameters:
filename The file to play.

void gaim_sound_set_ui_ops GaimSoundUiOps *  ops  ) 
 

Sets the UI sound operations.

Parameters:
ops The UI sound operations structure.


Generated on Sun Jun 5 18:07:55 2005 for gaim by  doxygen 1.3.9.1