/*
 * Pidgin - Internet Messenger
 * Copyright (C) Pidgin Developers <devel@pidgin.im>
 *
 * Pidgin 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, see <https://www.gnu.org/licenses/>.
 */

#if !defined(PIDGIN_GLOBAL_HEADER_INSIDE) && !defined(PIDGIN_COMPILATION)
# error "only <pidgin.h> may be included directly"
#endif

#ifndef PIDGIN_SOUND_MANAGER_H
#define PIDGIN_SOUND_MANAGER_H

#include <gtk/gtk.h>

#include <purple.h>

#include "pidginversion.h"

G_BEGIN_DECLS

/**
 * PidginSoundManager:
 *
 * A manager for event sounds.
 *
 * This will connect to all of the signals in libpurple and play sounds if the
 * user has enabled them.
 *
 * Since: 3.0
 */

#define PIDGIN_TYPE_SOUND_MANAGER (pidgin_sound_manager_get_type())

PIDGIN_AVAILABLE_IN_3_0
G_DECLARE_FINAL_TYPE(PidginSoundManager, pidgin_sound_manager, PIDGIN,
                     SOUND_MANAGER, GObject)

/**
 * pidgin_sound_manager_get_new_message_enabled:
 *
 * Gets whether or not a sound should be played when a new message arrives.
 *
 * Returns: true if a sound should be played when a new message arrives.
 *
 * Since: 3.0
 */
PIDGIN_AVAILABLE_IN_3_0
gboolean pidgin_sound_manager_get_new_message_enabled(PidginSoundManager *manager);

/**
 * pidgin_sound_manager_get_new_message_stream:
 *
 * Gets the stream that will be used for new message events.
 *
 * Returns: (transfer none): The stream for new message events.
 *
 * Since: 3.0
 */
PIDGIN_AVAILABLE_IN_3_0
GtkMediaStream *pidgin_sound_manager_get_new_message_stream(PidginSoundManager *manager);

/**
 * pidgin_sound_manager_get_sounds_enabled:
 *
 * Gets whether or not event sounds are enabled.
 *
 * Returns: true if event sounds are enabled.
 *
 * Since: 3.0
 */
PIDGIN_AVAILABLE_IN_3_0
gboolean pidgin_sound_manager_get_sounds_enabled(PidginSoundManager *manager);

/**
 * pidgin_sound_manager_new:
 * @core: the libpurple core instance
 *
 * Creates a sound manager.
 *
 * Returns: (transfer full): The new instance.
 *
 * Since: 3.0
 */
PIDGIN_AVAILABLE_IN_3_0
PidginSoundManager *pidgin_sound_manager_new(PurpleCore *core);

/**
 * pidgin_sound_manager_set_new_message_enabled:
 * @new_message_enabled: the new value
 *
 * Sets whether or not a sound should be played when a new message arrives.
 *
 * Since: 3.0
 */
PIDGIN_AVAILABLE_IN_3_0
void pidgin_sound_manager_set_new_message_enabled(PidginSoundManager *manager, gboolean new_message_enabled);

/**
 * pidgin_sound_manager_set_new_message_stream:
 * @stream: (nullable): the new stream
 *
 * Sets the stream for the new message sound.
 *
 * If @stream is null, then the default sound will be used.
 *
 * Since: 3.0
 */
PIDGIN_AVAILABLE_IN_3_0
void pidgin_sound_manager_set_new_message_stream(PidginSoundManager *manager, GtkMediaStream *stream);

/**
 * pidgin_sound_manager_set_sounds_enabled:
 * @sounds_enabled: the new value
 *
 * Sets whether or not event sounds are enabled.
 *
 * Since: 3.0
 */
PIDGIN_AVAILABLE_IN_3_0
void pidgin_sound_manager_set_sounds_enabled(PidginSoundManager *manager, gboolean sounds_enabled);

G_END_DECLS

#endif /* PIDGIN_SOUND_MANAGER_H */
