Prosody RTP processing: API: sm_vmprx_config_codec_gsmefr

Prototype Definition

int sm_vmprx_config_codec_gsmefr(struct sm_vmprx_codec_gsmefr_parms *codecp)

Parameters

*codecp
a structure of the following type: 
typedef struct sm_vmprx_codec_gsmefr_parms {
	tSMVMPrxId vmprx;					/* in */
	tSM_INT payload_type;					/* in */
	enum kSMPLCMode plc_mode;				/* in */
} SM_VMPRX_CODEC_GSMEFR_PARMS;

Description

Configures the VMP[rx] to use the GSM-EFR 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.

Note that this function is for use with the lightweight gsm-efr module only. Where full AMR-NB support is also required, please use sm_vmprx_config_codec_amrnb() with parameter gsmefr=1 and the module amr-nb or amr-nb-all instead.

This requires the module gsm-efr 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.
plc_mode
Configures packet loss concealment for this 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.