to top
Android APIs
public static class

SipAudioCall.Listener

extends Object
java.lang.Object
   ↳ android.net.sip.SipAudioCall.Listener

Class Overview

Listener for events relating to a SIP call, such as when a call is being recieved ("on ringing") or a call is outgoing ("on calling").

Many of these events are also received by SipSession.Listener.

Summary

Public Constructors

? Examples
SipAudioCall.Listener()
Public Methods

? Examples
void onCallBusy( SipAudioCall call)
Called when the peer is busy during session initialization.

? Examples
void onCallEnded( SipAudioCall call)
Called when the session is terminated.

? Examples
void onCallEstablished( SipAudioCall call)
Called when the session is established.

? Examples
void onCallHeld( SipAudioCall call)
Called when the call is on hold.

? Examples
void onCalling( SipAudioCall call)
Called when a request is sent out to initiate a new call.

? Examples
void onChanged( SipAudioCall call)
Called when an event occurs and the corresponding callback is not overridden.

? Examples
void onError( SipAudioCall call, int errorCode, String errorMessage)
Called when an error occurs.

? Examples
void onReadyToCall( SipAudioCall call)
Called when the call object is ready to make another call.

? Examples
void onRinging( SipAudioCall call, SipProfile caller)
Called when a new call comes in.

? Examples
void onRingingBack( SipAudioCall call)
Called when a RINGING response is received for the INVITE request sent.
[Expand]
Inherited Methods
From class java.lang.Object

Public Constructors

public SipAudioCall.Listener ()

Added in API level 9

Public Methods

public void onCallBusy (SipAudioCall call)

Added in API level 9

Called when the peer is busy during session initialization. The default implementation calls onChanged(SipAudioCall).

Parameters
call the call object that carries out the audio call

public void onCallEnded (SipAudioCall call)

Added in API level 9

Called when the session is terminated. The default implementation calls onChanged(SipAudioCall).

Parameters
call the call object that carries out the audio call

public void onCallEstablished (SipAudioCall call)

Added in API level 9

Called when the session is established. The default implementation calls onChanged(SipAudioCall).

Parameters
call the call object that carries out the audio call

public void onCallHeld (SipAudioCall call)

Added in API level 9

Called when the call is on hold. The default implementation calls onChanged(SipAudioCall).

Parameters
call the call object that carries out the audio call

public void onCalling (SipAudioCall call)

Added in API level 9

Called when a request is sent out to initiate a new call. The default implementation calls onChanged(SipAudioCall).

Parameters
call the call object that carries out the audio call

public void onChanged (SipAudioCall call)

Added in API level 9

Called when an event occurs and the corresponding callback is not overridden. The default implementation is no op. Error events are not re-directed to this callback and are handled in onError(SipAudioCall, int, String).

public void onError (SipAudioCall call, int errorCode, String errorMessage)

Added in API level 9

Called when an error occurs. The default implementation is no op.

Parameters
call the call object that carries out the audio call
errorCode error code of this error
errorMessage error message
See Also

public void onReadyToCall (SipAudioCall call)

Added in API level 9

Called when the call object is ready to make another call. The default implementation calls onChanged(SipAudioCall).

Parameters
call the call object that is ready to make another call

public void onRinging (SipAudioCall call, SipProfile caller)

Added in API level 9

Called when a new call comes in. The default implementation calls onChanged(SipAudioCall).

Parameters
call the call object that carries out the audio call
caller the SIP profile of the caller

public void onRingingBack (SipAudioCall call)

Added in API level 9

Called when a RINGING response is received for the INVITE request sent. The default implementation calls onChanged(SipAudioCall).

Parameters
call the call object that carries out the audio call
No examples for this method.
Frequently called with: [Clear]
Portions of this page are reproduced from work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. The original page is available here.