/*
- This file is part of GNUnet
- (C) 2013 Christian Grothoff (and other contributing authors)
-
- 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.
+ This file is part of GNUnet
+ Copyright (C) 2013 GNUnet e.V.
+
+ GNUnet is free software: you can redistribute it and/or modify it
+ under the terms of the GNU Affero General Public License as published
+ by the Free Software Foundation, either version 3 of the License,
+ 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
+ Affero General Public License for more details.
+
+ You should have received a copy of the GNU Affero General Public License
+ along with this program. If not, see <http://www.gnu.org/licenses/>.
+
+ SPDX-License-Identifier: AGPL3.0-or-later
*/
/**
- * @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
#ifdef __cplusplus
extern "C"
{
-#if 0 /* keep Emacsens' auto-indent happy */
+#if 0 /* keep Emacsens' auto-indent happy */
}
#endif
#endif
* @param data audio data to play
*/
typedef void (*GNUNET_MICROPHONE_RecordedDataCallback)(void *cls,
- size_t data_size,
- const void *data);
+ size_t data_size,
+ const void *data);
/**
* Enable a microphone.
* @return #GNUNET_OK on success, #GNUNET_SYSERR on error
*/
typedef int (*GNUNET_MICROPHONE_EnableCallback)(void *cls,
- GNUNET_MICROPHONE_RecordedDataCallback rdc,
- void *rdc_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
{
-
/**
* Turn on the microphone.
*/
* Closure for the callbacks.
*/
void *cls;
-
};
* @return NULL on error
*/
struct GNUNET_MICROPHONE_Handle *
-GNUNET_MICROPHONE_create_from_hardware (const struct GNUNET_CONFIGURATION_Handle *cfg);
+GNUNET_MICROPHONE_create_from_hardware (const struct
+ GNUNET_CONFIGURATION_Handle *cfg);
/**
GNUNET_MICROPHONE_destroy (struct GNUNET_MICROPHONE_Handle *microphone);
-#if 0 /* keep Emacsens' auto-indent happy */
+#if 0 /* keep Emacsens' auto-indent happy */
{
#endif
#ifdef __cplusplus
#endif
#endif
+
+/** @} */ /* end of group */
+
/* end of gnunet_microphone_lib.h */