Event states¶
The event states are listed in the table below.
If such event is received on client side, it may be processed in a corresponding object (Stream, Session, Call, etc).
Examples:
-
Handle success connection to WCS server
-
Handle success stream publishing to WCS server
| Event | Status field values | Description |
|---|---|---|
| ConnectionStatusEvent |
ESTABLISHED - Connection is establishedFAILED - Error while establishing connectionDISCONNECTED - Connection is lost
|
The status of establishing connection to the WCS server via Websocket |
| RegistrationStatusEvent |
REGISTERED - SIP account is registeredUNREGISTERED - SIP account is unregisteredAUTHENTICATION_FAIL - Authentication error
|
SIP registration status |
| CallStatusEvent |
TRYING - SIP returned TRYINGRING - SIP returned 183 RINGINGSESSION_PROGRESS - SIP returned 183 SESSION PROGRESSBUSY - SIP returned 486 or 600 BUSYESTABLISHED - SIP returned 200 OK to INVITE, call is establishedHOLD - SIP call is put on holdFINISH - SIP call is finishedFAILED - SIP call has failed or ended with an error
|
SIP call status |
| TransferStatusEvent |
ACCEPTED - SIP call transfer request is acceptedTRYING - An attempt to transfer the callCOMPLETED - Transfer is completedFAILED - Transfer has failed
|
Call transfer status |
| StreamStatusEvent |
PUBLISHING - Stream is publishingUNPUBLISHED - Publishing finishedPLAYING - Stream is playingSTOPPED - Playback is stoppedFAILED - Error while publishing or playing the stream
|
Stream status |
| StreamKeepAliveEvent |
PUBLISHING - Stream is publishingPLAYING - Stream is playing
|
Keep-alive of the stream |
| SessionDebugStatusEvent |
STARTED - Debug logs are enabledSTOPPED - Debug logs are disabled
|
Debug session status |
| DataStatusEvent |
ACCEPTED - Data are accepted for processingFAILED - An error occurred
|
Data sending status |