SipManager

EXTRA_CALL_ID

String EXTRA_CALL_ID

Key to retrieve the call ID from an incoming call intent.

Constant Value: "android:sipCallID"

EXTRA_OFFER_SD

String EXTRA_OFFER_SD

Key to retrieve the offered session description from an incoming call intent.

Constant Value: "android:sipOfferSD"

INCOMING_CALL_RESULT_CODE

int INCOMING_CALL_RESULT_CODE

The result code to be sent back with the incoming call PendingIntent.

Constant Value: 101 (0x00000065)

close

void close (String localProfileUri)

Closes the specified profile to not make/receive calls. All the resources that were allocated to the profile are also released.

createSipSession

SipSession createSipSession (SipProfile localProfile, 
                SipSession.Listener listener)

Creates a SipSession with the specified profile. Use other methods, if applicable, instead of interacting with SipSession directly.

getCallId

String getCallId (Intent incomingCallIntent)

Gets the call ID from the specified incoming call broadcast intent.

getOfferSessionDescription

String getOfferSessionDescription (Intent incomingCallIntent)

Gets the offer session description from the specified incoming call broadcast intent.

getSessionFor

SipSession getSessionFor (Intent incomingCallIntent)

Gets the SipSession that handles the incoming call. For audio calls, consider to use SipAudioCall to handle the incoming call. See takeAudioCall(Intent, SipAudioCall.Listener). Note that the method may be called only once for the same intent. For subsequent calls on the same intent, the method returns null.

isApiSupported

boolean isApiSupported (Context context)

Returns true if the SIP API is supported by the system.

isIncomingCallIntent

boolean isIncomingCallIntent (Intent intent)

Checks if the intent is an incoming call broadcast intent.

isOpened

boolean isOpened (String localProfileUri)

Checks if the specified profile is opened in the SIP service for making and/or receiving calls.

isRegistered

boolean isRegistered (String localProfileUri)

Checks if the SIP service has successfully registered the profile to the SIP provider (specified in the profile) for receiving calls. Returning true from this method also implies the profile is opened (isOpened(String)).

isSipWifiOnly

boolean isSipWifiOnly (Context context)

Returns true if SIP is only available on WIFI.

isVoipSupported

boolean isVoipSupported (Context context)

Returns true if the system supports SIP-based VOIP API.

makeAudioCall

SipAudioCall makeAudioCall (String localProfileUri, 
                String peerProfileUri, 
                SipAudioCall.Listener listener, 
                int timeout)

Creates a SipAudioCall to make an audio call. The attempt will be timed out if the call is not established within timeout seconds and onError(SipAudioCall, SipErrorCode.TIME_OUT, String) will be called.

makeAudioCall

SipAudioCall makeAudioCall (SipProfile localProfile, 
                SipProfile peerProfile, 
                SipAudioCall.Listener listener, 
                int timeout)

Creates a SipAudioCall to make a call. The attempt will be timed out if the call is not established within timeout seconds and onError(SipAudioCall, SipErrorCode.TIME_OUT, String) will be called.

newInstance

SipManager newInstance (Context context)

Creates a manager instance. Returns null if SIP API is not supported.

open

void open (SipProfile localProfile, 
                PendingIntent incomingCallPendingIntent, 
                SipRegistrationListener listener)

Opens the profile for making calls and/or receiving generic SIP calls. The caller may make subsequent calls through makeAudioCall(SipProfile, SipProfile, SipAudioCall.Listener, int). If the auto-registration option is enabled in the profile, the SIP service will register the profile to the corresponding SIP provider periodically in order to receive calls from the provider. When the SIP service receives a new call, it will send out an intent with the provided action string. The intent contains a call ID extra and an offer session description string extra. Use getCallId(Intent) and getOfferSessionDescription(Intent) to retrieve those extras.

open

void open (SipProfile localProfile)

Opens the profile for making generic SIP calls. The caller may make subsequent calls through makeAudioCall(SipProfile, SipProfile, SipAudioCall.Listener, int). If one also wants to receive calls on the profile, use open(SipProfile, PendingIntent, SipRegistrationListener) instead.

register

void register (SipProfile localProfile, 
                int expiryTime, 
                SipRegistrationListener listener)

Manually registers the profile to the corresponding SIP provider for receiving calls. open(SipProfile, PendingIntent, SipRegistrationListener) is still needed to be called at least once in order for the SIP service to notify the caller with the PendingIntent when an incoming call is received.

setRegistrationListener

void setRegistrationListener (String localProfileUri, 
                SipRegistrationListener listener)

Sets the listener to listen to registration events. No effect if the profile has not been opened to receive calls (see open(SipProfile, PendingIntent, SipRegistrationListener)).

takeAudioCall

SipAudioCall takeAudioCall (Intent incomingCallIntent, 
                SipAudioCall.Listener listener)

Creates a SipAudioCall to take an incoming call. Before the call is returned, the listener will receive a onRinging(SipAudioCall, SipProfile) callback.

unregister

void unregister (SipProfile localProfile, 
                SipRegistrationListener listener)

Manually unregisters the profile from the corresponding SIP provider for stop receiving further calls. This may interference with the auto registration process in the SIP service if the auto-registration option in the profile is enabled.