Prosody signal path processing: API: sm_path_avf_amrnb_enc

This function is under development. It could be changed or withdrawn, and may not be implemented in this release.

Prototype Definition

int sm_path_avf_amrnb_enc(struct sm_path_avf_amrnb_enc_parms *amrnbencparms)

Parameters

a structure of the following type:

typedef struct sm_path_avf_amrnb_enc_parms {
	tSMPathId path;						/* in */
	tSM_INT enable;						/* in */
	tSM_INT payload_type;					/* in */
	tSM_INT bitrate;					/* in */
	tSM_INT vad_enable;					/* in */
} SM_PATH_AVF_AMRNB_ENC_PARMS;

Description

Configures AVF encapsulated AMR-NB encoding on a signal path. Requires the module amr-nb-prs or amr-nb-all.

Fields

path (Only in Preliminary Documentation): The signal path to be configured
enable (Only in Preliminary Documentation): Enables (non-zero) or disables (zero) the AMR-NB encoder.
payload_type (Only in Preliminary Documentation): The payload type which should be used in the output AVF. Note that on AVF replay the payload type in the AVF is ignored so, in general, the value supplied here is irrelevant. However if, for instance, the resulting file was to be output using a streaming server, the payload type may well be used.
bitrate (Only in Preliminary Documentation): The speed to use in bits per second. It must be one of the speeds which the AMR codec can encode, which are: 4750, 5150, 5900, 6700, 7400, 7950, 10200, and 12200.
vad_enable (Only in Preliminary Documentation): Whether to enable the Voice Activity Detector.

Returns

0 if call completed successfully, otherwise a standard error.

This function is part of the Prosody signal path processing API.