Android Programming Press on the image to return to the main documentation page.

Sip

List of types:

Sip
SipAudioCall

Sip

Provides access to Voip / Sip services. Only Android 2.3 (API 9) and above are supported.
A tutorial is available here.

Permissions:

android.permission.USE_SIP
android.permission.INTERNET
android.permission.RECORD_AUDIO
android.permission.ACCESS_WIFI_STATE
android.permission.WAKE_LOCK
android.permission.MODIFY_AUDIO_SETTINGS

Events:

Registering
RegistrationDone (ExpiryTime As Long)
RegistrationFailed (ErrorCode As Int, ErrorMessage As String)
CallEstablished
CallEnded
Calling
CallError (ErrorCode As Int, ErrorMessage As String)
CallRinging (IncomingCall As SipAudioCall)

Members:


  AutoRegistration As Boolean [write only]

  Close

  DisplayName As String [write only]

  Initialize (EventName As String, User As String, Host As String, Password As String)

  Initialize2 (EventName As String, Uri As String, Password As String)

  IsInitialized As Boolean [read only]

  IsSipSupported As Boolean [read only]

  IsVoipSupported As Boolean [read only]

  MakeCall (TargetUri As String, TimeoutSeconds As Int) As SipAudioCall

  OutboundProxy As String [write only]

  Port As Int [write only]

  ProfileName As String [write only]

  Protocol As String [write only]

  Register

  SendKeepAlive As Boolean [write only]

Members description:

AutoRegistration As Boolean [write only]
Sets whether the Sip manager will register automatically if needed.
Close
Closes the connection.
DisplayName As String [write only]
Sets the user display name.
Initialize (EventName As String, User As String, Host As String, Password As String)
Initializes the object.
EventName - Sets the subs that will handle the events.
User - User name.
Host - Host name or IP address.
Password - Account password.
Initialize2 (EventName As String, Uri As String, Password As String)
Initializes the object.
EventName - Sets the subs that will handle the events.
Uri - The profile Uri. For example: sip:zzz@iptel.org
Password - Account password.
IsInitialized As Boolean [read only]
Tests whether the object was initialized.
IsSipSupported As Boolean [read only]
Tests whether Sip API is supported on the device.
IsVoipSupported As Boolean [read only]
Tests whether Voip is supported on this device.
MakeCall (TargetUri As String, TimeoutSeconds As Int) As SipAudioCall
Makes an audio call. This method should only be called after registering.
TargetUri - The target Uri.
TimeoutSeconds - The timeout measured in seconds.
OutboundProxy As String [write only]
Sets the outbound proxy address.
Port As Int [write only]
Sets the connection port.
ProfileName As String [write only]
Sets the user defined profile name.
Protocol As String [write only]
Sets the protocol. Either "TCP" or "UDP".
Register
Sends a registration request to the server.
The following events will be raised: Registering and RegistrationDone or RegistrationFail.
SendKeepAlive As Boolean [write only]
Sets whether keep-alive messages will be sent automatically.

SipAudioCall

Represents an audio call.
This object is created by calling Sip.MakeCall or from the CallRinging event.

Events:

None

Members:


  AnswerCall (TimeoutSeconds As Int)

  EndCall

  IsInCall As Boolean [read only]

  IsInitialized As Boolean

  IsMuted As Boolean [read only]

  PeerUri As String [read only]

  SendDtmf (Code As Int)

  SpeakerMode As Boolean [write only]

  StartAudio

  ToggleMute

Members description:

AnswerCall (TimeoutSeconds As Int)
Answers an incoming call.
TimeoutSeconds - Allowed time for the call to be established.
EndCall
Ends the current call.
IsInCall As Boolean [read only]
Tests whether the call was established.
IsInitialized As Boolean
IsMuted As Boolean [read only]
Tests whether the microphone is muted.
PeerUri As String [read only]
Gets the peer Uri.
SendDtmf (Code As Int)
Sends a Dtmf tone. Values can be 0-15, where 0-9 are the digits, 10 is '*', 11 is '# and 12-15 are 'A'-'D'.
SpeakerMode As Boolean [write only]
Sets the speaker mode.
StartAudio
Starts the audio for the call. Should be called in CallEstablished event.
ToggleMute
Toggles the microphone mute.
Top