sound.h File Reference

Sound API. More...

#include "account.h"

Include dependency graph for sound.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures

struct  _PurpleSoundUiOps

Typedefs

typedef enum _PurpleSoundEventID PurpleSoundEventID
 A type of sound.
typedef _PurpleSoundUiOps PurpleSoundUiOps

Enumerations

enum  _PurpleSoundEventID {
  PURPLE_SOUND_BUDDY_ARRIVE = 0, PURPLE_SOUND_BUDDY_LEAVE, PURPLE_SOUND_RECEIVE, PURPLE_SOUND_FIRST_RECEIVE,
  PURPLE_SOUND_SEND, PURPLE_SOUND_CHAT_JOIN, PURPLE_SOUND_CHAT_LEAVE, PURPLE_SOUND_CHAT_YOU_SAY,
  PURPLE_SOUND_CHAT_SAY, PURPLE_SOUND_POUNCE_DEFAULT, PURPLE_SOUND_CHAT_NICK, PURPLE_NUM_SOUNDS
}
 A type of sound. More...

Functions

Sound API
PurpleSoundUiOpspurple_sound_get_ui_ops (void)
 Gets the UI sound operations.
void purple_sound_init (void)
 Initializes the sound subsystem.
void purple_sound_play_event (PurpleSoundEventID event, const PurpleAccount *account)
 Plays the sound associated with the specified event.
void purple_sound_play_file (const char *filename, const PurpleAccount *account)
 Plays the specified sound file.
void purple_sound_set_ui_ops (PurpleSoundUiOps *ops)
 Sets the UI sound operations.
void purple_sound_uninit (void)
 Shuts down the sound subsystem.
void * purple_sounds_get_handle (void)
 Returns the sound subsystem handle.


Detailed Description

Sound API.

purple

Purple 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

Definition in file sound.h.


Enumeration Type Documentation

enum _PurpleSoundEventID

A type of sound.

Enumerator:
PURPLE_SOUND_BUDDY_ARRIVE  Buddy signs on.

PURPLE_SOUND_BUDDY_LEAVE  Buddy signs off.

PURPLE_SOUND_RECEIVE  Receive an IM.

PURPLE_SOUND_FIRST_RECEIVE  Receive an IM that starts a conv.

PURPLE_SOUND_SEND  Send an IM.

PURPLE_SOUND_CHAT_JOIN  Someone joins a chat.

PURPLE_SOUND_CHAT_LEAVE  Someone leaves a chat.

PURPLE_SOUND_CHAT_YOU_SAY  You say something in a chat.

PURPLE_SOUND_CHAT_SAY  Someone else says somthing in a chat.

PURPLE_SOUND_POUNCE_DEFAULT  Default sound for a buddy pounce.

PURPLE_SOUND_CHAT_NICK  Someone says your name in a chat.

PURPLE_NUM_SOUNDS  Total number of sounds.

Definition at line 39 of file sound.h.


Function Documentation

PurpleSoundUiOps* purple_sound_get_ui_ops ( void   ) 

Gets the UI sound operations.

Returns:
The UI sound operations structure.

void purple_sound_play_event ( PurpleSoundEventID  event,
const PurpleAccount account 
)

Plays the sound associated with the specified event.

Parameters:
event The event.
account The account that this sound is associated with, or NULL if the sound is not associated with any specific account. This is needed for the "sounds while away?" preference to work correctly.

void purple_sound_play_file ( const char *  filename,
const PurpleAccount account 
)

Plays the specified sound file.

Parameters:
filename The file to play.
account The account that this sound is associated with, or NULL if the sound is not associated with any specific account. This is needed for the "sounds while away?" preference to work correctly.

void purple_sound_set_ui_ops ( PurpleSoundUiOps ops  ) 

Sets the UI sound operations.

Parameters:
ops The UI sound operations structure.

void* purple_sounds_get_handle ( void   ) 

Returns the sound subsystem handle.

Returns:
The sound subsystem handle.