Prosody RTP processing: API: sm_vmptx_config_codec_amrwb

Prototype Definition

int sm_vmptx_config_codec_amrwb(struct sm_vmptx_codec_amrwb_parms *codecp)

Parameters

*codecp
a structure of the following type: 
typedef struct sm_vmptx_codec_amrwb_parms {
	tSMVMPtxId vmptx;					/* in */
	tSM_INT payload_type;					/* in */
	tSM_INT aligned;					/* in */
	tSM_INT VADMode;					/* in */
	tSM_INT frames_per_packet;				/* in */
} SM_VMPTX_CODEC_AMRWB_PARMS;

Description

Configures a VMP[tx] to use AMR wide-band for encoding data, as defined in IETF RFC 3267.

This requires the module amr-wb 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.
aligned
Packet alignment (bandwidth efficient mode). 0 if packet is not aligned, otherwise packet is aligned.
VADMode
The mode of operation for the voice activity detector (i.e. discontinuous transmission, or DTX). 0 to disable DTX, otherwise enabled.
frames_per_packet
The number of frames to send per packet. This value is normally one, which encodes 20 milliseconds per packet, but larger values could be used, to reduce the packet overhead at the expense of extra delay. This field is currently ignored. Packets are always transmitted with one frame per packet.

Returns

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

This function is part of the Prosody RTP processing API.