Call |
States of an arbitrary call object.
Namespace: Ozeki.VoIP
Assembly: OzekiSDK (in OzekiSDK.dll) Version: 10.4.98
SyntaxMembers| Member name | Value | Description |
|---|---|---|
| Created | 0 | The call object has been created. |
| Setup | 10 | The call has been started. (The INVITE message has been sent.) |
| Error | 20 | An error occured during the call. (eg. the remote party was not found, or no supported codecs found) |
| Ringing | 30 | Ringing. |
| Queued | 40 | The called party is temporarily unavailable, but the server has decided to queue the call rather than reject it. |
| RingingWithEarlyMedia | 50 | Ringing with early media. |
| Forwarding | 60 | Local call is forwarding. |
| Answered | 70 | The call has been answered. This state occurs only once per call. |
| LocalHeld | 80 | The local call party put the call on hold. |
| RemoteHeld | 90 | The remote call party put the call on hold. |
| InactiveHeld | 100 | Both parties put the call on hold. |
| Transferring | 110 | Transferring the call to another client |
| InCall | 120 | There is active communication between the two parties. The call can step into the InCall state multiple times (eg. InCall -> LocalHeld -> InCall) |
| Completed | 130 | The call has been hung up by the caller or callee. |
| Rejected | 140 | The call has been rejected by the callee. |
| Cancelled | 150 | The call has been cancelled by the caller. |
| Busy | 160 | The call has been rejected by the callee. |
| Forwarded | 170 | The incoming call hase been forwarded. |
The CallState type exposes the following members.
Extension Methods| Name | Description | |
|---|---|---|
 | IsCallEnded |
The call has been ended.
(Defined by CallStateEx) |
| IsHeld |
The call has been held by one of the party members.
(Defined by CallStateEx) |
| IsInCall |
Returns a boolean value that indicates whether the communication is active between the call party members.
(Defined by CallStateEx) |
| IsInSetupCall |
Returns a boolean value that indicates whether the call has been started, but the callee sent no response yet.
(Defined by CallStateEx) |
| IsMediaCommunication |
Returns a boolean value indicating whether media can be sent to the remote party.
(Defined by CallStateEx) |
| IsPendingCall | (Defined by CallStateEx) |
| IsRemoteMediaCommunication |
Returns a boolean value indicating whether the remote party could send media data.
(Defined by CallStateEx) |
| IsRinging |
Returns a boolean value that indicates whether the callee was contacted successfully but the call has not been answered yet.
(Defined by CallStateEx) |
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