Added in API level 9
Deprecated in API level 31

SipSession.Listener


public static class SipSession.Listener
extends Object

java.lang.Object
   ↳ android.net.sip.SipSession.Listener


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

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

Summary

Public constructors

Listener()

Public methods

void onCallBusy(SipSession session)

Called when the peer is busy during session initialization.

void onCallChangeFailed(SipSession session, int errorCode, String errorMessage)

Called when an error occurs during session modification negotiation.

void onCallEnded(SipSession session)

Called when the session is terminated.

void onCallEstablished(SipSession session, String sessionDescription)

Called when the session is established.

void onCalling(SipSession session)

Called when an INVITE request is sent to initiate a new call.

void onError(SipSession session, int errorCode, String errorMessage)

Called when an error occurs during session initialization and termination.

void onRegistering(SipSession session)

Called when a registration request is sent.

void onRegistrationDone(SipSession session, int duration)

Called when registration is successfully done.

void onRegistrationFailed(SipSession session, int errorCode, String errorMessage)

Called when the registration fails.

void onRegistrationTimeout(SipSession session)

Called when the registration gets timed out.

void onRinging(SipSession session, SipProfile caller, String sessionDescription)

Called when an INVITE request is received.

void onRingingBack(SipSession session)

Called when a RINGING response is received for the INVITE request sent

Inherited methods

Public constructors

Listener

public Listener ()

Public methods

onCallBusy

Added in API level 9
public void onCallBusy (SipSession session)

Called when the peer is busy during session initialization.

Parameters
session SipSession: the session object that carries out the transaction

onCallChangeFailed

Added in API level 9
public void onCallChangeFailed (SipSession session, 
                int errorCode, 
                String errorMessage)

Called when an error occurs during session modification negotiation.

Parameters
session SipSession: the session object that carries out the transaction

errorCode int: error code defined in SipErrorCode

errorMessage String: error message

onCallEnded

Added in API level 9
public void onCallEnded (SipSession session)

Called when the session is terminated.

Parameters
session SipSession: the session object that is associated with the dialog

onCallEstablished

Added in API level 9
public void onCallEstablished (SipSession session, 
                String sessionDescription)

Called when the session is established.

Parameters
session SipSession: the session object that is associated with the dialog

sessionDescription String: the peer's session description

onCalling

Added in API level 9
public void onCalling (SipSession session)

Called when an INVITE request is sent to initiate a new call.

Parameters
session SipSession: the session object that carries out the transaction

onError

Added in API level 9
public void onError (SipSession session, 
                int errorCode, 
                String errorMessage)

Called when an error occurs during session initialization and termination.

Parameters
session SipSession: the session object that carries out the transaction

errorCode int: error code defined in SipErrorCode

errorMessage String: error message

onRegistering

Added in API level 9
public void onRegistering (SipSession session)

Called when a registration request is sent.

Parameters
session SipSession: the session object that carries out the transaction

onRegistrationDone

Added in API level 9
public void onRegistrationDone (SipSession session, 
                int duration)

Called when registration is successfully done.

Parameters
session SipSession: the session object that carries out the transaction

duration int: duration in second before the registration expires

onRegistrationFailed

Added in API level 9
public void onRegistrationFailed (SipSession session, 
                int errorCode, 
                String errorMessage)

Called when the registration fails.

Parameters
session SipSession: the session object that carries out the transaction

errorCode int: error code defined in SipErrorCode

errorMessage String: error message

onRegistrationTimeout

Added in API level 9
public void onRegistrationTimeout (SipSession session)

Called when the registration gets timed out.

Parameters
session SipSession: the session object that carries out the transaction

onRinging

Added in API level 9
public void onRinging (SipSession session, 
                SipProfile caller, 
                String sessionDescription)

Called when an INVITE request is received.

Parameters
session SipSession: the session object that carries out the transaction

caller SipProfile: the SIP profile of the caller

sessionDescription String: the caller's session description

onRingingBack

Added in API level 9
public void onRingingBack (SipSession session)

Called when a RINGING response is received for the INVITE request sent

Parameters
session SipSession: the session object that carries out the transaction