26
26
*/
27
27
28
28
/**
29
- * @defgroup audio_control AUDIO_CTL
29
+ * @defgroup group_audio_control AUDIO_CTL
30
30
*
31
31
* @brief Control audio device.
32
32
*
48
48
#define AUDIO_CTL_STOP _AUDIO_CTL(4) /**< Stop audio device */
49
49
#define AUDIO_CTL_GETBUFFERINFO _AUDIO_CTL(5) /**< Get audio device buffer information */
50
50
51
- /** @} */ /* End of audio_control */
51
+ /** @} */ /* End of group_audio_control */
52
52
53
53
/**
54
- * @defgroup audio_type AUDIO_TYPE
54
+ * @defgroup group_audio_type AUDIO_TYPE
55
55
*
56
56
* @brief Audio Device Types
57
57
*
61
61
#define AUDIO_TYPE_INPUT 0x01 /**< Set audio device type to input type */
62
62
#define AUDIO_TYPE_OUTPUT 0x02 /**< Set audio device type to output type */
63
63
#define AUDIO_TYPE_MIXER 0x04 /**< Set audio device type to mixer type */
64
- /** @} */ /* End of audio_type */
64
+ /** @} */ /* End of group_audio_type */
65
65
66
66
/**
67
- * @defgroup audio_samp_rates AUDIO_SAMP_RATES
67
+ * @defgroup group_audio_samp_rates AUDIO_SAMP_RATES
68
68
*
69
69
* @brief Supported audio sample rates for the audio device.
70
70
*
82
82
#define AUDIO_SAMP_RATE_160K 0x0200 /**< Set audio device sample rate to 160K */
83
83
#define AUDIO_SAMP_RATE_172K 0x0400 /**< Set audio device sample rate to 172K */
84
84
#define AUDIO_SAMP_RATE_192K 0x0800 /**< Set audio device sample rate to 192K */
85
- /** @} */ /* End of audio_samp_rates */
85
+ /** @} */ /* End of group_audio_samp_rates */
86
86
87
87
/**
88
- * @defgroup audio_bit_rates AUDIO_BIT_RATES
88
+ * @defgroup group_audio_bit_rates AUDIO_BIT_RATES
89
89
*
90
90
* @brief Supported bit rates for the audio device.
91
91
*
99
99
#define AUDIO_BIT_RATE_160K 0x20 /**< Set audio device bit rates to 160K */
100
100
#define AUDIO_BIT_RATE_172K 0x40 /**< Set audio device bit rates to 172K */
101
101
#define AUDIO_BIT_RATE_192K 0x80 /**< Set audio device bit rates to 192K */
102
- /** @} */ /* End of audio_bit_rates */
102
+ /** @} */ /* End of group_audio_bit_rates */
103
103
104
104
105
105
/**
106
- * @defgroup audio_dsp AUDIO_DSP
106
+ * @defgroup group_audio_dsp AUDIO_DSP
107
107
*
108
108
* @brief Support Dsp(input/output) Units controls. The macro group from application level, can
109
109
* set audio mixer parameters including samplerate, channels etc.
114
114
#define AUDIO_DSP_SAMPLERATE 1 /**< samplerate */
115
115
#define AUDIO_DSP_CHANNELS 2 /**< channels */
116
116
#define AUDIO_DSP_SAMPLEBITS 3 /**< sample bits width */
117
- /** @} */ /* End of audio_dsp */
117
+ /** @} */ /* End of group_audio_dsp */
118
118
119
119
/**
120
- * @defgroup audio_mixer AUDIO_MIXER
120
+ * @defgroup group_audio_mixer AUDIO_MIXER
121
121
*
122
122
* @brief Supported Mixer Units controls. The macro group from driver level, can set audio mixer
123
123
* parameters including volume, frequence db, microphone etc.
136
136
#define AUDIO_MIXER_MIC 0x0100 /**< Set microphone option */
137
137
#define AUDIO_MIXER_VITURAL 0x0200 /**< Set virtual audio option */
138
138
#define AUDIO_MIXER_EXTEND 0x8000 /**< Extend mixer command */
139
- /** @} */ /* End of audio_mixer */
139
+ /** @} */ /* End of group_audio_mixer */
140
140
141
141
#define AUDIO_VOLUME_MAX (100)
142
142
#define AUDIO_VOLUME_MIN (0)
@@ -213,8 +213,8 @@ struct rt_audio_configure
213
213
*/
214
214
struct rt_audio_caps
215
215
{
216
- int main_type ; /**< Audio main type, one value of @ref audio_type */
217
- int sub_type ; /**< Audio sub type, one value of @ref audio_dsp @ref audio_mixer */
216
+ int main_type ; /**< Audio main type, one value of @ref group_audio_type */
217
+ int sub_type ; /**< Audio sub type, one value of @ref group_audio_dsp or @ref group_audio_mixer */
218
218
219
219
union
220
220
{
@@ -269,7 +269,7 @@ void rt_audio_tx_complete(struct rt_audio_device *audio);
269
269
void rt_audio_rx_done (struct rt_audio_device * audio , rt_uint8_t * pbuf , rt_size_t len );
270
270
271
271
/**
272
- * @defgroup audio_codec_cmd CODEC_CMD
272
+ * @defgroup group_audio_codec_cmd CODEC_CMD
273
273
*
274
274
* @brief Device Control Commands. The macro group from hardware level, can set codec
275
275
* parametes including volume, EQ and 3D etc.
@@ -284,7 +284,7 @@ void rt_audio_rx_done(struct rt_audio_device *audio, rt_uint8_t *pbuf, rt
284
284
#define CODEC_CMD_3D 5 /**< Set 3D effect by codec */
285
285
286
286
#define CODEC_VOLUME_MAX (63)
287
- /** @} */ /* End of audio_codec_cmd */
287
+ /** @} */ /* End of group_audio_codec_cmd */
288
288
289
289
/** @} group_Audio */
290
290
0 commit comments