audio_notificator.h File Reference

Typedefs
typedef struct _GaminggearAudioNotificator	GaminggearAudioNotificator
typedef struct _GaminggearAudioNotification	GaminggearAudioNotification

Functions
GaminggearAudioNotificator *	gaminggear_audio_notificator_init (gchar const *app_name, gchar const *version_string, gchar const *sound_driver)
	Initializes an audio notificator. More...
void	gaminggear_audio_notificator_deinit (GaminggearAudioNotificator *notificator)
	Frees an existing notificator. More...
GaminggearAudioNotification *	gaminggear_audio_notification_new (GaminggearAudioNotificator *notificator)
	Create new notification. More...
void	gaminggear_audio_notification_free (GaminggearAudioNotification *notification)
	Frees an existing notification. More...
gboolean	gaminggear_audio_notification_update (GaminggearAudioNotification *notification, gchar const *filename, gdouble volume)
	Play a sound file as notification. More...
gboolean	gaminggear_audio_notification_cancel (GaminggearAudioNotification *notification)
	Cancel a running notification. More...

Typedef Documentation

GaminggearAudioNotification

typedef struct _GaminggearAudioNotification GaminggearAudioNotification

GaminggearAudioNotificator

typedef struct _GaminggearAudioNotificator GaminggearAudioNotificator

Function Documentation

gaminggear_audio_notification_cancel()

gboolean gaminggear_audio_notification_cancel

(

GaminggearAudioNotification *

notification

)

Cancel a running notification.

Parameters

notification

Notification to be cancelled.

Return values

bool	TRUE on success, else FALSE.

Since

1.0

gaminggear_audio_notification_free()

void gaminggear_audio_notification_free

(

GaminggearAudioNotification *

notification

)

Frees an existing notification.

Parameters

notification

The notification to be freed.

Since

1.0

gaminggear_audio_notification_new()

GaminggearAudioNotification* gaminggear_audio_notification_new

(

GaminggearAudioNotificator *

notificator

)

Create new notification.

Parameters

notificator

A notificator.

Return values

notification

A new notification to be freed with gaminggear_audio_notification_free().

Since

1.0

gaminggear_audio_notification_update()

gboolean gaminggear_audio_notification_update	(	GaminggearAudioNotification *	notification,
		gchar const *	filename,
		gdouble	volume
	)

Play a sound file as notification.

A already running playback is cancelled before the new file is played.

Parameters

notification	The notification that plays the sound.
filename	The full path of the file to play.
volume	The playback volume in dB.

Return values

bool	TRUE on success, else FALSE.

Since

1.0

gaminggear_audio_notificator_deinit()

void gaminggear_audio_notificator_deinit

(

GaminggearAudioNotificator *

notificator

)

Frees an existing notificator.

Parameters

notificator

The notificator to be freed.

Since

1.0

gaminggear_audio_notificator_init()

GaminggearAudioNotificator* gaminggear_audio_notificator_init	(	gchar const *	app_name,
		gchar const *	version_string,
		gchar const *	sound_driver
	)

Initializes an audio notificator.

The nomenclature init/deinit means there is only one instance of this object supported by an application.

Parameters

app_name	The name of the binary.
version_string	Version of the binary.
sound_driver	"alsa" or "pulse".

Return values

notificator

A new notificator object to be freed with gaminggear_audio_notificator_deinit() or NULL on error.

Since

1.0