Prosody RTP processing: API: sm_vmprx_config_codec_amrwb

Prototype Definition

int sm_vmprx_config_codec_amrwb(struct sm_vmprx_codec_amrwb_parms *codecp)

Parameters

*codecp
a structure of the following type: 
typedef struct sm_vmprx_codec_amrwb_parms {
	tSMVMPrxId vmprx;					/* in */
	tSM_INT payload_type;					/* in */
	tSM_INT aligned;					/* in */
	enum kSMPLCMode plc_mode;				/* in */
	tSM_INT report_cmr;					/* in */
} SM_VMPRX_CODEC_AMRWB_PARMS;

Description

Configures the VMP[rx] to use the AMR wide-band 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 amr-wb 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.
aligned
Packet alignment (bandwidth efficient mode). 0 if packet is not aligned, otherwise packet is aligned.
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
report_cmr
Enables or disables the notification of CMR changes. If non-zero, then CMR changes will be reported via sm_vmprx_status_codec_amrwb().

Returns

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

This function is part of the Prosody RTP processing API.