Changeset 2470 for pjproject/branches/projects/aps-direct/pjmedia/include/pjmedia-audiodev/audiodev.h

Timestamp:

Feb 22, 2009 5:15:34 PM (15 years ago)

Author:

bennylp

Message:

• Added pjmedia-audiodev/config.h
• Added a bit of doxygen documentation
• Added support for PCMA/PCMU codecs in wmme_dev.c

File:

• pjproject/branches/projects/aps-direct/pjmedia/include/pjmedia-audiodev/audiodev.h (modified) (6 diffs)

pjproject/branches/projects/aps-direct/pjmedia/include/pjmedia-audiodev/audiodev.h

@@ -25 +25 @@
  * @brief Audio device API.
  */
+#include <pjmedia-audiodev/config.h>
 #include <pjmedia/port.h>
 #include <pj/pool.h>
@@ -32 +33 @@
 
 /**
- * @defgroup PJMED_AUD_DEV Audio device API
- * @ingroup PJMED_AUD_PORT
- * @brief API to work with audio devices and to implement new audio device backends.
- * @{
- *
- * The audio device API contains two parts:
- *  - the base API, for both applications and audio device implementors, and
- *  - the API for audio device implementors, for extending the audio device
- *    framework with new audio device drivers.
- *
- * @}
- */
-
-/**
- * @defgroup PJMED_AUD_DEV_API Base Audio Device API
- * @ingroup PJMED_AUD_DEV
- * @brief The base API, for both applications and audio device implementors
+ * @defgroup s2_audio_device_reference Audio Device API Reference
+ * @ingroup audio_device_api
+ * @brief API Reference
  * @{
  */
@@ -222 +209 @@
 
 /**
- * Device information structure returned by #pjmedia_aud_get_dev_info.
+ * Device information structure returned by #pjmedia_aud_dev_get_info().
  */
 typedef struct pjmedia_aud_dev_info
@@ -498 +485 @@
  * @param drv_name      The driver name.
  * @param dev_name      The device name.
+ * @param id            Pointer to store the returned device ID.
  *
  * @return              PJ_SUCCESS if the device can be found.
@@ -530 +518 @@
  * @param user_data     Arbitrary user data, which will be given back in the
  *                      callbacks.
- * @param p_aud_strm    Pointer to receive the audio stream.
+ * @param p_strm        Pointer to receive the audio stream.
  *
  * @return              PJ_SUCCESS on successful operation or the appropriate
@@ -635 +623 @@
 #define PJMEDIA_EAUD_SYSERR     -1
 
-
-/**
- * @)
+/* Bad or invalid format */
+#define PJMEDIA_EAUD_BADFORMAT  -1
+
+/**
+ * @}
  */