Changeset 2007 for pjproject/trunk/pjmedia/include/pjmedia/sound.h

Timestamp:

Jun 12, 2008 12:48:59 PM (16 years ago)

Author:

nanang

Message:

Ticket #542: added new API and macro for sound device latency settings, also added new param for this in pjsua

File:

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

pjproject/trunk/pjmedia/include/pjmedia/sound.h

@@ -152 +152 @@
  */
 PJ_DECL(const pjmedia_snd_dev_info*) pjmedia_snd_get_dev_info(unsigned index);
+
+
+/**
+ * Set sound device latency, this function must be called before sound device
+ * opened, or otherwise default latency setting will be used, @see
+ * PJMEDIA_SND_DEFAULT_REC_LATENCY & PJMEDIA_SND_DEFAULT_PLAY_LATENCY.
+ *
+ * Choosing latency value is not straightforward, it should accomodate both 
+ * minimum latency and stability. Lower latency tends to cause sound device 
+ * less reliable (producing audio dropouts) on CPU load disturbance. Moreover,
+ * the best latency setting may vary based on many aspects, e.g: sound card, 
+ * CPU, OS, kernel, etc.
+ *
+ * @param input_latency     The latency of input device, in ms, set to 0
+ *                          for default PJMEDIA_SND_DEFAULT_REC_LATENCY.
+ * @param output_latency    The latency of output device, in ms, set to 0
+ *                          for default PJMEDIA_SND_DEFAULT_PLAY_LATENCY.
+ *
+ * @return                  PJ_SUCCESS on success.
+ */
+PJ_DECL(pj_status_t) pjmedia_snd_set_latency(unsigned input_latency, 
+                                             unsigned output_latency);