Changeset 6094 for pjproject/trunk/pjmedia/include/pjmedia/audiodev.h

Timestamp:

Oct 17, 2019 7:02:50 AM (5 years ago)

Author:

ming

Message:

Fixed #1778: Support for Voice Processing IO Audio Unit on Mac

File:

• pjproject/trunk/pjmedia/include/pjmedia/audiodev.h (modified) (1 diff)

pjproject/trunk/pjmedia/include/pjmedia/audiodev.h

@@ -38 +38 @@
  * @defgroup s2_audio_device_reference Audio Device API Reference
  * @ingroup audio_device_api
- * @brief API Reference
+ * @brief Documentation and API Reference
  * @{
+ *
+ * @section ec_sec Hardware/Built-in Echo Cancellation
+ *
+ * On some platforms, audio device comes with built-in echo cancellation
+ * feature. This is usually done based on specific hardware configuration,
+ * such as the use of multiple microphones and/or a known fixed distance
+ * between the capture and playback device, in order to precalculate the
+ * echo time distance. Because of this, when using the hardware EC,
+ * users may not get the freedom to select their own audio devices.
+ * This is applicable for Mac (users must use default audio devices) and
+ * iOS (users must use the same built-in audio device).
+ *
+ * In PJMEDIA, applications wishing to use sofware echo instead can pass
+ * PJMEDIA_ECHO_USE_SW_ECHO when calling pjmedia_snd_port_create2().
  */