Prosody RTP processing: API: sm_vmprx_config_codec_speex_mode

Prototype Definition

int sm_vmprx_config_codec_speex_mode(struct sm_vmprx_codec_speex_mode_parms *codecp)

Parameters

a structure of the following type:

typedef struct sm_vmprx_codec_speex_mode_parms {
	tSMVMPrxId vmprx;					/* in */
	tSM_UT32 enh;						/* in */
} SM_VMPRX_CODEC_SPEEX_MODE_PARMS;

Description

Configures the VMP[rx] to use Speex for encoding data, as defined in IETF RFC 5574.

This function requires the module speex_vmp to have been downloaded, and may be called at any time after the corresponding call to sm_vmprx_config_codec_speex.

Fields

vmprx: The VMP[rx] to which to add this codec
enh: Enhanced output enabled (1) or disabled (0). Controls whether the perceived quality of the output is to be artificially enhanced, at the cost of a slightly reduced channel count. Default: 0. Recommended value (unless channel count is critical): 1.

Returns

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

ERR_SM_DEVERR - device error

This function is part of the Prosody RTP processing API.