Changeset 5956 for pjproject/trunk/pjsip/include/pjsua-lib/pjsua.h

Timestamp:

Mar 21, 2019 8:46:13 AM (6 years ago)

Author:

nanang

Message:

Misc (re #2147): Add info and checks about Extra Audio Device supporting mono channel only.

File:

• pjproject/trunk/pjsip/include/pjsua-lib/pjsua.h (modified) (2 diffs)

pjproject/trunk/pjsip/include/pjsua-lib/pjsua.h

@@ -7491 +7491 @@
  * application can install Null Sound Device (i.e: using
  * pjsua_set_null_snd_dev()), which will act as a master port, and instantiate
- * the sound device as extra sound device. But note that extra sound device
- * will not have auto-close upon idle feature.
+ * the sound device as extra sound device.
+ *
+ * Note that extra sound device will not have auto-close upon idle feature.
+ * Also note that currently extra sound device only supports mono channel.
  */
 typedef struct pjsua_ext_snd_dev pjsua_ext_snd_dev;
@@ -7500 +7502 @@
  * Create an extra sound device and register it to conference bridge.
  *
- * @param snd_param     Sound device port param.
+ * @param snd_param     Sound device port param. Currently this only supports
+ *                      mono channel, so channel count must be set to 1.
  * @param p_snd         The extra sound device instance.
  *