Prosody RTP processing: API: sm_vmptx_generate_tones_abort

Prototype Definition

int sm_vmptx_generate_tones_abort(struct sm_vmptx_generate_tones_abort_parms *tonep)

Parameters

*tonep
a structure of the following type: 
typedef struct sm_vmptx_generate_tones_abort_parms {
	tSMVMPtxId vmptx;					/* in */
} SM_VMPTX_GENERATE_TONES_ABORT_PARMS;

Description

Causes a VMP[tx] to abort generate rfc2833 tone packets, discarding the current tone and any still pending.

Fields

vmptx
The VMP[tx] that is to generating tones

Returns

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

This function is part of the Prosody RTP processing API.