Click or drag to resize
CallState Enumeration
States of an arbitrary call object.

Namespace: Ozeki.VoIP
Assembly: OzekiSDK (in OzekiSDK.dll) Version: 1.8.12.0 (1.8.12)
Syntax
public enum CallState
Members
  Member nameValueDescription
Created0 The call object has been created.
Setup10 The call has been started. (The INVITE message has been sent.)
Error20 An error occured during the call. (eg. the remote party was not found, or no supported codecs found)
Ringing30 Ringing.
Queued40 The called party is temporarily unavailable, but the server has decided to queue the call rather than reject it.
RingingWithEarlyMedia50 Ringing with early media.
Forwarding60 Local call is forwarding.
Answered70 The call has been answered. This state occurs only once per call.
LocalHeld80 The local call party put the call on hold.
RemoteHeld90 The remote call party put the call on hold.
InactiveHeld100 Both parties put the call on hold.
Transferring110 Transferring the call to another client
InCall120 There is active communication between the two parties. The call can step into the InCall state multiple times (eg. InCall -> LocalHeld -> InCall)
Completed130 The call has been hung up by the caller or callee.
Rejected140 The call has been rejected by the callee.
Cancelled150 The call has been cancelled by the caller.
Busy160 The call has been rejected by the callee.
Forwarded170 The incoming call hase been forwarded.
Remarks
This is a partially ordered set. During the call process a call object can hold states of the CallState enum. When a call is created by the softphone it has the Setup state, if some negative answer comes from the callee, the states changes into SetupError. When everything goes fine, the state changes into Ringing. From Ringing it can enter InCall, Rejected or Cancelled states. If someone picks up the phone the call enters InCall state. InCall state just can changes into Completed state. From Ringing it also can change into Rejected or Cancelled state. The state is Rejected when the callee reject the call. The state is Cancelled if the caller changes his mind and hangs up the phone.
See Also