@@ -314,7 +314,8 @@ esp_err_t uac_host_handle_events(TickType_t timeout);
314314 * @brief Start a UAC stream with specific stream configuration (channels, bit resolution, sample frequency)
315315 *
316316 * @note set flags FLAG_STREAM_PAUSE_AFTER_START to pause stream after start
317- *
317+ * @note The function can block
318+ * @note The function sends a control transfer to the device
318319 * @param[in] uac_dev_handle UAC device handle
319320 * @param[in] stream_config Pointer to UAC stream configuration structure
320321 * @return esp_err_t
@@ -330,6 +331,8 @@ esp_err_t uac_host_device_start(uac_host_device_handle_t uac_dev_handle, const u
330331/**
331332 * @brief Pause a UAC stream
332333 *
334+ * @note The function can block
335+ * @note The function sends a control transfer to the device
333336 * @param[in] uac_dev_handle UAC device handle
334337 * @return esp_err_t
335338 * - ESP_OK on success
@@ -341,6 +344,8 @@ esp_err_t uac_host_device_pause(uac_host_device_handle_t uac_dev_handle);
341344/**
342345 * @brief Unpause a UAC stream with same stream configuration
343346 *
347+ * @note The function can block
348+ * @note The function sends a control transfer to the device
344349 * @param[in] uac_dev_handle UAC device handle
345350 * @return esp_err_t
346351 * - ESP_OK on success
@@ -352,6 +357,8 @@ esp_err_t uac_host_device_unpause(uac_host_device_handle_t uac_dev_handle);
352357/**
353358 * @brief Stop a UAC stream, stream resources will be released
354359 *
360+ * @note The function can block
361+ * @note The function sends a control transfer to the device
355362 * @param[in] uac_dev_handle UAC device handle
356363 * @return esp_err_t
357364 * - ESP_OK on success
@@ -363,6 +370,7 @@ esp_err_t uac_host_device_stop(uac_host_device_handle_t uac_dev_handle);
363370/**
364371 * @brief Read data from UAC stream buffer, only available after stream started
365372 *
373+ * @note The function can block
366374 * @param[in] uac_dev_handle UAC device handle
367375 * @param[out] data Pointer to the buffer to store the data
368376 * @param[in] size Number of bytes to read
@@ -381,7 +389,8 @@ esp_err_t uac_host_device_read(uac_host_device_handle_t uac_dev_handle, uint8_t
381389 *
382390 * @note The data will be sent to internal ringbuffer before function return,
383391 * the actual data transfer is scheduled by the background task.
384- *
392+ * @note The function can block
393+ * @note The function sends a transfer to the device
385394 * @param[in] uac_dev_handle UAC device handle
386395 * @param[in] data Pointer to the data buffer
387396 * @param[in] size Number of bytes to write
0 commit comments