libgaminggear
|
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 struct _GaminggearAudioNotification GaminggearAudioNotification |
typedef struct _GaminggearAudioNotificator GaminggearAudioNotificator |
gboolean gaminggear_audio_notification_cancel | ( | GaminggearAudioNotification * | notification | ) |
Cancel a running notification.
notification | Notification to be cancelled. |
bool | TRUE on success, else FALSE . |
void gaminggear_audio_notification_free | ( | GaminggearAudioNotification * | notification | ) |
Frees an existing notification.
notification | The notification to be freed. |
GaminggearAudioNotification* gaminggear_audio_notification_new | ( | GaminggearAudioNotificator * | notificator | ) |
Create new notification.
notificator | A notificator. |
notification | A new notification to be freed with gaminggear_audio_notification_free() . |
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.
notification | The notification that plays the sound. |
filename | The full path of the file to play. |
volume | The playback volume in dB. |
bool | TRUE on success, else FALSE . |
void gaminggear_audio_notificator_deinit | ( | GaminggearAudioNotificator * | notificator | ) |
Frees an existing notificator.
notificator | The notificator to be freed. |
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.
app_name | The name of the binary. |
version_string | Version of the binary. |
sound_driver | "alsa" or "pulse". |
notificator | A new notificator object to be freed with gaminggear_audio_notificator_deinit() or NULL on error. |