2 This file is part of GNUnet
3 (C) 2013 Christian Grothoff (and other contributing authors)
5 GNUnet is free software; you can redistribute it and/or modify
6 it under the terms of the GNU General Public License as published
7 by the Free Software Foundation; either version 3, or (at your
8 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 General Public License for more details.
15 You should have received a copy of the GNU General Public License
16 along with GNUnet; see the file COPYING. If not, write to the
17 Free Software Foundation, Inc., 59 Temple Place - Suite 330,
18 Boston, MA 02111-1307, USA.
22 * @file include/gnunet_speaker_lib.h
23 * @brief API to access an audio speaker; provides access to hardware speakers
24 * @author Simon Dieterle
25 * @author Andreas Fuchs
26 * @author Christian Grothoff
28 #ifndef GNUNET_SPEAKER_SERVICE_H
29 #define GNUNET_SPEAKER_SERVICE_H
34 #if 0 /* keep Emacsens' auto-indent happy */
40 * Function that enables a speaker.
43 * @return #GNUNET_OK on success, #GNUNET_SYSERR on error
45 typedef int (*GNUNET_SPEAKER_EnableCallback)(void *cls);
48 * Function that disables a speaker.
52 typedef void (*GNUNET_SPEAKER_DisableCallback)(void *cls);
55 * Function to destroy a speaker.
59 typedef void (*GNUNET_SPEAKER_DestroyCallback)(void *cls);
62 * Function to cause a speaker to play audio data.
65 * @param data_size number of bytes in @a data
66 * @param data audio data to play, format is
67 * opaque to the API but should be OPUS.
69 typedef void (*GNUNET_SPEAKER_PlayCallback)(void *cls,
75 * A speaker is a device that can play or record audio data.
77 struct GNUNET_SPEAKER_Handle
81 * Turn on the speaker.
83 GNUNET_SPEAKER_EnableCallback enable_speaker;
88 GNUNET_SPEAKER_PlayCallback play;
91 * Turn the speaker off.
93 GNUNET_SPEAKER_DisableCallback disable_speaker;
96 * Destroy the speaker. Called by #GNUNET_SPEAKER_destroy.
98 GNUNET_SPEAKER_DestroyCallback destroy_speaker;
101 * Closure for the callbacks.
109 * Create a speaker that corresponds to the speaker hardware
112 * @param cfg configuration to use
113 * @return NULL on error
115 struct GNUNET_SPEAKER_Handle *
116 GNUNET_SPEAKER_create_from_hardware (const struct GNUNET_CONFIGURATION_Handle *cfg);
122 * @param speaker speaker to destroy
125 GNUNET_SPEAKER_destroy (struct GNUNET_SPEAKER_Handle *speaker);
128 #if 0 /* keep Emacsens' auto-indent happy */
136 /* end of gnunet_speaker_lib.h */