# function onVoipEvent(function listener)

# Function description

to monitor VoIP Call related events.Event binding needs to be completed before the call starts。

Note: Do not use the onLoad、onShow Such as binding events in the life cycle, may be repeated because of multiple calls in the life cycle.

# parameter

# function listener

Event listener function

# Callback parameter

# Object event

# Return value

function

Cancels the listening function, cancels the event after the function call. This function has no parameters and no return value.

# Description of events

# 1. startVoip

Call started.

# 2. AbortVoip

Unusual interruption.

Data parameter

status Value

common errMsg

• room status is abort: status = unknown, triggered when receiving an exception to the end call, which needs to be based on roomId Associated pair triggered AbortVoip Event to determine the true cause of the anomaly.
• listener waitOtherToJoin timeout: status = abortByListener, after the receiver joins the room, the caller has not been successfully joined (may be due to slow network and other reasons) or abnormal exit, the receiver waits 20s Triggered after a timeout. At this time, it is recommended to analyze the situation of the receiving party to investigate.
• call interrupted due to close passive float ball: After the user cuts the Mini Program into the background, the Mini Program floating window will be displayed, and the user will trigger the Mini Program by closing the floating window.
• in comming call: Triggered when the Mini Program call is interrupted by another call.
• call interrupted due to native reason: Usually due to a period of time during the call did not receive a packet (usually for network reasons), was kicked out of the room to interrupt the call.

# 3. hangOnVoip

The call is answered (only the receiver fires).

# 4. cancelVoip

The call is not connected, the caller cancels the call.

Data parameter

status Value

# 5. rejectVoip

The call is not connected and the receiver refuses to answer.

Data parameter

status Value

# 6. HangUpVoip

The call is connected, the dialing party/The receiver hangs up.

Data parameter

status Value

origin Value

To maintain backward compatibility, hangUpVoip Event Additional Use origin Field provides specific information about the reason for the hang up.

# 7. endVoip

Over and out.

Data parameter

# 8. busy

The call is not connected, the receiving party is busy (only the dialing party is triggered).

# 9. calling

During the call, Both sides trigger once a second.

Data parameter

# 10. timeout

The call timed out.

# 11. joinedRoomByCaller

The caller joined the room successfully (only the caller triggers).

# 12. joinFailCaller

The caller failed to join the room (only the caller triggers).

Data parameter

# 13. joinFailListener

The listener failed to join the room (only the listener fires).

Data parameter

# 14. finishVoip

Call complete. Returns the actual length of time used to settle this call.

Need to get the final time from the background to trigger, the trigger time is later than endVoip.

Data parameter

# 15. callPageOnShow

Plugin Call Page onShow。

# 16. showCustomBox

Users click the call page custom button to display custom components.

Data parameter

# 17. hideCustomBox

Users hide custom components.

Data parameter

# sample code

const wmpfVoip = requirePlugin('wmpf-voip' ).default
const offVoipEvent = wmpfVoip.onVoipEvent(event => {
  console.info(`onVoipEvent`, event)
})

// Call when you need to unlisten
offVoipEvent()