/*
This file is part of GNUnet
- (C) 2013 Christian Grothoff (and other contributing authors)
-
+ Copyright (C) 2013 GNUnet e.V.
+
GNUnet 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 3, or (at your
option) any later version.
-
+
GNUnet 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 GNUnet; see the file COPYING. If not, write to the
- Free Software Foundation, Inc., 59 Temple Place - Suite 330,
- Boston, MA 02111-1307, USA.
+ Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
+ Boston, MA 02110-1301, USA.
*/
/**
- * @file include/gnunet_microphone_lib.h
- * @brief API to access an audio microphone; provides access to hardware microphones
* @author Simon Dieterle
* @author Andreas Fuchs
* @author Christian Grothoff
+ *
+ * @file
+ * API to access an audio microphone; provides access to hardware microphones
+ *
+ * @defgroup microphone Microphone library
+ * Provides access to hardware microphones.
+ * @{
*/
#ifndef GNUNET_MICROPHONE_SERVICE_H
#define GNUNET_MICROPHONE_SERVICE_H
#endif
#endif
+#include "gnunet_util_lib.h"
+
/**
* Process recorded audio data.
*
* @param cls clsoure
* @param rdc function to call with recorded data
* @param rdc_cls closure for @a dc
+ * @return #GNUNET_OK on success, #GNUNET_SYSERR on error
*/
-typedef void (*GNUNET_MICROPHONE_EnableCallback)(void *cls,
- GNUNET_MICROPHONE_RecordedDataCallback rdc,
- void *rdc_cls);
+typedef int (*GNUNET_MICROPHONE_EnableCallback)(void *cls,
+ GNUNET_MICROPHONE_RecordedDataCallback rdc,
+ void *rdc_cls);
/**
* Function that disables a microphone.
/**
- * A microphone is a device that can play or record audio data.
+ * A microphone is a device that can capture or otherwise produce audio data.
*/
struct GNUNET_MICROPHONE_Handle
{
#endif
#endif
+
+/** @} */ /* end of group */
+
/* end of gnunet_microphone_lib.h */