Prosody RTP processing: API: sm_vmprx_destroy

Prototype Definition

int sm_vmprx_destroy(tSMVMPrxId vmprx)

Parameters

vmprx
A tSMVMPrxId that has been prevously created by a call to sm_vmprx_create().

Description

Destroys vmprx and invalidates the tSMVMPrxId. Normally, a VMP[rx] will only be destroyed when it is in the stopped state. If the VMP[rx] is not in the stopped state, it will be implicitly stopped. It is an error to refer to a VMP[rx] once it has been destroyed.

If a call to sm_vmprx_create() completes successfully, sm_vmprx_stop() should be used to stop to the VMP[rx] and move it into the stopped state.

Returns

0 if call completed successfully, otherwise a standard error such as:


This function is part of the Prosody RTP processing API.