Prosody RTP processing: API: sm_vmprx_config_codec_g728

Prototype Definition

int sm_vmprx_config_codec_g728(struct sm_vmprx_codec_g728_parms *codecp)

Parameters

*codecp
a structure of the following type:
typedef struct sm_vmprx_codec_g728_parms {
	tSMVMPrxId vmprx;					/* in */
	tSM_INT payload_type;					/* in */
	tSM_INT rate;						/* in */
	tSM_INT post_filter;					/* in */
	enum kSMPLCMode plc_mode;				/* in */
} SM_VMPRX_CODEC_G728_PARMS;

Description

Configures the VMP[rx] to use the G.728 codec, setting the payload type mapping to payload_type. This supersedes any previous mapping that was in effect for this codec.

If the call completes successfully, RTP packets arriving at the VMP[rx] with a payload type that matches the specified payload type will be decoded using this codec.

This requires the module g728 to have been downloaded.

Fields

vmprx
The VMP[rx] to which to add the 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.
rate
The decoding rate to use, in bits per second. G.728 supports three rates: 9600, 12800 and 16000.
post_filter
Configures whether or not to use a post-filter. It is used if this value is non-zero.
plc_mode
Enables or disables PLC (packet loss concealment) as appropriate for the codec. Note the codec implementation may not allow PLC to be disabled. One of these values:
kSMPLCModeDisabled
PLC Disabled
kSMPLCModeEnabled
PLC Enabled

Returns

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


This function is part of the Prosody RTP processing API.