SipAudioCall.Listener
public
static
class
SipAudioCall.Listener
extends Object
java.lang.Object | |
↳ | android.net.sip.SipAudioCall.Listener |
Listener for events relating to a SIP call, such as when a call is being received ("on ringing") or a call is outgoing ("on calling").
Many of these events are also received by SipSession.Listener
.
Summary
Public constructors | |
---|---|
Listener()
|
Public methods | |
---|---|
void
|
onCallBusy(SipAudioCall call)
Called when the peer is busy during session initialization. |
void
|
onCallEnded(SipAudioCall call)
Called when the session is terminated. |
void
|
onCallEstablished(SipAudioCall call)
Called when the session is established. |
void
|
onCallHeld(SipAudioCall call)
Called when the call is on hold. |
void
|
onCalling(SipAudioCall call)
Called when a request is sent out to initiate a new call. |
void
|
onChanged(SipAudioCall call)
Called when an event occurs and the corresponding callback is not overridden. |
void
|
onError(SipAudioCall call, int errorCode, String errorMessage)
Called when an error occurs. |
void
|
onReadyToCall(SipAudioCall call)
Called when the call object is ready to make another call. |
void
|
onRinging(SipAudioCall call, SipProfile caller)
Called when a new call comes in. |
void
|
onRingingBack(SipAudioCall call)
Called when a RINGING response is received for the INVITE request sent. |
Inherited methods | |
---|---|
Public constructors
Listener
public Listener ()
Public methods
onCallBusy
public void onCallBusy (SipAudioCall call)
Called when the peer is busy during session initialization.
The default implementation calls onChanged(SipAudioCall)
.
Parameters | |
---|---|
call |
SipAudioCall : the call object that carries out the audio call |
onCallEnded
public void onCallEnded (SipAudioCall call)
Called when the session is terminated.
The default implementation calls onChanged(SipAudioCall)
.
Parameters | |
---|---|
call |
SipAudioCall : the call object that carries out the audio call |
onCallEstablished
public void onCallEstablished (SipAudioCall call)
Called when the session is established.
The default implementation calls onChanged(SipAudioCall)
.
Parameters | |
---|---|
call |
SipAudioCall : the call object that carries out the audio call |
onCallHeld
public void onCallHeld (SipAudioCall call)
Called when the call is on hold.
The default implementation calls onChanged(SipAudioCall)
.
Parameters | |
---|---|
call |
SipAudioCall : the call object that carries out the audio call |
onCalling
public void onCalling (SipAudioCall call)
Called when a request is sent out to initiate a new call.
The default implementation calls onChanged(SipAudioCall)
.
Parameters | |
---|---|
call |
SipAudioCall : the call object that carries out the audio call |
onChanged
public void onChanged (SipAudioCall call)
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)
.
Parameters | |
---|---|
call |
SipAudioCall |
onError
public void onError (SipAudioCall call, int errorCode, String errorMessage)
Called when an error occurs. The default implementation is no op.
Parameters | |
---|---|
call |
SipAudioCall : the call object that carries out the audio call |
errorCode |
int : error code of this error |
errorMessage |
String : error message |
See also:
onReadyToCall
public void onReadyToCall (SipAudioCall call)
Called when the call object is ready to make another call.
The default implementation calls onChanged(SipAudioCall)
.
Parameters | |
---|---|
call |
SipAudioCall : the call object that is ready to make another call |
onRinging
public void onRinging (SipAudioCall call, SipProfile caller)
Called when a new call comes in.
The default implementation calls onChanged(SipAudioCall)
.
Parameters | |
---|---|
call |
SipAudioCall : the call object that carries out the audio call |
caller |
SipProfile : the SIP profile of the caller |
onRingingBack
public void onRingingBack (SipAudioCall call)
Called when a RINGING response is received for the INVITE request
sent. The default implementation calls onChanged(SipAudioCall)
.
Parameters | |
---|---|
call |
SipAudioCall : the call object that carries out the audio call |