Prosody RTP processing: API: sm_vmptx_generate_jitter

This function is under development. It could be changed or withdrawn, and may not be implemented in this release.

Prototype Definition

int sm_vmptx_generate_jitter(struct sm_vmptx_generate_jitter_parms *jitterp)

Parameters

*jitterp
a structure of the following type: 
typedef struct sm_vmptx_generate_jitter_parms {
	tSMVMPtxId vmptx;					/* in */
	tSM_INT external_jitter_threshold;			/* in */
	tSM_INT inter_jitter_gap;				/* in */
	tSM_INT added_jitter;					/* in */
	tSM_INT max_packet_age;					/* in */
} SM_VMPTX_GENERATE_JITTER_PARMS;

Description

Configures a VMP[tx] to add jitter to the outgoing RTP stream by occasionally buffering packets.

This requires the module vmptx to have been downloaded.

Fields

vmptx (Only in Preliminary Documentation)
The VMP[tx] to generate jitter.
external_jitter_threshold (Only in Preliminary Documentation)
The time between VMP[tx] execution that is considered to indicate that epochs have been delayed due to external conditions. Note that the normal time between VMP[tx] execution can be up to 20ms, so values larger than this should be used. A value of 0 disables the addition of jitter.
inter_jitter_gap (Only in Preliminary Documentation)
The time that must elapse after a jitter burst before the buffering starts again.
added_jitter (Only in Preliminary Documentation)
The duration of buffering used to add jitter.
max_packet_age (Only in Preliminary Documentation)
The maximum age of packets that are transmitted. A value of 0 will allow all packets to be sent, regardless of their age.

Returns

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

This function is part of the Prosody RTP processing API.