Home | History | Annotate | Download | only in sip
      1 <HTML>
      2 <BODY>
      3 <p>Provides access to Session Initiation Protocol (SIP) functionality, such as
      4 making and answering VOIP calls using SIP.</p>
      5 
      6 <p>To get started, you need to get an instance of the {@link android.net.sip.SipManager} by
      7 calling {@link android.net.sip.SipManager#newInstance newInstance()}.</p>
      8 
      9 <p>With the {@link android.net.sip.SipManager}, you can initiate SIP audio calls with {@link
     10 android.net.sip.SipManager#makeAudioCall makeAudioCall()} and {@link
     11 android.net.sip.SipManager#takeAudioCall takeAudioCall()}. Both methods require
     12 a {@link android.net.sip.SipAudioCall.Listener} that receives callbacks when the state of the
     13 call changes, such as when the call is ringing, established, or ended.</p>
     14 
     15 <p>Both {@link android.net.sip.SipManager#makeAudioCall makeAudioCall()} also requires two
     16 {@link android.net.sip.SipProfile} objects, representing the local device and the peer
     17 device. You can create a {@link android.net.sip.SipProfile} using the {@link
     18 android.net.sip.SipProfile.Builder} subclass.</p>
     19 
     20 <p>Once you have a {@link android.net.sip.SipAudioCall}, you can perform SIP audio call actions with
     21 the instance, such as make a call, answer a call, mute a call, turn on speaker mode, send DTMF
     22 tones, and more.</p>
     23 
     24 <p>If you want to create generic SIP connections (such as for video calls or other), you can
     25 create a SIP connection from the {@link android.net.sip.SipManager}, using {@link
     26 android.net.sip.SipManager#open open()}. If you only want to create audio SIP calls, though, you
     27 should use the {@link android.net.sip.SipAudioCall} class, as described above.</p>
     28 
     29 <p class="note"><strong>Note:</strong>
     30 Not all Android-powered devices support VOIP functionality with SIP. Before performing any SIP
     31 activity, you should call {@link android.net.sip.SipManager#isVoipSupported isVoipSupported()}
     32 to verify that the device supports VOIP calling and {@link
     33 android.net.sip.SipManager#isApiSupported isApiSupported()} to verify that the device supports the
     34 SIP APIs.<br/><br/>
     35 Your application must also request the {@link android.Manifest.permission#INTERNET} and {@link
     36 android.Manifest.permission#USE_SIP} permissions in order to use the SIP APIs.
     37 </p>
     38 </BODY>
     39 </HTML>