Prosody RTP processing: API: sm_vmptx_config_codec_g723_1

Prototype Definition

int sm_vmptx_config_codec_g723_1(struct sm_vmptx_codec_g723_1_parms *codecp)

Parameters

*codecp
a structure of the following type: 
typedef struct sm_vmptx_codec_g723_1_parms {
	tSMVMPtxId vmptx;					/* in */
	tSM_INT payload_type;					/* in */
	tSM_INT high_pass_filter;				/* in */
	tSM_INT rate;						/* in */
	tSM_INT silence_compression;				/* in */
	tSM_INT frames_per_packet;				/* in */
} SM_VMPTX_CODEC_G723_1_PARMS;

Description

Configures a VMP[tx] to use G.723.1 for encoding data.

This requires the module g7231a to have been downloaded.

Fields

vmptx
The VMP[tx] to which to add this codec
payload_type
The payload type identifer to use with this codec (see IETF RFC 3550 section 13). Supplying a value of -1 will remove any payload type configuration from the codec preventing its use.
high_pass_filter
Selects whether or not a high-pass filter is used on the data to be encoded. A filter is used if this value is non-zero.
rate
The encoding rate to use, in bits per second. G.723.1 supports two rates: 6300 and 5300.
silence_compression
Selects whether or not Annex A silence compression is to be used. It is used if this value is non-zero.
frames_per_packet
The number of frames to send per packet. This value is normally one, which encodes 30 milliseconds per packet, but larger values can be used, reducing the packet overhead at the expense of extra delay.

Returns

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

This function is part of the Prosody RTP processing API.