Changes between Version 6 and Version 7 of Audio_Dev_API

Timestamp:

Feb 20, 2009 4:19:58 PM (16 years ago)

Author:

bennylp

Comment:

--

Audio_Dev_API

@@ -96 +96 @@
     a. I have changed my application to use the new API
        - also use setting 3
+
+[[BR]]
+
+== Porting applications to new API ==
+
+As stated above, existing applications should build fine with the new changes. However, it will still be beneficial to port the application to use the new API since the old sound API has been deprecated, and also to make use of the new features in the new Audio Device API.
+
+This section describes how to port applications to use the new Audio Device API.
+
+=== PJSUA-LIB applications ===
+
+PJSUA-LIB applications that only make use of the API in {{{<pjsua.h>}}} should require minimum changes.
+
+ 1. Change in {{{pjsua_enum_snd_devs()}}} signature. Old API:
+    {{{
+PJ_DECL(pj_status_t) pjsua_enum_snd_devs(pjmedia_snd_dev_info info[], unsigned *count);
+    }}}
+ New API (notice the type difference in the ''info'' argument):
+    {{{
+PJ_DECL(pj_status_t) pjsua_enum_snd_devs(pjmedia_aud_dev_info info[], unsigned *count);
+    }}}
+
+ 2. Add '''pjmedia-audiodev''' library to the link specifications of your application.
+
+
+=== PJMEDIA applications ===
+
+Below are list of changes for applications that directly uses the old sound API as declared in {{{<pjmedia/sound.h>}}}.
+
+ 1. Change the header file to include. Old code:
+    {{{
+#include <pjmedia/sound.h>
+    }}}
+    New code:
+    {{{
+#include <pjmedia_audiodev.h>
+    }}}
+ 2. Add '''pjmedia-audiodev''' library to the link specifications of your application.
+ 3. Sound device subsystem startup and shutdown. Old code:
+    {{{
+pjmedia_snd_init(pf);
+ ...
+pjmedia_snd_deinit();
+    }}}
+    New code:
+    {{{
+pjmedia_aud_subsys_init(pf);
+ ...
+pjmedia_aud_subsys_shutdown();
+    }}}
+ 4. Device enumeration. Old code:
+    {{{
+unsigned i, dev_count;
+
+dev_count = pjmedia_snd_get_dev_count();
+for (i=0; i<dev_count; ++i) {
+    const pjmedia_snd_dev_info *dev_info = pjmedia_snd_get_dev_info(i);
+}
+    }}}
+    New code:
+    {{{
+unsigned i, dev_count;
+
+dev_count = pjmedia_aud_dev_count();
+for (i=0; i<dev_count; ++i) {
+    pjmedia_aud_dev_info dev_info;
+    pj_status_t status;
+
+    status = pjmedia_aud_dev_get_info(i, &info);
+}
+    }}}
+ 5. Opening sound device. Old code:
+    {{{
+pjmedia_snd_stream *stream;
+pj_status_t status;
+
+status = pjmedia_snd_open(-1,       // default capture device ID
+                          -1,       // default playback device ID
+                          8000,     // clock rate
+                          1,        // channel count
+                          160,      // samples per frame
+                          16,       // bits per sample
+                          &rec_cb,  // capture callback
+                          &play_cb, // playback callback
+                          user_data,
+                          &stream);
+if (status != PJ_SUCCESS)
+   ..
+    }}}
+    New code:
+    {{{
+pjmedia_aud_dev_param param;
+pjmedia_aud_stream *stream;
+pj_status_t status;
+
+status = pjmedia_aud_dev_default_param(PJMEDIA_AUD_DEV_DEFAULT, &param);
+if (status != PJ_SUCCESS)
+   ..
+
+param.dir = PJMEDIA_DIR_CAPTURE_PLAYBACK;
+param.rec_id = PJMEDIA_AUD_DEV_DEFAULT;
+param.play_id = PJMEDIA_AUD_DEV_DEFAULT;
+param.clock_rate = 8000;
+param.channel_count = 1;
+param.samples_per_frame = 160;
+param.bits_per_sample = 16;
+.. // put additional settings here
+
+status = pjmedia_aud_stream_create(&param,
+                                   &rec_cb,
+                                   &play_cb,
+                                   user_data,
+                                   &stream);
+if (status != PJ_SUCCESS)
+   ..
+    }}}
+ 6. .. and so on
+
+
+