webphone
Class SIPNotification.Status

java.lang.Object
  extended by webphone.SIPNotification
      extended by webphone.SIPNotification.Status
Enclosing class:
SIPNotification
public static class SIPNotification.Status
extends SIPNotification

STATUS notification.
Triggered by: SIP session state chang, such as Init, Register, CallSetup, CallConnect, CallDisconnect, etc
You might receive multiple same or similar notifications for the same call state!
Event: SIPNotificationListener.onStatus
Fields: STATUS,line,statustext,peername,localname,endpointtype,peerdisplayname,[callid],online,registered,incall,mute,hold,encrypted,video,group, rtpsent,rtprec,rtploss,rtplosspercet,videohold,videosent,videorec,serverstats

Nested Class Summary
 
Nested classes/interfaces inherited from class webphone.SIPNotification
SIPNotification.Account, SIPNotification.AI, SIPNotification.Answer, SIPNotification.APIResult, SIPNotification.BLF, SIPNotification.Block, SIPNotification.CDR, SIPNotification.Chat, SIPNotification.ChatComposing, SIPNotification.ChatReport, SIPNotification.Credit, SIPNotification.DTMF, SIPNotification.Event, SIPNotification.Group, SIPNotification.INFO, SIPNotification.LicKey, SIPNotification.Line, SIPNotification.Log, SIPNotification.Media, SIPNotification.MWI, SIPNotification.NewContact, SIPNotification.PlayReady, SIPNotification.Popup, SIPNotification.Presence, SIPNotification.Rating, SIPNotification.Register, SIPNotification.RTPE, SIPNotification.RTPStat, SIPNotification.RTPT, SIPNotification.ServerContacts, SIPNotification.ShouldReset, SIPNotification.SIP, SIPNotification.SRS, SIPNotification.Start, SIPNotification.Status, SIPNotification.Stop, SIPNotification.USSD, SIPNotification.VAD, SIPNotification.Video, SIPNotification.Vrec
 
Field Summary
static int CALL_STATE_CONNECTED
          speaking
static int CALL_STATE_CONNECTING
          setup or ringing
static int CALL_STATE_NO
          not in call
static int CALL_STATE_UNKNOWN
          unknown
static int DIRECTION_IN
          incoming (server endpoint: or inbound sessions such as incoming calls when JVoIP acts as a UAS)
static int DIRECTION_OUT
          outgoing (client endpoint: sessions initiated by JVoIP such as outbound calls, where JVoIP acts as a UAC)
static int DIRECTION_UNKNOWN
          unknown
static int ENCRYPTION_STATE_NO
          not encrypted
static int ENCRYPTION_STATE_UNKNOWN
          unknown
static int ENCRYPTION_STATE_YES
          encrypted
static int ENCRYPTION_STATE_YES_STRONG
          encrypted (always strong)
static int ENCRYPTION_STATE_YES_WEAK
          encrypted (weak or partially)
static int HOLD_STATE_BOTH
          inactive (full hold)
static int HOLD_STATE_NO
          not in hold
static int HOLD_STATE_RECVONLY
          receiving only (no local recording)
static int HOLD_STATE_SENDONLY
          sending only (no local playback)
static int HOLD_STATE_UNKNOWN
          unknown
static int MUTE_STATE_BOTH
          all muted
static int MUTE_STATE_NO
          not muted
static int MUTE_STATE_PLAY
          playback muted
static int MUTE_STATE_REC
          recording muted
static int MUTE_STATE_UNKNOWN
          unknown
static int NETWORK_STATE_OFFLINE
          no network or internet connection
static int NETWORK_STATE_ONLINE
          connectivity detected
static int NETWORK_STATE_UNKNOWN
          unknown
static int REGISTER_STATE_FAILED
          failed.
static int REGISTER_STATE_MAX
           
