forked from enlightenment/efl
ecore_audio: Document the remaining in-/outputs
Also remove the Classes section from the Ecore_Audio_Group, we don't need it as the pages are linked automatically Signed-off-by: Daniel Willmann <d.willmann@samsung.com>
This commit is contained in:
parent
f8c7f96e05
commit
37c400eb6b
|
@ -32,12 +32,6 @@ extern "C"
|
||||||
* @defgroup Ecore_Audio_Group Ecore_Audio - Convenience audio API
|
* @defgroup Ecore_Audio_Group Ecore_Audio - Convenience audio API
|
||||||
* @ingroup Ecore
|
* @ingroup Ecore
|
||||||
|
|
||||||
@section Classes
|
|
||||||
Ecore_Audio provides the following Eo classes:
|
|
||||||
@li @ref ecore_audio_obj
|
|
||||||
@li @ref ecore_audio_obj_in
|
|
||||||
@li @ref ecore_audio_obj_out
|
|
||||||
|
|
||||||
* @since 1.8
|
* @since 1.8
|
||||||
*
|
*
|
||||||
* @{
|
* @{
|
||||||
|
|
|
@ -20,7 +20,7 @@
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @file ecore_audio_obj_in_sndfile.h
|
* @file ecore_audio_obj_in_sndfile.h
|
||||||
* @brief Audio Module
|
* @brief Ecore_Audio sndfile input
|
||||||
*/
|
*/
|
||||||
|
|
||||||
#ifdef __cplusplus
|
#ifdef __cplusplus
|
||||||
|
@ -29,12 +29,18 @@ extern "C"
|
||||||
#endif
|
#endif
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @addtogroup Ecore_Audio_Group
|
* @defgroup ecore_audio_obj_in_sndfile - Ecore_Audio sndfile input
|
||||||
|
* @ingroup Ecore_Audio_Group
|
||||||
* @{
|
* @{
|
||||||
*/
|
*/
|
||||||
|
|
||||||
#define ECORE_AUDIO_OBJ_IN_SNDFILE_CLASS ecore_audio_obj_in_sndfile_class_get()
|
#define ECORE_AUDIO_OBJ_IN_SNDFILE_CLASS ecore_audio_obj_in_sndfile_class_get() /**< Ecore_Audio sndfile input */
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @brief Get the Eo class ID
|
||||||
|
*
|
||||||
|
* @return The Eo class ID
|
||||||
|
*/
|
||||||
const Eo_Class *ecore_audio_obj_in_sndfile_class_get() EINA_CONST;
|
const Eo_Class *ecore_audio_obj_in_sndfile_class_get() EINA_CONST;
|
||||||
|
|
||||||
extern EAPI Eo_Op ECORE_AUDIO_OBJ_IN_SNDFILE_BASE_ID;
|
extern EAPI Eo_Op ECORE_AUDIO_OBJ_IN_SNDFILE_BASE_ID;
|
||||||
|
|
|
@ -20,7 +20,7 @@
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @file ecore_audio_obj_in_tone.h
|
* @file ecore_audio_obj_in_tone.h
|
||||||
* @brief Audio Module
|
* @brief Ecore_Audio tone input
|
||||||
*/
|
*/
|
||||||
|
|
||||||
#ifdef __cplusplus
|
#ifdef __cplusplus
|
||||||
|
@ -29,14 +29,25 @@ extern "C"
|
||||||
#endif
|
#endif
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @addtogroup Ecore_Audio_Group
|
* @defgroup ecore_audio_obj_in_tone - Ecore_Audio tone input
|
||||||
|
* @ingroup Ecore_Audio_Group
|
||||||
* @{
|
* @{
|
||||||
*/
|
*/
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @brief The frequency of the tone in Hz
|
||||||
|
*
|
||||||
|
* Set with @ref eo_base_data_set()
|
||||||
|
*/
|
||||||
#define ECORE_AUDIO_ATTR_TONE_FREQ "ecore_audio_freq"
|
#define ECORE_AUDIO_ATTR_TONE_FREQ "ecore_audio_freq"
|
||||||
|
|
||||||
#define ECORE_AUDIO_OBJ_IN_TONE_CLASS ecore_audio_obj_in_tone_class_get()
|
#define ECORE_AUDIO_OBJ_IN_TONE_CLASS ecore_audio_obj_in_tone_class_get() /**< Ecore_Audio tone input */
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @brief Get the Eo class ID
|
||||||
|
*
|
||||||
|
* @return The Eo class ID
|
||||||
|
*/
|
||||||
const Eo_Class *ecore_audio_obj_in_tone_class_get() EINA_CONST;
|
const Eo_Class *ecore_audio_obj_in_tone_class_get() EINA_CONST;
|
||||||
|
|
||||||
extern EAPI Eo_Op ECORE_AUDIO_OBJ_IN_TONE_BASE_ID;
|
extern EAPI Eo_Op ECORE_AUDIO_OBJ_IN_TONE_BASE_ID;
|
||||||
|
|
|
@ -20,7 +20,7 @@
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @file ecore_audio_obj_out_pulse.h
|
* @file ecore_audio_obj_out_pulse.h
|
||||||
* @brief Audio Module
|
* @brief Ecore_Audio pulseaudio output
|
||||||
*/
|
*/
|
||||||
|
|
||||||
#ifdef __cplusplus
|
#ifdef __cplusplus
|
||||||
|
@ -29,12 +29,18 @@ extern "C"
|
||||||
#endif
|
#endif
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @addtogroup Ecore_Audio_Group
|
* @defgroup ecore_audio_obj_out_pulse - Ecore_Audio pulseaudio output
|
||||||
|
* @intogroup Ecore_Audio_Group
|
||||||
* @{
|
* @{
|
||||||
*/
|
*/
|
||||||
|
|
||||||
#define ECORE_AUDIO_OBJ_OUT_PULSE_CLASS ecore_audio_obj_out_pulse_class_get()
|
#define ECORE_AUDIO_OBJ_OUT_PULSE_CLASS ecore_audio_obj_out_pulse_class_get() /**< Ecore_Audio pulseaudio output */
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @brief Get the Eo class ID
|
||||||
|
*
|
||||||
|
* @return The Eo class ID
|
||||||
|
*/
|
||||||
const Eo_Class *ecore_audio_obj_out_pulse_class_get() EINA_CONST;
|
const Eo_Class *ecore_audio_obj_out_pulse_class_get() EINA_CONST;
|
||||||
|
|
||||||
extern EAPI Eo_Op ECORE_AUDIO_OBJ_OUT_PULSE_BASE_ID;
|
extern EAPI Eo_Op ECORE_AUDIO_OBJ_OUT_PULSE_BASE_ID;
|
||||||
|
|
|
@ -20,7 +20,7 @@
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @file ecore_audio_obj_out_sndfile.h
|
* @file ecore_audio_obj_out_sndfile.h
|
||||||
* @brief Audio Module
|
* @brief Ecore_Audio sndfile output
|
||||||
*/
|
*/
|
||||||
|
|
||||||
#ifdef __cplusplus
|
#ifdef __cplusplus
|
||||||
|
@ -29,12 +29,18 @@ extern "C"
|
||||||
#endif
|
#endif
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @addtogroup Ecore_Audio_Group
|
* @defgroup ecore_audio_obj_out_sndfile - Ecore_Audio sndfile output
|
||||||
|
* @ingroup Ecore_Audio_Group
|
||||||
* @{
|
* @{
|
||||||
*/
|
*/
|
||||||
|
|
||||||
#define ECORE_AUDIO_OBJ_OUT_SNDFILE_CLASS ecore_audio_obj_out_sndfile_class_get()
|
#define ECORE_AUDIO_OBJ_OUT_SNDFILE_CLASS ecore_audio_obj_out_sndfile_class_get() /**< Ecore_Audio sndfile output */
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @brief Get the Eo class ID
|
||||||
|
*
|
||||||
|
* @return The Eo class ID
|
||||||
|
*/
|
||||||
const Eo_Class *ecore_audio_obj_out_sndfile_class_get() EINA_CONST;
|
const Eo_Class *ecore_audio_obj_out_sndfile_class_get() EINA_CONST;
|
||||||
|
|
||||||
extern EAPI Eo_Op ECORE_AUDIO_OBJ_OUT_SNDFILE_BASE_ID;
|
extern EAPI Eo_Op ECORE_AUDIO_OBJ_OUT_SNDFILE_BASE_ID;
|
||||||
|
|
Loading…
Reference in New Issue