Prosody RTP processing: API: sm_vmptx_config_codec_isac

Prototype Definition

int sm_vmptx_config_codec_isac(struct sm_vmptx_codec_isac_parms *codecp)

Parameters

*codecp
a structure of the following type: 
typedef struct sm_vmptx_codec_isac_parms {
	tSMVMPtxId vmptx;					/* in */
	tSM_INT payload_type;					/* in */
	tSMVMPrxId partner;					/* in */
	tSM_INT channel_associated_mode;			/* in */
} SM_VMPTX_CODEC_ISAC_PARMS;

Description

Configures a VMP[tx] to use the iSAC codec for encoding data.

An iSAC codec can automatically adapt its transmitter to network conditions using information derived from the corresponding receiver. When partner is set to a VMP[rx] already configured for the iSAC codec and channel_associated_mode is non zero this transmitter will be automatically adjusted based on the data seen by that receiver. Otherwise, sm_vmptx_config_isac_rate() is used to configure the rate.

The partner field may be kSMNullVMPrxId. However, channel counts may be improved by partnering.

This requires the module isac to have been downloaded.

Fields

vmptx
The VMP[tx] 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.
partner
The VMP[rx] which is already running the iSAC codec
channel_associated_mode
Sets whether the transmitter automatically adjusts to network conditions based on the data seen by the partner receiver.

Returns

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

This function is part of the Prosody RTP processing API.