2 This file is part of GNUnet
3 Copyright (C) 2013 GNUnet e.V.
5 GNUnet is free software: you can redistribute it and/or modify it
6 under the terms of the GNU Affero General Public License as published
7 by the Free Software Foundation, either version 3 of the License,
8 or (at your option) any later version.
10 GNUnet is distributed in the hope that it will be useful, but
11 WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 Affero General Public License for more details.
15 You should have received a copy of the GNU Affero General Public License
16 along with this program. If not, see <http://www.gnu.org/licenses/>.
18 SPDX-License-Identifier: AGPL3.0-or-later
22 * @author Simon Dieterle
23 * @author Andreas Fuchs
24 * @author Christian Grothoff
27 * API to access an audio speaker; provides access to hardware speakers
29 * @defgroup speaker Speaker service
30 * Access hardware audio speakers.
33 #ifndef GNUNET_SPEAKER_SERVICE_H
34 #define GNUNET_SPEAKER_SERVICE_H
39 #if 0 /* keep Emacsens' auto-indent happy */
44 #include "gnunet_util_lib.h"
47 * Function that enables a speaker.
50 * @return #GNUNET_OK on success, #GNUNET_SYSERR on error
52 typedef int (*GNUNET_SPEAKER_EnableCallback)(void *cls);
55 * Function that disables a speaker.
59 typedef void (*GNUNET_SPEAKER_DisableCallback)(void *cls);
62 * Function to destroy a speaker.
66 typedef void (*GNUNET_SPEAKER_DestroyCallback)(void *cls);
69 * Function to cause a speaker to play audio data.
72 * @param data_size number of bytes in @a data
73 * @param data audio data to play, format is
74 * opaque to the API but should be OPUS.
76 typedef void (*GNUNET_SPEAKER_PlayCallback)(void *cls,
82 * A speaker is a device that can play or record audio data.
84 struct GNUNET_SPEAKER_Handle
88 * Turn on the speaker.
90 GNUNET_SPEAKER_EnableCallback enable_speaker;
95 GNUNET_SPEAKER_PlayCallback play;
98 * Turn the speaker off.
100 GNUNET_SPEAKER_DisableCallback disable_speaker;
103 * Destroy the speaker. Called by #GNUNET_SPEAKER_destroy.
105 GNUNET_SPEAKER_DestroyCallback destroy_speaker;
108 * Closure for the callbacks.
116 * Create a speaker that corresponds to the speaker hardware
119 * @param cfg configuration to use
120 * @return NULL on error
122 struct GNUNET_SPEAKER_Handle *
123 GNUNET_SPEAKER_create_from_hardware (const struct GNUNET_CONFIGURATION_Handle *cfg);
129 * @param speaker speaker to destroy
132 GNUNET_SPEAKER_destroy (struct GNUNET_SPEAKER_Handle *speaker);
135 #if 0 /* keep Emacsens' auto-indent happy */
144 /** @} */ /* end of group */
146 /* end of gnunet_speaker_lib.h */