Prosody RTP processing: API: sm_vmptx_stop

Prototype Definition

int sm_vmptx_stop(struct sm_vmptx_stop_parms *stopp)

Parameters

*stopp
a structure of the following type:
typedef struct sm_vmptx_stop_parms {
	tSMVMPtxId vmptx;					/* in */
} SM_VMPTX_STOP_PARMS;

Description

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

Once the VMP[tx] 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_vmptx_destroy() is called.

Fields

vmptx
A tSMVMPtxId that has been previously created by a call to sm_vmptx_create().

Returns

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


This function is part of the Prosody RTP processing API.