Android Tutorial Android Sip / Voip tutorial

Erel

Administrator
Staff member
Licensed User
With the new Sip library you can make audio calls using Voip (Voice over IP) services.
Sip features were added in Android 2.3 (API level 9). Note that not all devices above Android 2.3 support Sip features.

In order to use this library you will need to set android.jar in Tools > Configure Paths to platform-9 or above.

The library includes two types of objects: Sip and SipAudioCall. Sip is the main object which manages the Sip services. Once you make a call or receive an incoming call you will get a SipAudioCall which represents the call.

In this example the Sip code is written in the main Activity. A better solution is to manage the Sip services from a Service module. Otherwise you may lose incoming calls if the Activity is not in the foreground.

Registration
The first step is to register to the server.
B4X:
Sub Activity_Create(FirstTime As Boolean)
   If Sip.IsInitialized = False Then
      'Check if SIP and VOIP are supported.
      If Sip.IsSipSupported = False OR Sip.IsVoipSupported = False Then
         Log("Not supported.")
         ToastMessageShow("SIP not supported.", True)
      Else
         'Register with the VOIP service
         Sip.Initialize2("SIP", "sip:xxx@iptel.org", "xxx")
         Sip.Register
      End If
   End If
   Activity.LoadLayout("1")
End Sub

Sub SIP_Registering
   Log("Registering")
End Sub

Sub SIP_RegistrationFailed (ErrorCode As Int, ErrorMessage As String)
   Log("Failed, ErrorCode=" & ErrorCode & ", Message=" & ErrorMessage)
   ToastMessageShow("Registration failed.", True)
End Sub

Sub SIP_RegistrationDone (ExpiryTime As Long)
   Log("RegistrationDone, ExpiryTime=" & ExpiryTime)
   ToastMessageShow("SIP registered sucessfully", True)
   btnMakeCall.Enabled = True
End Sub
Registering is done by initializing the Sip object with your account Uri and password and calling Register.
The actual registration is done in the background.
RegistrationDone event is raised when registration completes successfully (with the expiry time measured in seconds). If there is a problem then RegistrationFailed will be raised.
The error codes are available here.

Making calls
Now that the Sip is registered we can make audio calls.
This is done by calling Sip.MakeCall.
For example, this code calls a free directory service:
B4X:
Sub btnMakeCall_Click
   CurrentCall = Sip.MakeCall("sip:8355@ideasip.com", 30)
End Sub
CurrentCall is of type SipAudioCall and it is declared in Process_Globals.
You should now wait for the CallEstablished event (or CallError if there is a problem).
CallEstablished event is raised when the other side answers the call.
B4X:
Sub SIP_CallEstablished
   'Check that we are not already in a call.
   'Seems like this event can be raised by the SIP service multiple times.
   If CurrentCall.IsInCall Then Return

   CurrentCall.StartAudio 'Start the audio
   CurrentCall.SpeakerMode = True
   ToastMessageShow("Call established", True)
End Sub
When the call is established we need to call StartAudio and set SpeakerMode to True in order to start talking.

As you can see in the above code, we first check if CurrentCall.IsInCall is false. It will be true after the StartAudio call. It seems that the internal Sip service raises the CallEstablished more than once for a single call. This way we make sure that our code only runs once for each call.

Incoming calls
When there is an incoming call, the CallRinging event will be raised:
B4X:
'Incoming call
Sub SIP_CallRinging (IncomingCall As SipAudioCall)
   Log("CallRinging")
   ToastMessageShow("Ringing from: " & IncomingCall.PeerUri, True)
   CurrentCall = IncomingCall
End Sub

'Answers an incoming call
Sub btnAnswer_Click
   CurrentCall.AnswerCall(30)
End Sub
A SipAudioCall is passed in this event. We should hold a reference to this object. Calling AnswerCall will cause the call to be established and will raise the CallEstablished event.

See the attached example for a simple program that calls a free directory service and handles incoming calls.

In order to test it you can register to Welcome to iptel.org, the IP Telecommunications Portal | iptel.org. I registered two accounts and then I was able to call from the computer to the device (to test the incoming calls).

The library is available here: http://www.basic4ppc.com/forum/addi...updates/13089-sip-voip-library.html#post73694
 

Attachments

Nizze

Active Member
Licensed User
Yes

Hi Erel

Great to hear about SIP
I tryed on my Samsung S2 but on that one it did not work .
But it worked on my Motorola XOOM.

Can i do anything to make it work on my Samsung ??

// Nizze
 

Nizze

Active Member
Licensed User
How didn't it work? Did you check the logs? Are there any error message?
I have not checked the logs, But i get "sip not supported " with the test app
And when i try the same apk in my xoom .. It works OK


Br

Nizze
 

Nizze

Active Member
Licensed User
Not all devices support Sip services. I don't think that you can do anything about it. Maybe upgrading the OS will help.
Oki doki ..

I have 2.3.5 in my Samsung S2 .
So lets hope that Samsung can add this feature in some upcoming releases.

I will take some other phones and try .

Br

Nizze
 

johnthomcode

Member
Licensed User
I keep getting "TRANSACTION_TERMINTED" (3), but phone is supported (LG LS670), WiFi and 3G are both active, and I've tried two different SIP carriers. Is anyone else seeing this or aware what may be causing it?

Thanks!
 

johnthomcode

Member
Licensed User
Hi,

Yes, I am. I've tried repeatedly since posting with the same results. I wasn't sure if they were down? I also made sure WiFi was active in case Sprint was preventing data access.

I also tried pbxes.com. Any other suggestions that anyone is having success with?

Thanks!

-John
 

Ian Garton

Member
Licensed User
Does this library support direct SIP calling? ie, SIP without having to register with a server?

On other O/S platforms I can place and receive SIP calls by using the URI addresses, however I can't work out how to initialise the SIP object here for this purpose.
 

selvamurali

Active Member
Licensed User
SIP Error

Hi Erel


I am try to run the sip program but i got this error

B4A line: 20
Sip.Register
javac 1.7.0_03
src\anywheresoftware\b4a\samples\sip\main.java:225: error: cannot access SipException
_sip.Register(processBA);
^
class file for android.net.sip.SipException not found
 

ovt001

Member
Licensed User
Hi Erel,
I have tried the source code on my mobile Motorola Defy Plus 2.3.5 but I receive SIP not supported.
BUT other Sip client are working fine...
Do you have an issue?
What check really the function "IsSipSupported"??

thank you
O.
 

zritholtz

New Member
Licensed User
No Audio

Hi, I tried the sample code. The account registers. When I make an outbound call, I get no audio. When I receive a call, the audio works. Any suggestions?
 
Top