# function onVoipEvent(function listener)

# Features Description

Listen to VoIP call-related events. Event binding needs to be completed before the call starts .

Note: Do not bind events within the lifecycle such as onLoad, onShow, etc. It may be repeated because the lifecycle calls are repeated.

# parameter

# function listener

Event listening function

# callback parameters

# Object event

# Return value

function

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

# Description of the event

# 1. startVoip

The call began.

# 2. abortVoip

The call was abruptly interrupted.

data parameter

Value of status

Common errMsg

• Room status is abort: status = unknown, triggered when receiving an exception to the end of the call, need to determine the real reason for the exception according to the abortVoip event triggered by the roomId.
• listener waitOtherToJoin timeout：status=abortByListener，After the receiving party joins the room, the dialing party has not been successfully joined (may be due to slow network) or abnormally quit, the receiving party waits for 20s to trigger after timeout. At this point, it is recommended to analyze the receiver's situation to detect it.
• Call interrupted due to close passive float ball: After the user cuts Weixin Mini Program to the background, the Mini Program float window will be displayed, which is triggered when the user closes the Mini Program through the float window.
• In comming call: Weixin Mini Program Triggered when the call is interrupted by another caller.
• Call interrupted due to native reason: Generally due to a period of time during the call did not receive digital packet (usually network reasons), was kicked out of the room interrupted call.

# 3. hangOnVoip

The call is answered (triggered only by the receiver).

# 4. cancelVoip

The call was not connected and the caller canceled the call.

data parameter

Value of status

# 5. rejectVoip

The call went unanswered and the receiver refused to answer.

data parameter

Value of status

# 6. hangUpVoip

The call is connected and the caller / receiver hangs up.

data parameter

Value of status

Origin value

To maintain backward compatibility, the hangUpVoip event additionally uses the origin field to provide specific information about the reason for the hang up.

# 7. endVoip

The call is over.

data parameter

# 8. busy

The call was not connected and the receiver occupied the line (triggered only by the caller).

# 9. calling

During the call, both parties trigger it every second.

data parameter

# 10. timeout

The call went unanswered over time.

# 11. joinedRoomByCaller

The caller joined the room successfully (triggered only by the caller).

# 12. joinFailCaller

The caller failed to join the room (triggered only by the caller).

data parameter

# 13. joinFailListener

The receiver failed to join the room (triggered only by the receiver).

data parameter

# 14. finishVoip

The call was completed. Return the actual amount of time used in the settlement of this call.

It needs to be triggered after getting the final time from the background, and the trigger time is later than endVoip.

data parameter

# 15. callPageOnShow

Plugin call page onShow.

# 16. showCustomBox

The user clicks the call page custom button to display the custom components.

data parameter

# 17. hideCustomBox

The user hides the custom components.

data parameter

# sample code

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

// Calls need to be invoked when listening is cancelled
offVoipEvent()