198cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang/* 298cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang * Copyright (C) 2010 The Android Open Source Project 398cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang * 498cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang * Licensed under the Apache License, Version 2.0 (the "License"); 598cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang * you may not use this file except in compliance with the License. 698cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang * You may obtain a copy of the License at 798cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang * 898cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang * http://www.apache.org/licenses/LICENSE-2.0 998cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang * 1098cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang * Unless required by applicable law or agreed to in writing, software 1198cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang * distributed under the License is distributed on an "AS IS" BASIS, 1298cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 1398cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang * See the License for the specific language governing permissions and 1498cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang * limitations under the License. 1598cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang */ 1698cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang 1798cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wangpackage android.net.sip; 1898cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang 19845f7332f04864c5483b3e63da5db076fc7a888aHung-ying Tyanimport android.app.PendingIntent; 2098cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wangimport android.content.Context; 2198cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wangimport android.content.Intent; 2269d66b75112e2763bf8bce718c22c7baa1efac7dHung-ying Tyanimport android.content.pm.PackageManager; 2398cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wangimport android.os.IBinder; 2498cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wangimport android.os.RemoteException; 2598cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wangimport android.os.ServiceManager; 269329db04f13480ccdff013dcc00cdb96f12a921cWink Savilleimport android.telephony.Rlog; 2798cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang 2898cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wangimport java.text.ParseException; 2998cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang 3098cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang/** 3116b441b4ad92c6a5cbc6f27cb3705eaaaaee20c1Scott Main * Provides APIs for SIP tasks, such as initiating SIP connections, and provides access to related 3216b441b4ad92c6a5cbc6f27cb3705eaaaaee20c1Scott Main * SIP services. This class is the starting point for any SIP actions. You can acquire an instance 3316b441b4ad92c6a5cbc6f27cb3705eaaaaee20c1Scott Main * of it with {@link #newInstance newInstance()}.</p> 3416b441b4ad92c6a5cbc6f27cb3705eaaaaee20c1Scott Main * <p>The APIs in this class allows you to:</p> 3598cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang * <ul> 3616b441b4ad92c6a5cbc6f27cb3705eaaaaee20c1Scott Main * <li>Create a {@link SipSession} to get ready for making calls or listen for incoming calls. See 3716b441b4ad92c6a5cbc6f27cb3705eaaaaee20c1Scott Main * {@link #createSipSession createSipSession()} and {@link #getSessionFor getSessionFor()}.</li> 3816b441b4ad92c6a5cbc6f27cb3705eaaaaee20c1Scott Main * <li>Initiate and receive generic SIP calls or audio-only SIP calls. Generic SIP calls may 3916b441b4ad92c6a5cbc6f27cb3705eaaaaee20c1Scott Main * be video, audio, or other, and are initiated with {@link #open open()}. Audio-only SIP calls 4016b441b4ad92c6a5cbc6f27cb3705eaaaaee20c1Scott Main * should be handled with a {@link SipAudioCall}, which you can acquire with {@link 4116b441b4ad92c6a5cbc6f27cb3705eaaaaee20c1Scott Main * #makeAudioCall makeAudioCall()} and {@link #takeAudioCall takeAudioCall()}.</li> 4216b441b4ad92c6a5cbc6f27cb3705eaaaaee20c1Scott Main * <li>Register and unregister with a SIP service provider, with 4316b441b4ad92c6a5cbc6f27cb3705eaaaaee20c1Scott Main * {@link #register register()} and {@link #unregister unregister()}.</li> 4416b441b4ad92c6a5cbc6f27cb3705eaaaaee20c1Scott Main * <li>Verify session connectivity, with {@link #isOpened isOpened()} and 4516b441b4ad92c6a5cbc6f27cb3705eaaaaee20c1Scott Main * {@link #isRegistered isRegistered()}.</li> 4698cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang * </ul> 4716b441b4ad92c6a5cbc6f27cb3705eaaaaee20c1Scott Main * <p class="note"><strong>Note:</strong> Not all Android-powered devices support VOIP calls using 4816b441b4ad92c6a5cbc6f27cb3705eaaaaee20c1Scott Main * SIP. You should always call {@link android.net.sip.SipManager#isVoipSupported 4916b441b4ad92c6a5cbc6f27cb3705eaaaaee20c1Scott Main * isVoipSupported()} to verify that the device supports VOIP calling and {@link 5016b441b4ad92c6a5cbc6f27cb3705eaaaaee20c1Scott Main * android.net.sip.SipManager#isApiSupported isApiSupported()} to verify that the device supports 51b4074803f775e5a4616287804f3405fd17eecab3Joe Fernandez * the SIP APIs. Your application must also request the {@link 5216b441b4ad92c6a5cbc6f27cb3705eaaaaee20c1Scott Main * android.Manifest.permission#INTERNET} and {@link android.Manifest.permission#USE_SIP} 5316b441b4ad92c6a5cbc6f27cb3705eaaaaee20c1Scott Main * permissions.</p> 54b4074803f775e5a4616287804f3405fd17eecab3Joe Fernandez * 55b4074803f775e5a4616287804f3405fd17eecab3Joe Fernandez * <div class="special reference"> 56b4074803f775e5a4616287804f3405fd17eecab3Joe Fernandez * <h3>Developer Guides</h3> 57b4074803f775e5a4616287804f3405fd17eecab3Joe Fernandez * <p>For more information about using SIP, read the 58b4074803f775e5a4616287804f3405fd17eecab3Joe Fernandez * <a href="{@docRoot}guide/topics/network/sip.html">Session Initiation Protocol</a> 59b4074803f775e5a4616287804f3405fd17eecab3Joe Fernandez * developer guide.</p> 60b4074803f775e5a4616287804f3405fd17eecab3Joe Fernandez * </div> 6198cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang */ 6298cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wangpublic class SipManager { 633adf1946e78b52686fa5458e24645b05da57dc22Hung-ying Tyan /** 64845f7332f04864c5483b3e63da5db076fc7a888aHung-ying Tyan * The result code to be sent back with the incoming call 65845f7332f04864c5483b3e63da5db076fc7a888aHung-ying Tyan * {@link PendingIntent}. 66845f7332f04864c5483b3e63da5db076fc7a888aHung-ying Tyan * @see #open(SipProfile, PendingIntent, SipRegistrationListener) 67845f7332f04864c5483b3e63da5db076fc7a888aHung-ying Tyan */ 68845f7332f04864c5483b3e63da5db076fc7a888aHung-ying Tyan public static final int INCOMING_CALL_RESULT_CODE = 101; 69845f7332f04864c5483b3e63da5db076fc7a888aHung-ying Tyan 704e22f5d6687c18440e2f38c7e242d66ad834d1d7Hung-ying Tyan /** 714e22f5d6687c18440e2f38c7e242d66ad834d1d7Hung-ying Tyan * Key to retrieve the call ID from an incoming call intent. 724e22f5d6687c18440e2f38c7e242d66ad834d1d7Hung-ying Tyan * @see #open(SipProfile, PendingIntent, SipRegistrationListener) 734e22f5d6687c18440e2f38c7e242d66ad834d1d7Hung-ying Tyan */ 74845f7332f04864c5483b3e63da5db076fc7a888aHung-ying Tyan public static final String EXTRA_CALL_ID = "android:sipCallID"; 75845f7332f04864c5483b3e63da5db076fc7a888aHung-ying Tyan 764e22f5d6687c18440e2f38c7e242d66ad834d1d7Hung-ying Tyan /** 774e22f5d6687c18440e2f38c7e242d66ad834d1d7Hung-ying Tyan * Key to retrieve the offered session description from an incoming call 784e22f5d6687c18440e2f38c7e242d66ad834d1d7Hung-ying Tyan * intent. 794e22f5d6687c18440e2f38c7e242d66ad834d1d7Hung-ying Tyan * @see #open(SipProfile, PendingIntent, SipRegistrationListener) 804e22f5d6687c18440e2f38c7e242d66ad834d1d7Hung-ying Tyan */ 81845f7332f04864c5483b3e63da5db076fc7a888aHung-ying Tyan public static final String EXTRA_OFFER_SD = "android:sipOfferSD"; 82845f7332f04864c5483b3e63da5db076fc7a888aHung-ying Tyan 83845f7332f04864c5483b3e63da5db076fc7a888aHung-ying Tyan /** 8422523a59d879cf47f1e9c202d001d569fad4f69eHung-ying Tyan * Action to broadcast when SipService is up. 8522523a59d879cf47f1e9c202d001d569fad4f69eHung-ying Tyan * Internal use only. 8622523a59d879cf47f1e9c202d001d569fad4f69eHung-ying Tyan * @hide 8722523a59d879cf47f1e9c202d001d569fad4f69eHung-ying Tyan */ 8822523a59d879cf47f1e9c202d001d569fad4f69eHung-ying Tyan public static final String ACTION_SIP_SERVICE_UP = 8922523a59d879cf47f1e9c202d001d569fad4f69eHung-ying Tyan "android.net.sip.SIP_SERVICE_UP"; 9022523a59d879cf47f1e9c202d001d569fad4f69eHung-ying Tyan /** 913adf1946e78b52686fa5458e24645b05da57dc22Hung-ying Tyan * Action string for the incoming call intent for the Phone app. 923adf1946e78b52686fa5458e24645b05da57dc22Hung-ying Tyan * Internal use only. 933adf1946e78b52686fa5458e24645b05da57dc22Hung-ying Tyan * @hide 943adf1946e78b52686fa5458e24645b05da57dc22Hung-ying Tyan */ 953adf1946e78b52686fa5458e24645b05da57dc22Hung-ying Tyan public static final String ACTION_SIP_INCOMING_CALL = 9698cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang "com.android.phone.SIP_INCOMING_CALL"; 973adf1946e78b52686fa5458e24645b05da57dc22Hung-ying Tyan /** 983adf1946e78b52686fa5458e24645b05da57dc22Hung-ying Tyan * Action string for the add-phone intent. 993adf1946e78b52686fa5458e24645b05da57dc22Hung-ying Tyan * Internal use only. 1003adf1946e78b52686fa5458e24645b05da57dc22Hung-ying Tyan * @hide 1013adf1946e78b52686fa5458e24645b05da57dc22Hung-ying Tyan */ 1023adf1946e78b52686fa5458e24645b05da57dc22Hung-ying Tyan public static final String ACTION_SIP_ADD_PHONE = 10398cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang "com.android.phone.SIP_ADD_PHONE"; 1043adf1946e78b52686fa5458e24645b05da57dc22Hung-ying Tyan /** 1053adf1946e78b52686fa5458e24645b05da57dc22Hung-ying Tyan * Action string for the remove-phone intent. 1063adf1946e78b52686fa5458e24645b05da57dc22Hung-ying Tyan * Internal use only. 1073adf1946e78b52686fa5458e24645b05da57dc22Hung-ying Tyan * @hide 1083adf1946e78b52686fa5458e24645b05da57dc22Hung-ying Tyan */ 1093adf1946e78b52686fa5458e24645b05da57dc22Hung-ying Tyan public static final String ACTION_SIP_REMOVE_PHONE = 11098cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang "com.android.phone.SIP_REMOVE_PHONE"; 1113adf1946e78b52686fa5458e24645b05da57dc22Hung-ying Tyan /** 1123adf1946e78b52686fa5458e24645b05da57dc22Hung-ying Tyan * Part of the ACTION_SIP_ADD_PHONE and ACTION_SIP_REMOVE_PHONE intents. 1133adf1946e78b52686fa5458e24645b05da57dc22Hung-ying Tyan * Internal use only. 1143adf1946e78b52686fa5458e24645b05da57dc22Hung-ying Tyan * @hide 1153adf1946e78b52686fa5458e24645b05da57dc22Hung-ying Tyan */ 1163adf1946e78b52686fa5458e24645b05da57dc22Hung-ying Tyan public static final String EXTRA_LOCAL_URI = "android:localSipUri"; 11798cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang 118e8782e2fdfd256296a0d1fd2a1c3f98d58103eaaHung-ying Tyan private static final String TAG = "SipManager"; 119e8782e2fdfd256296a0d1fd2a1c3f98d58103eaaHung-ying Tyan 12098cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang private ISipService mSipService; 1213adf1946e78b52686fa5458e24645b05da57dc22Hung-ying Tyan private Context mContext; 12298cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang 12398cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang /** 1243adf1946e78b52686fa5458e24645b05da57dc22Hung-ying Tyan * Creates a manager instance. Returns null if SIP API is not supported. 12598cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang * 1263adf1946e78b52686fa5458e24645b05da57dc22Hung-ying Tyan * @param context application context for creating the manager object 12769d66b75112e2763bf8bce718c22c7baa1efac7dHung-ying Tyan * @return the manager instance or null if SIP API is not supported 12898cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang */ 1293adf1946e78b52686fa5458e24645b05da57dc22Hung-ying Tyan public static SipManager newInstance(Context context) { 1303adf1946e78b52686fa5458e24645b05da57dc22Hung-ying Tyan return (isApiSupported(context) ? new SipManager(context) : null); 13169d66b75112e2763bf8bce718c22c7baa1efac7dHung-ying Tyan } 13269d66b75112e2763bf8bce718c22c7baa1efac7dHung-ying Tyan 13369d66b75112e2763bf8bce718c22c7baa1efac7dHung-ying Tyan /** 13469d66b75112e2763bf8bce718c22c7baa1efac7dHung-ying Tyan * Returns true if the SIP API is supported by the system. 13569d66b75112e2763bf8bce718c22c7baa1efac7dHung-ying Tyan */ 13669d66b75112e2763bf8bce718c22c7baa1efac7dHung-ying Tyan public static boolean isApiSupported(Context context) { 13769d66b75112e2763bf8bce718c22c7baa1efac7dHung-ying Tyan return context.getPackageManager().hasSystemFeature( 13869d66b75112e2763bf8bce718c22c7baa1efac7dHung-ying Tyan PackageManager.FEATURE_SIP); 13969d66b75112e2763bf8bce718c22c7baa1efac7dHung-ying Tyan } 14069d66b75112e2763bf8bce718c22c7baa1efac7dHung-ying Tyan 14169d66b75112e2763bf8bce718c22c7baa1efac7dHung-ying Tyan /** 14238ee75e8c0722118d26a23afe5b509b6a09302f4Hung-ying Tyan * Returns true if the system supports SIP-based VOIP API. 14369d66b75112e2763bf8bce718c22c7baa1efac7dHung-ying Tyan */ 14469d66b75112e2763bf8bce718c22c7baa1efac7dHung-ying Tyan public static boolean isVoipSupported(Context context) { 14569d66b75112e2763bf8bce718c22c7baa1efac7dHung-ying Tyan return context.getPackageManager().hasSystemFeature( 14669d66b75112e2763bf8bce718c22c7baa1efac7dHung-ying Tyan PackageManager.FEATURE_SIP_VOIP) && isApiSupported(context); 14798cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang } 14898cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang 149d96284491dfc918c72258f84b47a6554c21db92eHung-ying Tyan /** 150d96284491dfc918c72258f84b47a6554c21db92eHung-ying Tyan * Returns true if SIP is only available on WIFI. 151d96284491dfc918c72258f84b47a6554c21db92eHung-ying Tyan */ 152d96284491dfc918c72258f84b47a6554c21db92eHung-ying Tyan public static boolean isSipWifiOnly(Context context) { 153d96284491dfc918c72258f84b47a6554c21db92eHung-ying Tyan return context.getResources().getBoolean( 154d96284491dfc918c72258f84b47a6554c21db92eHung-ying Tyan com.android.internal.R.bool.config_sip_wifi_only); 155d96284491dfc918c72258f84b47a6554c21db92eHung-ying Tyan } 156d96284491dfc918c72258f84b47a6554c21db92eHung-ying Tyan 1573adf1946e78b52686fa5458e24645b05da57dc22Hung-ying Tyan private SipManager(Context context) { 1583adf1946e78b52686fa5458e24645b05da57dc22Hung-ying Tyan mContext = context; 15969d66b75112e2763bf8bce718c22c7baa1efac7dHung-ying Tyan createSipService(); 16098cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang } 16198cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang 16269d66b75112e2763bf8bce718c22c7baa1efac7dHung-ying Tyan private void createSipService() { 16368144a84e3cd43ba4f62c73dbd2ce9c74d50e1a6Chung-yih Wang IBinder b = ServiceManager.getService(Context.SIP_SERVICE); 16498cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang mSipService = ISipService.Stub.asInterface(b); 16598cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang } 16698cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang 16798cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang /** 16816b441b4ad92c6a5cbc6f27cb3705eaaaaee20c1Scott Main * Opens the profile for making generic SIP calls. The caller may make subsequent calls 1693adf1946e78b52686fa5458e24645b05da57dc22Hung-ying Tyan * through {@link #makeAudioCall}. If one also wants to receive calls on the 170845f7332f04864c5483b3e63da5db076fc7a888aHung-ying Tyan * profile, use 171845f7332f04864c5483b3e63da5db076fc7a888aHung-ying Tyan * {@link #open(SipProfile, PendingIntent, SipRegistrationListener)} 1723adf1946e78b52686fa5458e24645b05da57dc22Hung-ying Tyan * instead. 17398cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang * 17498cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang * @param localProfile the SIP profile to make calls from 17598cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang * @throws SipException if the profile contains incorrect settings or 17698cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang * calling the SIP service results in an error 17798cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang */ 17898cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang public void open(SipProfile localProfile) throws SipException { 17998cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang try { 18098cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang mSipService.open(localProfile); 18198cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang } catch (RemoteException e) { 18298cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang throw new SipException("open()", e); 18398cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang } 18498cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang } 18598cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang 18698cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang /** 18716b441b4ad92c6a5cbc6f27cb3705eaaaaee20c1Scott Main * Opens the profile for making calls and/or receiving generic SIP calls. The caller may 1883adf1946e78b52686fa5458e24645b05da57dc22Hung-ying Tyan * make subsequent calls through {@link #makeAudioCall}. If the 1893adf1946e78b52686fa5458e24645b05da57dc22Hung-ying Tyan * auto-registration option is enabled in the profile, the SIP service 1903adf1946e78b52686fa5458e24645b05da57dc22Hung-ying Tyan * will register the profile to the corresponding SIP provider periodically 1914e22f5d6687c18440e2f38c7e242d66ad834d1d7Hung-ying Tyan * in order to receive calls from the provider. When the SIP service 1924e22f5d6687c18440e2f38c7e242d66ad834d1d7Hung-ying Tyan * receives a new call, it will send out an intent with the provided action 1934e22f5d6687c18440e2f38c7e242d66ad834d1d7Hung-ying Tyan * string. The intent contains a call ID extra and an offer session 1944e22f5d6687c18440e2f38c7e242d66ad834d1d7Hung-ying Tyan * description string extra. Use {@link #getCallId} and 1954e22f5d6687c18440e2f38c7e242d66ad834d1d7Hung-ying Tyan * {@link #getOfferSessionDescription} to retrieve those extras. 19698cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang * 19798cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang * @param localProfile the SIP profile to receive incoming calls for 198845f7332f04864c5483b3e63da5db076fc7a888aHung-ying Tyan * @param incomingCallPendingIntent When an incoming call is received, the 199845f7332f04864c5483b3e63da5db076fc7a888aHung-ying Tyan * SIP service will call 200845f7332f04864c5483b3e63da5db076fc7a888aHung-ying Tyan * {@link PendingIntent#send(Context, int, Intent)} to send back the 201845f7332f04864c5483b3e63da5db076fc7a888aHung-ying Tyan * intent to the caller with {@link #INCOMING_CALL_RESULT_CODE} as the 202845f7332f04864c5483b3e63da5db076fc7a888aHung-ying Tyan * result code and the intent to fill in the call ID and session 203845f7332f04864c5483b3e63da5db076fc7a888aHung-ying Tyan * description information. It cannot be null. 20498cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang * @param listener to listen to registration events; can be null 205845f7332f04864c5483b3e63da5db076fc7a888aHung-ying Tyan * @see #getCallId 206845f7332f04864c5483b3e63da5db076fc7a888aHung-ying Tyan * @see #getOfferSessionDescription 207845f7332f04864c5483b3e63da5db076fc7a888aHung-ying Tyan * @see #takeAudioCall 208845f7332f04864c5483b3e63da5db076fc7a888aHung-ying Tyan * @throws NullPointerException if {@code incomingCallPendingIntent} is null 20998cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang * @throws SipException if the profile contains incorrect settings or 21098cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang * calling the SIP service results in an error 2114e22f5d6687c18440e2f38c7e242d66ad834d1d7Hung-ying Tyan * @see #isIncomingCallIntent 2124e22f5d6687c18440e2f38c7e242d66ad834d1d7Hung-ying Tyan * @see #getCallId 2134e22f5d6687c18440e2f38c7e242d66ad834d1d7Hung-ying Tyan * @see #getOfferSessionDescription 21498cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang */ 21598cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang public void open(SipProfile localProfile, 216845f7332f04864c5483b3e63da5db076fc7a888aHung-ying Tyan PendingIntent incomingCallPendingIntent, 21798cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang SipRegistrationListener listener) throws SipException { 218845f7332f04864c5483b3e63da5db076fc7a888aHung-ying Tyan if (incomingCallPendingIntent == null) { 219845f7332f04864c5483b3e63da5db076fc7a888aHung-ying Tyan throw new NullPointerException( 220845f7332f04864c5483b3e63da5db076fc7a888aHung-ying Tyan "incomingCallPendingIntent cannot be null"); 221845f7332f04864c5483b3e63da5db076fc7a888aHung-ying Tyan } 22298cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang try { 223845f7332f04864c5483b3e63da5db076fc7a888aHung-ying Tyan mSipService.open3(localProfile, incomingCallPendingIntent, 224f3d1e1fd0f86eb956c82634c075b167dc367757cHung-ying Tyan createRelay(listener, localProfile.getUriString())); 22598cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang } catch (RemoteException e) { 22698cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang throw new SipException("open()", e); 22798cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang } 22898cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang } 22998cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang 23098cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang /** 23198cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang * Sets the listener to listen to registration events. No effect if the 232845f7332f04864c5483b3e63da5db076fc7a888aHung-ying Tyan * profile has not been opened to receive calls (see 233845f7332f04864c5483b3e63da5db076fc7a888aHung-ying Tyan * {@link #open(SipProfile, PendingIntent, SipRegistrationListener)}). 23498cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang * 23598cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang * @param localProfileUri the URI of the profile 23698cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang * @param listener to listen to registration events; can be null 23798cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang * @throws SipException if calling the SIP service results in an error 23898cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang */ 23998cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang public void setRegistrationListener(String localProfileUri, 24098cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang SipRegistrationListener listener) throws SipException { 24198cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang try { 24298cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang mSipService.setRegistrationListener( 243f3d1e1fd0f86eb956c82634c075b167dc367757cHung-ying Tyan localProfileUri, createRelay(listener, localProfileUri)); 24498cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang } catch (RemoteException e) { 24598cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang throw new SipException("setRegistrationListener()", e); 24698cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang } 24798cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang } 24898cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang 24998cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang /** 25098cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang * Closes the specified profile to not make/receive calls. All the resources 25198cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang * that were allocated to the profile are also released. 25298cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang * 25398cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang * @param localProfileUri the URI of the profile to close 25498cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang * @throws SipException if calling the SIP service results in an error 25598cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang */ 25698cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang public void close(String localProfileUri) throws SipException { 25798cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang try { 25898cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang mSipService.close(localProfileUri); 25998cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang } catch (RemoteException e) { 26098cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang throw new SipException("close()", e); 26198cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang } 26298cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang } 26398cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang 26498cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang /** 2653adf1946e78b52686fa5458e24645b05da57dc22Hung-ying Tyan * Checks if the specified profile is opened in the SIP service for 2663adf1946e78b52686fa5458e24645b05da57dc22Hung-ying Tyan * making and/or receiving calls. 26798cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang * 26898cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang * @param localProfileUri the URI of the profile in question 26998cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang * @return true if the profile is enabled to receive calls 27098cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang * @throws SipException if calling the SIP service results in an error 27198cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang */ 27298cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang public boolean isOpened(String localProfileUri) throws SipException { 27398cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang try { 27498cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang return mSipService.isOpened(localProfileUri); 27598cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang } catch (RemoteException e) { 27698cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang throw new SipException("isOpened()", e); 27798cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang } 27898cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang } 27998cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang 28098cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang /** 2813adf1946e78b52686fa5458e24645b05da57dc22Hung-ying Tyan * Checks if the SIP service has successfully registered the profile to the 2823adf1946e78b52686fa5458e24645b05da57dc22Hung-ying Tyan * SIP provider (specified in the profile) for receiving calls. Returning 2833adf1946e78b52686fa5458e24645b05da57dc22Hung-ying Tyan * true from this method also implies the profile is opened 2843adf1946e78b52686fa5458e24645b05da57dc22Hung-ying Tyan * ({@link #isOpened}). 28598cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang * 28698cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang * @param localProfileUri the URI of the profile in question 2873adf1946e78b52686fa5458e24645b05da57dc22Hung-ying Tyan * @return true if the profile is registered to the SIP provider; false if 2883adf1946e78b52686fa5458e24645b05da57dc22Hung-ying Tyan * the profile has not been opened in the SIP service or the SIP 2893adf1946e78b52686fa5458e24645b05da57dc22Hung-ying Tyan * service has not yet successfully registered the profile to the SIP 2903adf1946e78b52686fa5458e24645b05da57dc22Hung-ying Tyan * provider 29198cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang * @throws SipException if calling the SIP service results in an error 29298cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang */ 29398cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang public boolean isRegistered(String localProfileUri) throws SipException { 29498cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang try { 29598cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang return mSipService.isRegistered(localProfileUri); 29698cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang } catch (RemoteException e) { 29798cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang throw new SipException("isRegistered()", e); 29898cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang } 29998cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang } 30098cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang 30198cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang /** 302f498e98d2e2910e866ec0728cebbe676dd475d9eHung-ying Tyan * Creates a {@link SipAudioCall} to make a call. The attempt will be timed 303f498e98d2e2910e866ec0728cebbe676dd475d9eHung-ying Tyan * out if the call is not established within {@code timeout} seconds and 30416b441b4ad92c6a5cbc6f27cb3705eaaaaee20c1Scott Main * {@link SipAudioCall.Listener#onError onError(SipAudioCall, SipErrorCode.TIME_OUT, String)} 305f498e98d2e2910e866ec0728cebbe676dd475d9eHung-ying Tyan * will be called. 30698cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang * 30798cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang * @param localProfile the SIP profile to make the call from 30898cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang * @param peerProfile the SIP profile to make the call to 30998cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang * @param listener to listen to the call events from {@link SipAudioCall}; 31098cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang * can be null 3114e22f5d6687c18440e2f38c7e242d66ad834d1d7Hung-ying Tyan * @param timeout the timeout value in seconds. Default value (defined by 3124e22f5d6687c18440e2f38c7e242d66ad834d1d7Hung-ying Tyan * SIP protocol) is used if {@code timeout} is zero or negative. 31398cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang * @return a {@link SipAudioCall} object 31438ee75e8c0722118d26a23afe5b509b6a09302f4Hung-ying Tyan * @throws SipException if calling the SIP service results in an error or 31538ee75e8c0722118d26a23afe5b509b6a09302f4Hung-ying Tyan * VOIP API is not supported by the device 31616b441b4ad92c6a5cbc6f27cb3705eaaaaee20c1Scott Main * @see SipAudioCall.Listener#onError 31738ee75e8c0722118d26a23afe5b509b6a09302f4Hung-ying Tyan * @see #isVoipSupported 31898cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang */ 3193adf1946e78b52686fa5458e24645b05da57dc22Hung-ying Tyan public SipAudioCall makeAudioCall(SipProfile localProfile, 320f498e98d2e2910e866ec0728cebbe676dd475d9eHung-ying Tyan SipProfile peerProfile, SipAudioCall.Listener listener, int timeout) 32198cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang throws SipException { 32238ee75e8c0722118d26a23afe5b509b6a09302f4Hung-ying Tyan if (!isVoipSupported(mContext)) { 32338ee75e8c0722118d26a23afe5b509b6a09302f4Hung-ying Tyan throw new SipException("VOIP API is not supported"); 32438ee75e8c0722118d26a23afe5b509b6a09302f4Hung-ying Tyan } 3253adf1946e78b52686fa5458e24645b05da57dc22Hung-ying Tyan SipAudioCall call = new SipAudioCall(mContext, localProfile); 32698cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang call.setListener(listener); 3277a4ec7268fbfb56e22f1cb8497d37ed733d8aa8eHung-ying Tyan SipSession s = createSipSession(localProfile, null); 3287a4ec7268fbfb56e22f1cb8497d37ed733d8aa8eHung-ying Tyan call.makeCall(peerProfile, s, timeout); 32998cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang return call; 33098cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang } 33198cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang 33298cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang /** 333845f7332f04864c5483b3e63da5db076fc7a888aHung-ying Tyan * Creates a {@link SipAudioCall} to make an audio call. The attempt will be 334845f7332f04864c5483b3e63da5db076fc7a888aHung-ying Tyan * timed out if the call is not established within {@code timeout} seconds 335845f7332f04864c5483b3e63da5db076fc7a888aHung-ying Tyan * and 33616b441b4ad92c6a5cbc6f27cb3705eaaaaee20c1Scott Main * {@link SipAudioCall.Listener#onError onError(SipAudioCall, SipErrorCode.TIME_OUT, String)} 337f498e98d2e2910e866ec0728cebbe676dd475d9eHung-ying Tyan * will be called. 33898cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang * 33998cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang * @param localProfileUri URI of the SIP profile to make the call from 34098cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang * @param peerProfileUri URI of the SIP profile to make the call to 34198cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang * @param listener to listen to the call events from {@link SipAudioCall}; 34298cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang * can be null 3434e22f5d6687c18440e2f38c7e242d66ad834d1d7Hung-ying Tyan * @param timeout the timeout value in seconds. Default value (defined by 3444e22f5d6687c18440e2f38c7e242d66ad834d1d7Hung-ying Tyan * SIP protocol) is used if {@code timeout} is zero or negative. 34598cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang * @return a {@link SipAudioCall} object 34638ee75e8c0722118d26a23afe5b509b6a09302f4Hung-ying Tyan * @throws SipException if calling the SIP service results in an error or 34738ee75e8c0722118d26a23afe5b509b6a09302f4Hung-ying Tyan * VOIP API is not supported by the device 34816b441b4ad92c6a5cbc6f27cb3705eaaaaee20c1Scott Main * @see SipAudioCall.Listener#onError 34938ee75e8c0722118d26a23afe5b509b6a09302f4Hung-ying Tyan * @see #isVoipSupported 35098cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang */ 3513adf1946e78b52686fa5458e24645b05da57dc22Hung-ying Tyan public SipAudioCall makeAudioCall(String localProfileUri, 352f498e98d2e2910e866ec0728cebbe676dd475d9eHung-ying Tyan String peerProfileUri, SipAudioCall.Listener listener, int timeout) 35398cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang throws SipException { 35438ee75e8c0722118d26a23afe5b509b6a09302f4Hung-ying Tyan if (!isVoipSupported(mContext)) { 35538ee75e8c0722118d26a23afe5b509b6a09302f4Hung-ying Tyan throw new SipException("VOIP API is not supported"); 35638ee75e8c0722118d26a23afe5b509b6a09302f4Hung-ying Tyan } 35798cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang try { 3583adf1946e78b52686fa5458e24645b05da57dc22Hung-ying Tyan return makeAudioCall( 35998cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang new SipProfile.Builder(localProfileUri).build(), 360f498e98d2e2910e866ec0728cebbe676dd475d9eHung-ying Tyan new SipProfile.Builder(peerProfileUri).build(), listener, 361f498e98d2e2910e866ec0728cebbe676dd475d9eHung-ying Tyan timeout); 36298cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang } catch (ParseException e) { 36398cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang throw new SipException("build SipProfile", e); 36498cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang } 36598cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang } 36698cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang 36798cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang /** 36898cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang * Creates a {@link SipAudioCall} to take an incoming call. Before the call 36998cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang * is returned, the listener will receive a 370901503e1cf8b6cfac1540a22c325eb5cdd879429Hung-ying Tyan * {@link SipAudioCall.Listener#onRinging} 37198cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang * callback. 37298cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang * 37398cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang * @param incomingCallIntent the incoming call broadcast intent 37498cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang * @param listener to listen to the call events from {@link SipAudioCall}; 37598cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang * can be null 37698cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang * @return a {@link SipAudioCall} object 37798cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang * @throws SipException if calling the SIP service results in an error 37898cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang */ 3793adf1946e78b52686fa5458e24645b05da57dc22Hung-ying Tyan public SipAudioCall takeAudioCall(Intent incomingCallIntent, 3806577ac4cc93ee3670a5aceceb9a95260d41fe570Hung-ying Tyan SipAudioCall.Listener listener) throws SipException { 381b030e52a52acaf28ce68b1010aac007af909478dHung-ying Tyan if (incomingCallIntent == null) { 382b030e52a52acaf28ce68b1010aac007af909478dHung-ying Tyan throw new SipException("Cannot retrieve session with null intent"); 383b030e52a52acaf28ce68b1010aac007af909478dHung-ying Tyan } 38498cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang 38598cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang String callId = getCallId(incomingCallIntent); 38698cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang if (callId == null) { 38798cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang throw new SipException("Call ID missing in incoming call intent"); 38898cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang } 38998cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang 3906d0ef774a2492b0996ded3a43c300c7f72a94897Chia-chi Yeh String offerSd = getOfferSessionDescription(incomingCallIntent); 39198cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang if (offerSd == null) { 39298cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang throw new SipException("Session description missing in incoming " 39398cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang + "call intent"); 39498cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang } 39598cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang 39698cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang try { 39798cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang ISipSession session = mSipService.getPendingSession(callId); 398b030e52a52acaf28ce68b1010aac007af909478dHung-ying Tyan if (session == null) { 399b030e52a52acaf28ce68b1010aac007af909478dHung-ying Tyan throw new SipException("No pending session for the call"); 400b030e52a52acaf28ce68b1010aac007af909478dHung-ying Tyan } 4013adf1946e78b52686fa5458e24645b05da57dc22Hung-ying Tyan SipAudioCall call = new SipAudioCall( 4023adf1946e78b52686fa5458e24645b05da57dc22Hung-ying Tyan mContext, session.getLocalProfile()); 4033adf1946e78b52686fa5458e24645b05da57dc22Hung-ying Tyan call.attachCall(new SipSession(session), offerSd); 40498cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang call.setListener(listener); 40598cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang return call; 40698cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang } catch (Throwable t) { 40798cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang throw new SipException("takeAudioCall()", t); 40898cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang } 40998cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang } 41098cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang 41198cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang /** 41298cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang * Checks if the intent is an incoming call broadcast intent. 41398cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang * 41498cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang * @param intent the intent in question 41598cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang * @return true if the intent is an incoming call broadcast intent 41698cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang */ 41798cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang public static boolean isIncomingCallIntent(Intent intent) { 41898cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang if (intent == null) return false; 41998cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang String callId = getCallId(intent); 4206d0ef774a2492b0996ded3a43c300c7f72a94897Chia-chi Yeh String offerSd = getOfferSessionDescription(intent); 42198cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang return ((callId != null) && (offerSd != null)); 42298cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang } 42398cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang 42498cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang /** 42598cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang * Gets the call ID from the specified incoming call broadcast intent. 42698cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang * 42798cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang * @param incomingCallIntent the incoming call broadcast intent 42898cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang * @return the call ID or null if the intent does not contain it 42998cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang */ 43098cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang public static String getCallId(Intent incomingCallIntent) { 4313adf1946e78b52686fa5458e24645b05da57dc22Hung-ying Tyan return incomingCallIntent.getStringExtra(EXTRA_CALL_ID); 43298cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang } 43398cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang 43498cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang /** 43598cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang * Gets the offer session description from the specified incoming call 43698cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang * broadcast intent. 43798cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang * 43898cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang * @param incomingCallIntent the incoming call broadcast intent 43998cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang * @return the offer session description or null if the intent does not 44098cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang * have it 44198cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang */ 4426d0ef774a2492b0996ded3a43c300c7f72a94897Chia-chi Yeh public static String getOfferSessionDescription(Intent incomingCallIntent) { 4433adf1946e78b52686fa5458e24645b05da57dc22Hung-ying Tyan return incomingCallIntent.getStringExtra(EXTRA_OFFER_SD); 44498cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang } 44598cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang 44698cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang /** 44798cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang * Creates an incoming call broadcast intent. 44898cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang * 44998cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang * @param callId the call ID of the incoming call 45098cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang * @param sessionDescription the session description of the incoming call 45198cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang * @return the incoming call intent 45298cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang * @hide 45398cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang */ 4543adf1946e78b52686fa5458e24645b05da57dc22Hung-ying Tyan public static Intent createIncomingCallBroadcast(String callId, 4553adf1946e78b52686fa5458e24645b05da57dc22Hung-ying Tyan String sessionDescription) { 4563adf1946e78b52686fa5458e24645b05da57dc22Hung-ying Tyan Intent intent = new Intent(); 4573adf1946e78b52686fa5458e24645b05da57dc22Hung-ying Tyan intent.putExtra(EXTRA_CALL_ID, callId); 4583adf1946e78b52686fa5458e24645b05da57dc22Hung-ying Tyan intent.putExtra(EXTRA_OFFER_SD, sessionDescription); 45998cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang return intent; 46098cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang } 46198cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang 46298cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang /** 4633adf1946e78b52686fa5458e24645b05da57dc22Hung-ying Tyan * Manually registers the profile to the corresponding SIP provider for 464845f7332f04864c5483b3e63da5db076fc7a888aHung-ying Tyan * receiving calls. 465845f7332f04864c5483b3e63da5db076fc7a888aHung-ying Tyan * {@link #open(SipProfile, PendingIntent, SipRegistrationListener)} is 466845f7332f04864c5483b3e63da5db076fc7a888aHung-ying Tyan * still needed to be called at least once in order for the SIP service to 46716b441b4ad92c6a5cbc6f27cb3705eaaaaee20c1Scott Main * notify the caller with the {@link android.app.PendingIntent} when an incoming call is 468845f7332f04864c5483b3e63da5db076fc7a888aHung-ying Tyan * received. 46998cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang * 47098cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang * @param localProfile the SIP profile to register with 471901503e1cf8b6cfac1540a22c325eb5cdd879429Hung-ying Tyan * @param expiryTime registration expiration time (in seconds) 47298cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang * @param listener to listen to the registration events 47398cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang * @throws SipException if calling the SIP service results in an error 47498cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang */ 47598cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang public void register(SipProfile localProfile, int expiryTime, 47698cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang SipRegistrationListener listener) throws SipException { 47798cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang try { 478f3d1e1fd0f86eb956c82634c075b167dc367757cHung-ying Tyan ISipSession session = mSipService.createSession(localProfile, 479f3d1e1fd0f86eb956c82634c075b167dc367757cHung-ying Tyan createRelay(listener, localProfile.getUriString())); 480088ef46d8b5a849d80a257670bb2a809713b7bf0Masahiko Endo if (session == null) { 481088ef46d8b5a849d80a257670bb2a809713b7bf0Masahiko Endo throw new SipException( 482088ef46d8b5a849d80a257670bb2a809713b7bf0Masahiko Endo "SipService.createSession() returns null"); 483088ef46d8b5a849d80a257670bb2a809713b7bf0Masahiko Endo } 48498cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang session.register(expiryTime); 48598cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang } catch (RemoteException e) { 48698cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang throw new SipException("register()", e); 48798cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang } 48898cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang } 48998cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang 49098cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang /** 4913adf1946e78b52686fa5458e24645b05da57dc22Hung-ying Tyan * Manually unregisters the profile from the corresponding SIP provider for 4923adf1946e78b52686fa5458e24645b05da57dc22Hung-ying Tyan * stop receiving further calls. This may interference with the auto 4933adf1946e78b52686fa5458e24645b05da57dc22Hung-ying Tyan * registration process in the SIP service if the auto-registration option 4943adf1946e78b52686fa5458e24645b05da57dc22Hung-ying Tyan * in the profile is enabled. 49598cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang * 49698cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang * @param localProfile the SIP profile to register with 49798cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang * @param listener to listen to the registration events 49898cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang * @throws SipException if calling the SIP service results in an error 49998cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang */ 50098cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang public void unregister(SipProfile localProfile, 50198cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang SipRegistrationListener listener) throws SipException { 50298cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang try { 503f3d1e1fd0f86eb956c82634c075b167dc367757cHung-ying Tyan ISipSession session = mSipService.createSession(localProfile, 504f3d1e1fd0f86eb956c82634c075b167dc367757cHung-ying Tyan createRelay(listener, localProfile.getUriString())); 505088ef46d8b5a849d80a257670bb2a809713b7bf0Masahiko Endo if (session == null) { 506088ef46d8b5a849d80a257670bb2a809713b7bf0Masahiko Endo throw new SipException( 507088ef46d8b5a849d80a257670bb2a809713b7bf0Masahiko Endo "SipService.createSession() returns null"); 508088ef46d8b5a849d80a257670bb2a809713b7bf0Masahiko Endo } 50998cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang session.unregister(); 51098cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang } catch (RemoteException e) { 51198cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang throw new SipException("unregister()", e); 51298cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang } 51398cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang } 51498cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang 51598cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang /** 5164e22f5d6687c18440e2f38c7e242d66ad834d1d7Hung-ying Tyan * Gets the {@link SipSession} that handles the incoming call. For audio 51798cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang * calls, consider to use {@link SipAudioCall} to handle the incoming call. 518901503e1cf8b6cfac1540a22c325eb5cdd879429Hung-ying Tyan * See {@link #takeAudioCall}. Note that the method may be called only once 519901503e1cf8b6cfac1540a22c325eb5cdd879429Hung-ying Tyan * for the same intent. For subsequent calls on the same intent, the method 520901503e1cf8b6cfac1540a22c325eb5cdd879429Hung-ying Tyan * returns null. 52198cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang * 52298cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang * @param incomingCallIntent the incoming call broadcast intent 52398cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang * @return the session object that handles the incoming call 52498cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang */ 5254e22f5d6687c18440e2f38c7e242d66ad834d1d7Hung-ying Tyan public SipSession getSessionFor(Intent incomingCallIntent) 52698cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang throws SipException { 52798cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang try { 52898cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang String callId = getCallId(incomingCallIntent); 5294e22f5d6687c18440e2f38c7e242d66ad834d1d7Hung-ying Tyan ISipSession s = mSipService.getPendingSession(callId); 530088ef46d8b5a849d80a257670bb2a809713b7bf0Masahiko Endo return ((s == null) ? null : new SipSession(s)); 53198cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang } catch (RemoteException e) { 53298cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang throw new SipException("getSessionFor()", e); 53398cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang } 53498cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang } 53598cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang 53698cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang private static ISipSessionListener createRelay( 537f3d1e1fd0f86eb956c82634c075b167dc367757cHung-ying Tyan SipRegistrationListener listener, String uri) { 538f3d1e1fd0f86eb956c82634c075b167dc367757cHung-ying Tyan return ((listener == null) ? null : new ListenerRelay(listener, uri)); 53998cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang } 54098cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang 54198cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang /** 5424e22f5d6687c18440e2f38c7e242d66ad834d1d7Hung-ying Tyan * Creates a {@link SipSession} with the specified profile. Use other 5434e22f5d6687c18440e2f38c7e242d66ad834d1d7Hung-ying Tyan * methods, if applicable, instead of interacting with {@link SipSession} 54498cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang * directly. 54598cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang * 54698cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang * @param localProfile the SIP profile the session is associated with 54798cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang * @param listener to listen to SIP session events 54898cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang */ 5493adf1946e78b52686fa5458e24645b05da57dc22Hung-ying Tyan public SipSession createSipSession(SipProfile localProfile, 5503adf1946e78b52686fa5458e24645b05da57dc22Hung-ying Tyan SipSession.Listener listener) throws SipException { 55198cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang try { 5523adf1946e78b52686fa5458e24645b05da57dc22Hung-ying Tyan ISipSession s = mSipService.createSession(localProfile, null); 553b030e52a52acaf28ce68b1010aac007af909478dHung-ying Tyan if (s == null) { 554b030e52a52acaf28ce68b1010aac007af909478dHung-ying Tyan throw new SipException( 555b030e52a52acaf28ce68b1010aac007af909478dHung-ying Tyan "Failed to create SipSession; network unavailable?"); 556b030e52a52acaf28ce68b1010aac007af909478dHung-ying Tyan } 5573adf1946e78b52686fa5458e24645b05da57dc22Hung-ying Tyan return new SipSession(s, listener); 55898cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang } catch (RemoteException e) { 55998cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang throw new SipException("createSipSession()", e); 56098cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang } 56198cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang } 56298cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang 56398cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang /** 56498cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang * Gets the list of profiles hosted by the SIP service. The user information 56598cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang * (username, password and display name) are crossed out. 56698cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang * @hide 56798cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang */ 56898cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang public SipProfile[] getListOfProfiles() { 56998cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang try { 57098cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang return mSipService.getListOfProfiles(); 57198cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang } catch (RemoteException e) { 572b030e52a52acaf28ce68b1010aac007af909478dHung-ying Tyan return new SipProfile[0]; 57398cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang } 57498cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang } 57598cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang 57698cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang private static class ListenerRelay extends SipSessionAdapter { 57798cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang private SipRegistrationListener mListener; 578f3d1e1fd0f86eb956c82634c075b167dc367757cHung-ying Tyan private String mUri; 57998cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang 58098cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang // listener must not be null 581f3d1e1fd0f86eb956c82634c075b167dc367757cHung-ying Tyan public ListenerRelay(SipRegistrationListener listener, String uri) { 58298cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang mListener = listener; 583f3d1e1fd0f86eb956c82634c075b167dc367757cHung-ying Tyan mUri = uri; 58498cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang } 58598cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang 58698cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang private String getUri(ISipSession session) { 58798cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang try { 588d8d3b15f408314ac88201eee3e401a35556ba669Hung-ying Tyan return ((session == null) 589f3d1e1fd0f86eb956c82634c075b167dc367757cHung-ying Tyan ? mUri 590d8d3b15f408314ac88201eee3e401a35556ba669Hung-ying Tyan : session.getLocalProfile().getUriString()); 591e8782e2fdfd256296a0d1fd2a1c3f98d58103eaaHung-ying Tyan } catch (Throwable e) { 592e8782e2fdfd256296a0d1fd2a1c3f98d58103eaaHung-ying Tyan // SipService died? SIP stack died? 5939329db04f13480ccdff013dcc00cdb96f12a921cWink Saville Rlog.e(TAG, "getUri(): ", e); 594e8782e2fdfd256296a0d1fd2a1c3f98d58103eaaHung-ying Tyan return null; 59598cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang } 59698cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang } 59798cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang 59898cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang @Override 59998cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang public void onRegistering(ISipSession session) { 60098cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang mListener.onRegistering(getUri(session)); 60198cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang } 60298cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang 60398cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang @Override 60498cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang public void onRegistrationDone(ISipSession session, int duration) { 60598cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang long expiryTime = duration; 60698cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang if (duration > 0) expiryTime += System.currentTimeMillis(); 60798cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang mListener.onRegistrationDone(getUri(session), expiryTime); 60898cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang } 60998cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang 61098cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang @Override 611a0171082cfc4b860a82dcf5ebbd498b253f1032fHung-ying Tyan public void onRegistrationFailed(ISipSession session, int errorCode, 61298cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang String message) { 613a0171082cfc4b860a82dcf5ebbd498b253f1032fHung-ying Tyan mListener.onRegistrationFailed(getUri(session), errorCode, message); 61498cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang } 61598cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang 61698cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang @Override 61798cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang public void onRegistrationTimeout(ISipSession session) { 61898cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang mListener.onRegistrationFailed(getUri(session), 6191ab079168ccc185408a8691c6b804021d79f7376Hung-ying Tyan SipErrorCode.TIME_OUT, "registration timed out"); 62098cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang } 62198cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang } 62298cee0ce2354234e72bafb836864ec10a490ea4dChung-yih Wang} 623