Prosody RTP processing: API: sm_vmprx_stop

Prototype Definition

int sm_vmprx_stop(struct sm_vmprx_stop_parms *stopp)

Parameters

*stopp
a structure of the following type:
typedef struct sm_vmprx_stop_parms {
	tSMVMPrxId vmprx;					/* in */
} SM_VMPRX_STOP_PARMS;

Description

Requests that a VMP[rx] stops executing. The user will be notified that a VMP[rx] has terminated by a final status, kSMVMPrxStatusStopped, from sm_vmprx_status(). Once the stopped status notification has been received the VMP[rx] can be destroyed using sm_vmprx_destroy().

Once the VMP[rx] has stopped the event should no longer be used to wait for status notifications as it will be signalled permanently. The event is invalidated when sm_vmprx_destroy() is called.

Fields

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

Returns

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


This function is part of the Prosody RTP processing API.