In response to commands executed by an application, the MSPP API generates events and reason codes that indicate the occurrence (or lack) of certain conditions or state changes. This section summarizes the events and reason codes generated by the MSPP API:
A DONE event is a NaturalAccess event informing the application that an asynchronous function has completed processing. DONE event codes are in the form MSPEVN_function_DONE where function is the completed function (CREATE_CHANNEL, DESTROY_CHANNEL). DONE events have no special physical or processing characteristics. They have the same physical structure and are retrieved identically to other events.
The following table alphabetically lists MSPP API events:
|
Event name |
Description |
|
MSPEVN_CONNECT_DONE |
Media channel is connected to endpoints. |
|
MSPEVN_CREATE_CHANNEL_DONE |
Media channel is created. |
|
MSPEVN_CREATE_ENDPOINT_DONE |
MSPP endpoint is created. |
|
MSPEVN_DESTROY_CHANNEL_DONE |
Specified media channel is destroyed. |
|
MSPEVN_DESTROY_ENDPOINT_DONE |
Specified endpoint is destroyed. |
|
MSPEVN_DISABLE_CHANNEL_DONE |
Data flow through specified channel is halted. |
|
MSPEVN_DISABLE_ENDPOINT_DONE |
Data flow between specified endpoints is halted. |
|
MSPEVN_RFC2833_REPORT |
Unsolicited event returned when an RTP FDX or RTP receive endpoint receives an inband RFC2833 packet. |
|
MSPEVN_DISCONNECT_DONE |
Media channel is disconnected from endpoints. |
|
MSPEVN_DPF_DTMF_PLAY_END |
Unsolicited event from voice decoder filter reporting that a DTMF tone was generated. |
|
MSPEVN_DPF_DTMF_REPORT |
Unsolicited event from voice encoder reporting that a DTMF tone was detected. |
|
MSPEVN_ENABLE_CHANNEL_DONE |
Data flow through specified channel is enabled. |
|
MSPEVN_ENABLE_ENDPOINT_DONE |
Data flow between connected MSPP endpoints is enabled. |
|
MSPEVN_FAXRELAY_FAX_BEGIN |
Unsolicited event. |
|
MSPEVN_FAXRELAY_FAX_END |
Unsolicited event generated by a T.38 fax relay channel filter to indicate the beginning of a T.38 fax session. |
|
MSPEVN_FAXRELAY_PASSED_PAGE |
Unsolicited event generated by a T.38 fax relay channel filter to indicate the beginning of a T.38 fax session. |
|
MSPEVN_ROUTE_AVAILABLE |
Unsolicited event indicating that an RTP or UDP session formerly incapable of transmitting data is now back in service. |
|
MSPEVN_NOROUTE_AVAILABLE |
Unsolicited event indicating that a RTP/UDP session has lost the ability to route outbound data to its destination. |
|
MSPEVN_QUERY_DONE |
The specified MSPP query was performed. |
|
MSPEVN_RTCP_BAD_REPORT |
Unsolicited event indicating that an RTP endpoint received a malformed RTCP report. |
|
MSPEVN_RTCP_REPORT |
Unsolicited event returning RTCP report information received through an RTP endpoint. |
|
MSPEVN_SENDCOMMAND_DONE |
The specified MSPP command was sent. |
|
MSPEVN_T38_PACKET_DETECTED |
Unsolicited event returned by a T38 UDP endpoint when it receives its first T.38 fax packet. |
The following table lists events in numerical order:
|
Hex |
Decimal |
Event name |
|
0x001B2001 |
1777665 |
MSPEVN_CREATE_ENDPOINT_DONE |
|
0x001B2002 |
1777666 |
MSPEVN_DESTROY_ENDPOINT_DONE |
|
0x001B2003 |
1777667 |
MSPEVN_ENABLE_ENDPOINT_DONE |
|
0x001B2004 |
1777668 |
MSPEVN_DISABLE_ENDPOINT_DONE |
|
0x001B2005 |
1777669 |
MSPEVN_CREATE_CHANNEL_DONE |
|
0x001B2006 |
1777670 |
MSPEVN_DESTROY_CHANNEL_DONE |
|
0x001B2007 |
1777671 |
MSPEVN_ENABLE_CHANNEL_DONE |
|
0x001B2008 |
1777672 |
MSPEVN_DISABLE_CHANNEL_DONE |
|
0x001B2009 |
1777673 |
MSPEVN_CONNECT_DONE |
|
0x001B200A |
1777674 |
MSPEVN_DISCONNECT_DONE |
|
0x001b2100 |
1777920 |
MSPEVN_SENDCOMMAND_DONE |
|
0x001B2200 |
1778176 |
MSPEVN_QUERY_DONE |
|
0x001B2300 |
1778432 |
MSPEVN_RTCP_REPORT |
|
0x001B2302 |
1778434 |
MSPEVN_T38_PACKET_DETECTED |
|
0x001B2303 |
1778435 |
MSPEVN_FAXRELAY_FAX_BEGIN |
|
0x001B2304 |
1778436 |
MSPEVN_FAXRELAY_FAX_END |
|
0x001B2305 |
1778437 |
MSPEVN_FAXRELAY_PASSED_PAGE |
|
0x001B2306 |
1778438 |
MSPEVN_RTCP_BAD_REPORT |
|
0x001B2307 |
1778439 |
MSPEVN_NOROUTE_AVAILABLE |
|
0x001B2308 |
1778440 |
MSPEVN_ROUTE_AVAILABLE |
|
0x001B2309 |
1778441 |
MSPEVN_DPF_DTMF_REPORT |
|
0x001B230A |
1778442 |
MSPEVN_RFC2833_REPORT |
|
0x001B230C |
1778444 |
MSPEVN_DPF_DTMF_PLAY_END |