static int REGISTER_STATE_NOTNEEDED
          no need to register (for example if the register parameter is set to 0 or no serveraddress/username/password was provided
static int REGISTER_STATE_UNKNOWN
          unknown
static int REGISTER_STATE_UNREGISTERED
          deregistered
static int REGISTER_STATE_WORKING_NO
          registration in progress.
static int REGISTER_STATE_WORKING_UNKNOWN
          registration in progress, unknown result.
static int REGISTER_STATE_WORKING_YES
          registration in progress.
static int REGISTER_STATE_YES
          registered
static int STATUS_CALL_CONNECT
          200 OK send or received.
static int STATUS_CALL_FINISHED
          200 OK or ACK send or received for the call disconnect request.
static int STATUS_CALL_FINISHING
          BYE or CANCEL send or received.
static int STATUS_CALL_HOLD
          call in hold.
static int STATUS_CALL_MIDCALL
          any other transactions during a call
static int STATUS_CALL_MUTE
          call in muted state.
static int STATUS_CALL_PROGRESS
          100 Trying received or sent
static int STATUS_CALL_RINGING
          180 Ringing sent or received
static int STATUS_CALL_SESSIONPROGRESS
          183 Session progress
static int STATUS_CALL_SETUP
          beginning of an incoming or outgoing call: INVITE send or received
static int STATUS_CALL_SPEAKING
          ACK for 200 OK send or received.
static int STATUS_DELETABLE
          Endpoint is marked to be destroyed.
static int STATUS_ERROR
          Unexpected state error.
static int STATUS_INITIALIZING
          SIP stack starting
static int STATUS_MESSAGE
          emitted by IM/chat/SMS endpoints
static int STATUS_NOTREADY
          not ready to initiate/accept calls
static int STATUS_OUTBAND
          notify/options/etc.
static int STATUS_READY
          ready to initiate/accept calls
static int STATUS_REGISTER
          emitted by register endpoints.
static int STATUS_REGISTERED
          server answered with 200 OK for the REGISTER request
static int STATUS_REGISTERFAILED
          register failed.
static int STATUS_SUBSCRIBE
          emitted by presence or voicemail subscribe/notify endpoints
static int STATUS_UNKNOWN
          default value, should never be sent
static int STATUS_UNREGISTER
          endpoint deregistered
static int VIDEO_STATE_INITIALIZED
          video call attempt
static int VIDEO_STATE_NO
          not a video call (audio only)
static int VIDEO_STATE_OFFERED
          video offer received from peer
static int VIDEO_STATE_RTPREADY
          video RTP stream constructed
static int VIDEO_STATE_STARTED
          player/recorder started
static int VIDEO_STATE_STREAMING
          video call in progress
static int VIDEO_STATE_UNKNOWN
          unknown
 
Fields inherited from class webphone.SIPNotification
NOTIFICATION_ACCOUNT, NOTIFICATION_AI, NOTIFICATION_ALL, NOTIFICATION_ANSWER, NOTIFICATION_APIRESULT, NOTIFICATION_BLF, NOTIFICATION_BLOCK, NOTIFICATION_CDR, NOTIFICATION_CHAT, NOTIFICATION_CHATCOMPOSING, NOTIFICATION_CHATREPORT, NOTIFICATION_CREDIT, NOTIFICATION_DTMF, NOTIFICATION_EVENT, NOTIFICATION_GROUP, NOTIFICATION_INFO, NOTIFICATION_INVALID, NOTIFICATION_LICKEY, NOTIFICATION_LINE, NOTIFICATION_LOG, NOTIFICATION_MEDIA, NOTIFICATION_MWI, NOTIFICATION_NEWUSER, NOTIFICATION_PLAYREADY, NOTIFICATION_POPUP, NOTIFICATION_PRESENCE, NOTIFICATION_RATING, NOTIFICATION_REGISTER, NOTIFICATION_RTPE, NOTIFICATION_RTPSTAT, NOTIFICATION_RTPT, NOTIFICATION_SERVERCONTACTS, NOTIFICATION_SHOULDRESET, NOTIFICATION_SIP, NOTIFICATION_SRS, NOTIFICATION_START, NOTIFICATION_STATUS, NOTIFICATION_STOP, NOTIFICATION_USSD, NOTIFICATION_VAD, NOTIFICATION_VIDEO, NOTIFICATION_VREC
 
Method Summary
 java.lang.String getCallID()
          SIP Call-ID (can be used as an unique identifier for this session)
 int getEncrypted()
          encryption state (ENCRYPTION_STATE_...
 java.lang.String getEncryptedText()
          hold state as string
 int getEndpointType()
          in or out: one of the DIRECTION_ constrains
 java.lang.String getEndpointTypeText()
          direction as string
 java.lang.String getGroup()
          group name if any: group string for group chat and conference calls (members separated by | )
 int getHold()
          is on hold state (HOLD_STATE_...
 java.lang.String getHoldText()
          hold state as string
 int getIncall()
          phone/line is in call (CALL_STATE_...
 java.lang.String getIncallText()
          call state as string
 int getLine()
          the line number for this state (or -1 for the global state)
 java.lang.String getLocalname()
          local user name (usually what you provided with the "username" parameter)
 int getMute()
          is muted state (MUTE_STATE_...
 java.lang.String getMuteText()
          mute state as string
 int getOnline()
          network status (NETWORK_STATE_...
 java.lang.String getOnlineText()
          network status as string
 java.lang.String getPeer()
          remote user name (the caller or the called party username)
 java.lang.String getPeerDisplayname()
          the other party display name if any
 int getRegistered()
          registration state (REGISTER_STATE_...
 java.lang.String getRegisteredText()
          registration status as string
 long getRtploss()
          number of lost RTP packets (only if endpoint is in call)
 int getRtplosspercent()
          percent of the lost RTP packets (only if endpoint is in call)
 long getRtprec()
          number of received RTP packets (only if endpoint is in call)
 long getRtpsent()
          number of sent RTP packets (only if endpoint is in call)
 java.lang.String getServerstats()
          RTP statistics received from the server, if any (only if endpoint is in call)
 int getStatus()
          the status as int (STATUS_...
 java.lang.String getStatusText()
          the status as string (for example: Init, Register, CallSetup, CallConnect, CallDisconnect)
 int getVideo()
          video state (VIDEO_STATE_...
 java.lang.String getVideodText()
          video state as string
 int getVideoHold()
          is video on hold state (HOLD_STATE_...
 java.lang.String getVideoHoldText()
          hold video state as string
 long getVideoRtprec()
          number of received video RTP packets (only if endpoint is in video call)
 long getVideoRtpsent()
          number of sent video RTP packets (only if endpoint is in video call)
 
Methods inherited from class webphone.SIPNotification
getNotificationType, getNotificationTypeText, toString
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

STATUS_UNKNOWN

public static final int STATUS_UNKNOWN
default value, should never be sent

See Also:
Constant Field Values

STATUS_NOTREADY

public static final int STATUS_NOTREADY
not ready to initiate/accept calls

See Also:
Constant Field Values

STATUS_INITIALIZING

public static final int STATUS_INITIALIZING
SIP stack starting

See Also:
Constant Field Values

STATUS_READY

public static final int STATUS_READY
ready to initiate/accept calls

See Also:
Constant Field Values

STATUS_OUTBAND

public static final int STATUS_OUTBAND
notify/options/etc. usually can be ignored

See Also:
Constant Field Values

STATUS_REGISTER

public static final int STATUS_REGISTER
emitted by register endpoints. you can use the IsRegistered,sRegisteredEx API or GetAccountRegState API to query the exact registration state

See Also:
Constant Field Values

STATUS_REGISTERED

public static final int STATUS_REGISTERED
server answered with 200 OK for the REGISTER request

See Also:
Constant Field Values

STATUS_REGISTERFAILED

public static final int STATUS_REGISTERFAILED
register failed. you can use the GetRegFailReason API to query the reason

See Also:
Constant Field Values

STATUS_UNREGISTER

public static final int STATUS_UNREGISTER
endpoint deregistered

See Also:
Constant Field Values

STATUS_SUBSCRIBE

public static final int STATUS_SUBSCRIBE
emitted by presence or voicemail subscribe/notify endpoints

See Also:
Constant Field Values

STATUS_MESSAGE

public static final int STATUS_MESSAGE
emitted by IM/chat/SMS endpoints

See Also:
Constant Field Values

STATUS_CALL_SETUP

public static final int STATUS_CALL_SETUP
beginning of an incoming or outgoing call: INVITE send or received

See Also:
Constant Field Values

STATUS_CALL_PROGRESS

public static final int STATUS_CALL_PROGRESS
100 Trying received or sent

See Also:
Constant Field Values

STATUS_CALL_SESSIONPROGRESS

public static final int STATUS_CALL_SESSIONPROGRESS
183 Session progress

See Also:
Constant Field Values

STATUS_CALL_RINGING

public static final int STATUS_CALL_RINGING
180 Ringing sent or received

See Also:
Constant Field Values

STATUS_CALL_CONNECT

public static final int STATUS_CALL_CONNECT
200 OK send or received. Call is (half) connected

See Also:
Constant Field Values

STATUS_CALL_SPEAKING

public static final int STATUS_CALL_SPEAKING
ACK for 200 OK send or received. Call is fully connected

See Also:
Constant Field Values

STATUS_CALL_MIDCALL

public static final int STATUS_CALL_MIDCALL
any other transactions during a call

See Also:
Constant Field Values

STATUS_CALL_MUTE

public static final int STATUS_CALL_MUTE
call in muted state. Use the getMute() function instead to check the mute state

See Also:
Constant Field Values

STATUS_CALL_HOLD

public static final int STATUS_CALL_HOLD
call in hold. Use the getHold() function instead to check the hold state

See Also:
Constant Field Values

STATUS_CALL_FINISHING

public static final int STATUS_CALL_FINISHING
BYE or CANCEL send or received. Call is (half) disconnected

See Also:
Constant Field Values

STATUS_CALL_FINISHED

public static final int STATUS_CALL_FINISHED
200 OK or ACK send or received for the call disconnect request. Call is fully disconnected

See Also:
Constant Field Values

STATUS_DELETABLE

public static final int STATUS_DELETABLE
Endpoint is marked to be destroyed. You can ignore this state

See Also:
Constant Field Values

STATUS_ERROR

public static final int STATUS_ERROR
Unexpected state error. This should never be never emitted

See Also:
Constant Field Values

DIRECTION_UNKNOWN

public static final int DIRECTION_UNKNOWN
unknown

See Also:
Constant Field Values

DIRECTION_OUT

public static final int DIRECTION_OUT
outgoing (client endpoint: sessions initiated by JVoIP such as outbound calls, where JVoIP acts as a UAC)

See Also:
Constant Field Values

DIRECTION_IN

public static final int DIRECTION_IN
incoming (server endpoint: or inbound sessions such as incoming calls when JVoIP acts as a UAS)

See Also:
Constant Field Values

NETWORK_STATE_UNKNOWN

public static final int NETWORK_STATE_UNKNOWN
unknown

See Also:
Constant Field Values

NETWORK_STATE_OFFLINE

public static final int NETWORK_STATE_OFFLINE
no network or internet connection

See Also:
Constant Field Values

NETWORK_STATE_ONLINE

public static final int NETWORK_STATE_ONLINE
connectivity detected

See Also:
Constant Field Values

REGISTER_STATE_UNKNOWN

public static final int REGISTER_STATE_UNKNOWN
unknown

See Also:
Constant Field Values

REGISTER_STATE_NOTNEEDED

public static final int REGISTER_STATE_NOTNEEDED
no need to register (for example if the register parameter is set to 0 or no serveraddress/username/password was provided

See Also:
Constant Field Values

REGISTER_STATE_YES

public static final int REGISTER_STATE_YES
registered

See Also:
Constant Field Values

REGISTER_STATE_WORKING_YES

public static final int REGISTER_STATE_WORKING_YES
registration in progress. probably will succeeed, treat it as registered. you might use the IsRegistered,sRegisteredEx API or GetAccountRegState API to query the exact registration state

See Also:
Constant Field Values

REGISTER_STATE_WORKING_UNKNOWN

public static final int REGISTER_STATE_WORKING_UNKNOWN
registration in progress, unknown result. you might use the IsRegistered,sRegisteredEx API or GetAccountRegState API to query the exact registration state

See Also:
Constant Field Values

REGISTER_STATE_WORKING_NO

public static final int REGISTER_STATE_WORKING_NO
registration in progress. probably will fail, treat it as unregistered. you might use the IsRegistered,sRegisteredEx API or GetAccountRegState API to query the exact registration state

See Also:
Constant Field Values

REGISTER_STATE_UNREGISTERED

public static final int REGISTER_STATE_UNREGISTERED
deregistered

See Also:
Constant Field Values

REGISTER_STATE_FAILED

public static final int REGISTER_STATE_FAILED
failed. you can use the GetRegFailReason API to query the reason

See Also:
Constant Field Values

REGISTER_STATE_MAX

public static final int REGISTER_STATE_MAX
See Also:
Constant Field Values

CALL_STATE_UNKNOWN

public static final int CALL_STATE_UNKNOWN
unknown

See Also:
Constant Field Values

CALL_STATE_NO

public static final int CALL_STATE_NO
not in call

See Also:
Constant Field Values

CALL_STATE_CONNECTING

public static final int CALL_STATE_CONNECTING
setup or ringing

See Also:
Constant Field Values

CALL_STATE_CONNECTED

public static final int CALL_STATE_CONNECTED
speaking

See Also:
Constant Field Values

MUTE_STATE_NO

public static final int MUTE_STATE_NO
not muted

See Also:
Constant Field Values

MUTE_STATE_UNKNOWN

public static final int MUTE_STATE_UNKNOWN
unknown

See Also:
Constant Field Values

MUTE_STATE_PLAY

public static final int MUTE_STATE_PLAY
playback muted

See Also:
Constant Field Values

MUTE_STATE_REC

public static final int MUTE_STATE_REC
recording muted

See Also:
Constant Field Values

MUTE_STATE_BOTH

public static final int MUTE_STATE_BOTH
all muted

See Also:
Constant Field Values

HOLD_STATE_NO

public static final int HOLD_STATE_NO
not in hold

See Also:
Constant Field Values

HOLD_STATE_UNKNOWN

public static final int HOLD_STATE_UNKNOWN
unknown

See Also:
Constant Field Values

HOLD_STATE_SENDONLY

public static final int HOLD_STATE_SENDONLY
sending only (no local playback)

See Also:
Constant Field Values

HOLD_STATE_RECVONLY

public static final int HOLD_STATE_RECVONLY
receiving only (no local recording)

See Also:
Constant Field Values

HOLD_STATE_BOTH

public static final int HOLD_STATE_BOTH
inactive (full hold)

See Also:
Constant Field Values

ENCRYPTION_STATE_UNKNOWN

public static final int ENCRYPTION_STATE_UNKNOWN
unknown

See Also:
Constant Field Values

ENCRYPTION_STATE_NO

public static final int ENCRYPTION_STATE_NO
not encrypted

See Also:
Constant Field Values

ENCRYPTION_STATE_YES_WEAK

public static final int ENCRYPTION_STATE_YES_WEAK
encrypted (weak or partially)

See Also:
Constant Field Values

ENCRYPTION_STATE_YES

public static final int ENCRYPTION_STATE_YES
encrypted

See Also:
Constant Field Values

ENCRYPTION_STATE_YES_STRONG

public static final int ENCRYPTION_STATE_YES_STRONG
encrypted (always strong)

See Also:
Constant Field Values

VIDEO_STATE_UNKNOWN

public static final int VIDEO_STATE_UNKNOWN
unknown

See Also:
Constant Field Values

VIDEO_STATE_NO

public static final int VIDEO_STATE_NO
not a video call (audio only)

See Also:
Constant Field Values

VIDEO_STATE_INITIALIZED

public static final int VIDEO_STATE_INITIALIZED
video call attempt

See Also:
Constant Field Values

VIDEO_STATE_OFFERED

public static final int VIDEO_STATE_OFFERED
video offer received from peer

See Also:
Constant Field Values

VIDEO_STATE_RTPREADY

public static final int VIDEO_STATE_RTPREADY
video RTP stream constructed

See Also:
Constant Field Values

VIDEO_STATE_STARTED

public static final int VIDEO_STATE_STARTED
player/recorder started

See Also:
Constant Field Values

VIDEO_STATE_STREAMING

public static final int VIDEO_STATE_STREAMING
video call in progress

See Also:
Constant Field Values
Method Detail

getLine

public int getLine()
the line number for this state (or -1 for the global state)

getStatusText

public java.lang.String getStatusText()
the status as string (for example: Init, Register, CallSetup, CallConnect, CallDisconnect)

getStatus

public int getStatus()
the status as int (STATUS_... constant)

getPeer

public java.lang.String getPeer()
remote user name (the caller or the called party username)

getLocalname

public java.lang.String getLocalname()
local user name (usually what you provided with the "username" parameter)

getEndpointType

public int getEndpointType()
in or out: one of the DIRECTION_ constrains

getPeerDisplayname

public java.lang.String getPeerDisplayname()
the other party display name if any

getCallID

public java.lang.String getCallID()
SIP Call-ID (can be used as an unique identifier for this session)

getOnline

public int getOnline()
network status (NETWORK_STATE_... constant)

getRegistered

public int getRegistered()
registration state (REGISTER_STATE_... constant)

getIncall

public int getIncall()
phone/line is in call (CALL_STATE_... constant)

getMute

public int getMute()
is muted state (MUTE_STATE_... constant)

getHold

public int getHold()
is on hold state (HOLD_STATE_... constant)

getEncrypted

public int getEncrypted()
encryption state (ENCRYPTION_STATE_... constant)

getVideo

public int getVideo()
video state (VIDEO_STATE_... constant)

getGroup

public java.lang.String getGroup()
group name if any: group string for group chat and conference calls (members separated by | )

getRtpsent

public long getRtpsent()
number of sent RTP packets (only if endpoint is in call)

getRtprec

public long getRtprec()
number of received RTP packets (only if endpoint is in call)

getRtploss

public long getRtploss()
number of lost RTP packets (only if endpoint is in call)

getRtplosspercent

public int getRtplosspercent()
percent of the lost RTP packets (only if endpoint is in call)

getVideoHold

public int getVideoHold()
is video on hold state (HOLD_STATE_... constant)

getVideoRtpsent

public long getVideoRtpsent()
number of sent video RTP packets (only if endpoint is in video call)

getVideoRtprec

public long getVideoRtprec()
number of received video RTP packets (only if endpoint is in video call)

getServerstats

public java.lang.String getServerstats()
RTP statistics received from the server, if any (only if endpoint is in call)

getEndpointTypeText

public java.lang.String getEndpointTypeText()
direction as string

getOnlineText

public java.lang.String getOnlineText()
network status as string

getRegisteredText

public java.lang.String getRegisteredText()
registration status as string

getIncallText

public java.lang.String getIncallText()
call state as string

getMuteText

public java.lang.String getMuteText()
mute state as string

getHoldText

public java.lang.String getHoldText()
hold state as string

getEncryptedText

public java.lang.String getEncryptedText()
hold state as string

getVideodText

public java.lang.String getVideodText()
video state as string

getVideoHoldText

public java.lang.String getVideoHoldText()
hold video state as string