= Using Audio Proxy Server (APS) in PJSIP =

== Introduction ==

From [http://wiki.forum.nokia.com/index.php/Audio_Proxy_Server Nokia wiki on APS]:
  "Audio Proxy Server (APS) is a wrapper to the Nokia S60 sound device. Its main purpose is to bypass the Vendor ID (VID) related restrictions on S60 3rd Edition and S60 3rd Edition, FP1 platforms, when streaming audio data in 3rd party applications. The component is most suitable for VoIP developers who need to set the appropriate audio priority and preference values in order to utilize full duplex audio. 

APS has some benefits over Audio Streaming API:
 - Much lower latency. The Audio Streaming API has few hundreds milliseconds of latency at best, while using APS it is possible to bring down the latency to only about 30ms! 
 - Ability to switch audio-routing (to earpiece or loudspeaker). Routing to earpiece can also avoid echo.

== Requirements ==
To build PJSIP with APS support, we need:
 1. APS release 2.4.3 that is packaged in [http://wiki.forum.nokia.com/index.php/SDK_API_Plugin SDK API Plug-in], e.g:
    - [http://www.forum.nokia.com/info/sw.nokia.com/id/53439e01-f605-4491-96f4-62d003bd4c0c/S60_3rd_SDK_MR_API_Plug-In_Pack1.zip.html APS for MR]
    - [http://www.forum.nokia.com/info/sw.nokia.com/id/4ff42a22-7099-4cc9-91bf-5e66166bd28d/S60_3rd_SDK_FP1_API_Plug-In_Pack.html APS for FP1]
    - we're not sure how APS should work for FP2
 2. You may also need [http://www.forum.nokia.com/info/sw.nokia.com/id/48a93bd5-028a-4b3e-a0b1-148ff203b2b3/Extensions_plugin_S60_3rd_ed.exe.html Extensions plug-in for S60 3rd Edition SDK for Symbian OS for C++ MR] to get '''sounddevice.h'''.
 3. You need a '''Symbian Developer Certificate''' of type Open Signed Offline and with valid Publisher ID to install the application that uses APS on the device. APS requires '''MultimediaDD''' capability and this capability is among the restricted capabilities so the application needs to be signed with a valid developer certificate to use the capability. The signing options for applications that need these restricted capabilities are Open Signed Offline or Certified Signed. Please see [http://www.symbiansigned.com Symbian Signed website] for more detail.

== Building Steps ==
Here are a few steps to build PJSIP with APS support:
 1. Edit {{{bld.inf}}} and application's .mmp files (e.g: {{{symbian_ua.mmp}}}, {{{symbian_ua_gui.mmp}}}, {{{symsndtest.mmp}}}), and activate {{{SND_USE_APS}}} macro:
{{{
#define SND_USE_NULL	0
#define SND_USE_APS	1
}}}
 2. Refresh the makefiles:
    - If you are using Carbide, please refresh the project first (right click '''bld.inf''' from the '''Symbian Project Navigator''' pane, and select '''Refresh'''). '''symbian_audio_aps.mmp''' should be there after the refresh done.
    - If you are building from command line, use '''bldmake clean''' then '''bldmake bldfiles'''.
 3. Clean and rebuild the whole project. Please note that WINSCW target doesn't seem to support APS.
 4. Make the installer (.sis file) for the application.


== Installation ==
 1. Install APS Server '''apsserver2.sisx''' to device, the installer comes with the APS SDK package i.e in folder '''!InstallToDevice/AudioProxyServer243'''. You will need to do this only once for each device.
 2. Sign the application installer with APS support with '''Developer Certificate using Open Signed Offline/with Publisher ID'''.
 3. Install the application to the device.


== Developing Application with APS Support ==
There are some notes for developing application with APS support:
 - Currently, frame time/PTIME supported by sound device with APS is only 20ms. For example if your application is using pjsua, you will need to specify this in pjsua config:
{{{
med_cfg.audio_frame_ptime = 20;
}}}
 - Specify application UID in a global variable named '''APP_UID''' whose base type '''TPtrC''', e.g:
{{{
TPtrC APP_UID = _L("2000521C");
}}}


== Limitation ==
 - As mentioned before, sound device will only support 20ms frame time.
 - Currently, this APS wrapper can only work in S60 3rd edition device that supports G.711, which perhaps means all S60 3rd edition devices.