Context Navigation

Changes between Version 10 and Version 11 of Getting-Started/BB10

Timestamp:: Apr 16, 2013 3:23:17 AM (11 years ago)
Author:: bennylp
Comment:: --

Legend:

: Unmodified
: Added
: Removed
: Modified

Getting-Started/BB10

-                      v10
+                      v11
 === !BlackBerry 10 Native SDK === #ndk
+You'll need [https://developer.blackberry.com/native/ BlackBerry 10 Native SDK] for native development. We tested with SDK version 10.1.0.1020, but this should work with later versions too.
+After you download and install the SDK, set the environment variables by running {{{bbndk-env}}} script provided in the SDK:
+You'll need [https://developer.blackberry.com/native/ BlackBerry 10 Native SDK] for native development. After you download and install the SDK, set the environment variables:
  {{{
 $ source $BBNDK_DIR/bbndk-env.sh
 …
-Note that it is '''no longer necessary''' to have the [https://github.com/blackberry/Cascades-Community-Samples/tree/master/bb10-pjsipdemo BB10 PJSIP Demo] as PJSIP now contains a PJSUA demo for !BlackBerry.
 [[BR]]
 …
  }}}
 . {{{cd}}} to PJSIP source directory.
 . Run '''{{{configure-bb10}}}''' script with suggested parameters as follows. This will setup PJSIP with debugging info and '''without optimization'''.
+. (For debug build) Run '''{{{configure-bb10}}}''' script with debugging info and '''without optimization'''.
  {{{
 $ CFLAGS="-O -g" ./configure-bb10 --disable-speex-aec
  }}}
  You can pass additional parameters as both environment variables or command line options to the '''{{{configure-bb10}}}''' script. See further customization options in [wiki:Getting-Started/Autoconf Building with GNU] page or run '''{{{./configure --help}}}''' for more info.
+ See Build Customiation section in [wiki:Getting-Started/Autoconf#BuildCustomizations Building with GNU] page or run '''{{{./configure --help}}}''' for more customization info.
 . We suggest to fill in your '''{{{config_site.h}}}''' ({{{pjlib/include/pj/config-site.h}}} file) with the following:
  {{{
 …
 == Configuring the Device and Momentics IDE ==
+For the rest of this tutorial, we will assume that you already have the IDE and target device (or simulator) configured for debugging BB10 application. If not, follow [https://developer.blackberry.com/native/documentation/bb10/com.qnx.doc.native_sdk.quickstart/topic/set_up_your_environment.html these instructions].
+Assorted things to check before debugging an application to the device:
+For the rest of this tutorial, we will assume that you already have the IDE and target device (or simulator) configured for debugging BB10 native applications. If not, follow [https://developer.blackberry.com/native/documentation/bb10/com.qnx.doc.native_sdk.quickstart/topic/set_up_your_environment.html these instructions] from !BlackBerry developer site.
+[[BR]]
+== Building and Running the pjsua Demo Application ==
+PJSIP comes with a fully featured pjsua application which runs on all platforms that PJSIP supports including BB10.
+=== Import the PjsuaBB Project ===
+In Momentics IDE:
+. Select '''File''' --> '''Import..'''
+. Select '''General''' and '''Existing Projects into Workspace''', and press '''Next >'''
+. In ''Import..'' dialog:
+    - Select root directory: '''{{{$PJ_DIR/pjsip-apps/src/pjsua/bb10}}}'''
+ Once you select the directory, '''PjsuaBB''' will appear under ''Projects'' list in the dialog. Make sure it is selected (by default it is). Click '''Finish'''
+=== Build PjsuaBB ===
+Just build it.
+=== Create Debug Configuration ===
+. Highlight "PjsuaBB" from the Project Navigator, select '''Run''' --> '''Debug Configurations..''' from the main menu
+. From the left list, right click '''!BlackBerry C/C++ Application''', and select '''New..'''
+. New debug settings will appear with default values
+. Go to '''Debugger''' tab and uncheck '''Stop on startup'''
+. Press '''Apply'''
+=== Running PjsuaBB ===
+Launch debugging session for PjsuaBB. Wait until the app is loaded on the device. You will see telnet instructions on the device's screen. Telnet to this address to operate the application.
+[[BR]]
+== Creating a New PJSIP Based Application == #newapp
+=== Creating a !BlackBerry Native Application === #appconfig
+Use Momentics new project wizard to create a new !BlackBerry native application. This should be easy, and we will not explain it here.
+Configure the permissions by double-clicking ''bar-descriptor.xml'' file and select ''Application'' tab from the bottom of the page, and check these permissions:
+ - Internet
+ - Microphone
+ - Run When Backgrounded
+=== Integrating PJSIP into the App ===  #newappintegrate
+Integrating PJSIP settings into the app is very easy:
+. Open the app's '''.pro''' file (e.g. {{{PjsipBB.pro}}} for PjsipBB app)
+. Include '''pjsip.pri''' file in the relevant target section, e.g.:
+ {{{
+..
+device {
+    CONFIG(debug, debug|release) {
+        ..
+        include(../../../../pjsip.pri)
+        LIBS += -lbb
+        ..
+    }
+}
+..
+ }}}
+The '''pjsip.pri''' file is generated by {{{configure-bb10}}} script (as explained [#pjsippri above]) and contains compilation and link flags to integrate PJSIP with your app.
+[[BR]]
+== Simulator ==
+Install and configure the BB10 simulator, you will need to install a virtual machine player in order to use the simulator. To build for BB10 simulator, just run {{{configure-bb10}}} script with {{{--simulator}}} option:
+ {{{
+$ ./configure-bb10 --simulator
+ }}}
+[[BR]]
+== Multiple PJSIP Build Configurations ==
+If you want to have multiple PJSIP build configurations for your app (for example, Device-Debug, Device-Release, and/or Simulator), you can use the following approach when building PJSIP.
+=== Option 1: Build PJSIP in Multiple Directories ===
+This is of course the easiest, just extract or checkout PJSIP in multiple locations, configure it differently, build, and include the right '''pjsip.pri''' file in the relevant section of you application's QMake '''.pro''' file.
+=== Option 2: Checkout Once, Configure Build and Install Several Times ===
+The second option is to checkout PJSIP in one directory, but configure, build, and install it several times, each with separate build settings and to different install '''{{{--prefix}}}'''. Once the build completes, run {{{make install}}} to install PJSIP development headers and libraries to the installation prefix. You also need to edit the contents of {{{pjsip.pri}}} file, point the path to the right prefix, and rename the {{{pjsip.pri}}} to something more appropriate (e.g. {{{pjsip-device-debug.pri}}}). You then include this .pri file in the relevant section of your application's QMake {{{.pro}}} file.
+[[BR]]
+== Notes ==
+=== Missing Separator ===
+If you forgot to run '''{{{source bbndk-env.sh}}}''' (as explained [#ndk above]) before running {{{make dep}}}, the dependency files will get corrupted with the ''' "!** missing separator" ''' error and you'll have to delete each of those dependency files manually.
+=== GSM Call Interruption Problem === #gsm
+If a VoIP call is in progress when an incoming GSM call arrives, and if the user accepts the GSM call, the audio routing of the phone is flawed producing the following result: The VoIP call goes to speaker and the GSM call does not “grab” the audio channels so you get a “null” GSM call and the VoIP call carries on with speaker.
+To prevent this from happening, application must implement GSM call detection using BB10 native API, and when it detects a GSM call, it should close PJSIP sound device by using either {{{pjsua_set_null_snd_dev()}}} or {{{pjsua_set_no_snd_dev()}}} and put the VoIP call on hold before accepting the GSM call.
+Thank you Bob Cripps of Truphone for the note.
+=== Unable to Get Sound Device Parameters === #snd0
+This error happens because PJSIP is unable to open the audio capture device. Make sure you set the [#appconfig application permissions] correctly.
+=== Troubleshooting !BlackBerry Target Device === #targetprob
 . Development mode is turned ON (''Settings'' --> ''Security and Privacy'' --> ''Development Mode'')
     - Otherwise when you connect the USB you'll have a random IP address and you are not able to connect to target device in Momentics
 …
      - you can ping it (make sure Development Mode is ON)
      - the IP address is correct in Momentics target properties
-[[BR]]
-== Building and Running the pjsua Demo Application ==
-PJSIP comes with a fully featured pjsua application which runs on all platforms that PJSIP supports including BB10.
-=== Import the PjsuaBB Project ===
-In Momentics IDE:
-. Select '''File''' --> '''Import..'''
-. Select '''General''' and '''Existing Projects into Workspace''', and press '''Next >'''
-. In ''Import..'' dialog:
-    - Select root directory: '''{{{$PJ_DIR/pjsip-apps/src/pjsua/bb10}}}'''
- Once you select the directory, '''PjsuaBB''' will appear under ''Projects'' list in the dialog. Make sure it is selected (by default it is). Click '''Finish'''
-=== Build PjsuaBB ===
-Just build it.
-=== Create Debug Configuration ===
-. Highlight "PjsuaBB" from the Project Navigator, select '''Run''' --> '''Debug Configurations..''' from the main menu
-. From the left list, right click '''!BlackBerry C/C++ Application''', and select '''New..'''
-. New debug settings will appear with default values
-. Go to '''Debugger''' tab and uncheck '''Stop on startup'''
-. Press '''Apply'''
-[[BR]]
-== Creating a New PJSIP Based Application == #newapp
-=== Creating a !BlackBerry Native Application === #appconfig
-Use Momentics new project wizard to create a new !BlackBerry native application. This should be easy, and we will not explain it here.
-Configure the permissions by double-clicking ''bar-descriptor.xml'' file and select ''Application'' tab from the bottom of the page, and check these permissions:
-  - Internet
-  - Microphone
-  - Run When Backgrounded
-=== Integrating PJSIP into the App ===  #newappintegrate
-Integrating PJSIP settings into the app is very easy:
-. Open the app's '''.pro''' file (e.g. {{{PjsipBB.pro}}} for PjsipBB app)
-. Include '''pjsip.pri''' file in the relevant target section, e.g.:
- {{{
-..
-device {
-    CONFIG(debug, debug|release) {
-        ..
-        include(../../../../pjsip.pri)
-        LIBS += -lbb
-        ..
+    }
+}
-..
- }}}
-The '''pjsip.pri''' file is generated by {{{configure-bb10}}} script (as explained [#pjsippri above]) and contains compilation and link flags to integrate PJSIP with your app.
-[[BR]]
-== Simulator ==
-Install and configure the BB10 simulator, you will need to install a virtual machine player in order to use the simulator. To build for BB10 simulator, just run {{{configure-bb10}}} script with {{{--simulator}}} option:
- {{{
-$ ./configure-bb10 --simulator
- }}}
-[[BR]]
-== Multiple PJSIP Build Configurations ==
-If you want to have multiple PJSIP build configurations for your app (for example, Device-Debug, Device-Release, and/or Simulator), you can use the following approach when building PJSIP.
-=== Option 1: Build PJSIP in Multiple Directories ===
-This is of course the easiest, just extract or checkout PJSIP in multiple locations, configure it differently, build, and include the right '''pjsip.pri''' file in the relevant section of you application's QMake '''.pro''' file.
-=== Option 2: Checkout Once, Configure Build and Install Several Times ===
-The second option is to checkout PJSIP in one directory, but configure, build, and install it several times, each with separate build settings and to different install '''{{{--prefix}}}'''. Once the build completes, run {{{make install}}} to install PJSIP development headers and libraries to the installation prefix. You also need to edit the contents of {{{pjsip.pri}}} file, point the path to the right prefix, and rename the {{{pjsip.pri}}} to something more appropriate (e.g. {{{pjsip-device-debug.pri}}}). You then include this .pri file in the relevant section of your application's QMake {{{.pro}}} file.
-[[BR]]
-== Notes ==
-=== Missing Separator ===
-If you forgot to run '''{{{source bbndk-env.sh}}}''' (as explained [#ndk above]) before running {{{make dep}}}, the dependency files will get corrupted with the ''' "!** missing separator" ''' error and you'll have to delete each of those dependency files manually.
-=== GSM Call Interruption Problem === #gsm
-If a VoIP call is in progress when an incoming GSM call arrives, and if the user accepts the GSM call, the audio routing of the phone is flawed producing the following result: The VoIP call goes to speaker and the GSM call does not “grab” the audio channels so you get a “null” GSM call and the VoIP call carries on with speaker.
-To prevent this from happening, application must implement GSM call detection using BB10 native API, and when it detects a GSM call, it should close PJSIP sound device by using either {{{pjsua_set_null_snd_dev()}}} or {{{pjsua_set_no_snd_dev()}}} and put the VoIP call on hold before accepting the GSM call.
-Thank you Bob Cripps of Truphone for the note.
-=== Unable to Get Sound Device Parameters === #snd0
-This error happens because PJSIP is unable to open the audio capture device. Make sure you set the [#appconfig application permissions] correctly.