IP Media Library API Library Reference: IPM_PARM

IPM_PARM_INFO
typedef struct ipm_param_info_tag
{
    eIPM_PARM     eParm;          /* the parameter to set or get */
    void          *pvParmValue;   /* pointer to value of parameter */
} IPM_PARM_INFO, *PIPM_PARM_INFO; 
Description

This structure is used to set or retrieve parameters for an IP channel. The structure is used by the ipm_GetParm( ) and ipm_SetParm( ) functions.

Field Descriptions

The fields of the IPM_PARM_INFO data structure are described as follows:

eIPM_PARM

type of parameter to set or get. See Table 5 for values.

*pvParmValue

pointer to the value of the parameter

Table 5. eIPM_PARM Values

Define

Description

PARMCH_ECHOTAIL

echo tail length value. Supported values for Intel® NetStructure™ DM/IP Series boards include: ECHO_TAIL_NONE, ECHO_TAIL_8, ECHO_TAIL_16, ECHO_TAIL_32

Supported values for Intel® NetStructure™ IPT Series boards include: ECHO_TAIL_NONE, ECHO_TAIL_8, ECHO_TAIL_16, ECHO_TAIL_32, ECHO_TAIL_48, ECHO_TAIL_64, ECHO_TAIL_96, ECHO_TAIL_128

PARMCH_RFC2833REDLEVEL

redundancy level; (supported on Intel® NetStructure™ DM/IP Series boards only) values include: RFC2833REDLEVEL_1, RFC2833REDLEVEL_2, RFC2833REDLEVEL_3, RFC2833REDLEVEL_4, RFC2833REDLEVEL_5

PARMCH_RFC2833GEN_TO_TDM

convert RFC2833 to signal (Intel® NetStructure™ DM/IP Series boards only)

Values are: RFC2833GEN_TO_TDM_OFF, RFC2833GEN_TO_TDM_ON

PARMCH_RFC2833GEN_TO_IP

send RFC2833 to IP (OFF / ON) (Intel® NetStructure™ DM/IP Series boards only)

Values are: RFC2833GEN_TO_IP_OFF, RFC2833GEN_TO_IP_ON

PARMCH_DTMFXFERMODE

DTMF transfer mode; values include:

DTMFXFERMODE_INBAND in-band (default)

DTMFXFERMODE_OUTOFBAND out-of-band

DTMFXFERMODE_RFC2833 RFC 2833
Note: In order for DTMF event reporting to occur, you must set eIPM_DTMFXFERMODE to out-of-band signaling on the receive side.

PARMCH_ECACTIVE

echo cancellation active. Values are:

ECACTIVE_OFF, ECACTIVE_ON

PARMCH_AGCACTIVE

automatic gain control active (Intel® NetStructure™ DM/IP Series boards only). Values are: AGCACTIVE_OFF, AGCACTIVE_ON

PARMCH_TOS

type of service, range = 0-255

PARMCH_RFC2833EVT_TX_PLT

RFC2833 event transmit payload

PARMCH_RFC2833EVT_RX_PLT

RFC2833 event receive payload

PARMCH_RFC2833TONE_TX_PLT

RFC2833 tone transmit payload

PARMCH_RFC2833TONE_RX_PLT

RFC2833 tone receive payload

PARMCH_RFC2833MUTE_AUDIO

clamping mode for DTMF data sent using RFC 2833 mode. This parameter is set to ON by default. Values are: RFC2833MUTE_AUDIO_ON (default), RFC2833MUTE_AUDIO_OFF
Note: This parameter is invalid for in-band mode, since the data is automatically transmitted on the RTP stream. This parameter is not applicable to out-of-band mode, since the data is automatically muted (clamped). See the IP Media Library API Programming Guide for more details.

Table 5. **eIPM_PARM Values**
Define	Description
PARMCH_ECHOTAIL	echo tail length value. Supported values for Intel® NetStructure™ DM/IP Series boards include: ECHO_TAIL_NONE, ECHO_TAIL_8, ECHO_TAIL_16, ECHO_TAIL_32 Supported values for Intel® NetStructure™ IPT Series boards include: ECHO_TAIL_NONE, ECHO_TAIL_8, ECHO_TAIL_16, ECHO_TAIL_32, ECHO_TAIL_48, ECHO_TAIL_64, ECHO_TAIL_96, ECHO_TAIL_128
PARMCH_RFC2833REDLEVEL	redundancy level; (supported on Intel® NetStructure™ DM/IP Series boards only) values include: RFC2833REDLEVEL_1, RFC2833REDLEVEL_2, RFC2833REDLEVEL_3, RFC2833REDLEVEL_4, RFC2833REDLEVEL_5
PARMCH_RFC2833GEN_TO_TDM	convert RFC2833 to signal (Intel® NetStructure™ DM/IP Series boards only) Values are: RFC2833GEN_TO_TDM_OFF, RFC2833GEN_TO_TDM_ON
PARMCH_RFC2833GEN_TO_IP	send RFC2833 to IP (OFF / ON) (Intel® NetStructure™ DM/IP Series boards only) Values are: RFC2833GEN_TO_IP_OFF, RFC2833GEN_TO_IP_ON
PARMCH_DTMFXFERMODE	DTMF transfer mode; values include: DTMFXFERMODE_INBAND in-band (default) DTMFXFERMODE_OUTOFBAND out-of-band DTMFXFERMODE_RFC2833 RFC 2833 Note: In order for DTMF event reporting to occur, you must set eIPM_DTMFXFERMODE to out-of-band signaling on the receive side.
PARMCH_ECACTIVE	echo cancellation active. Values are: ECACTIVE_OFF, ECACTIVE_ON
PARMCH_AGCACTIVE	automatic gain control active (Intel® NetStructure™ DM/IP Series boards only). Values are: AGCACTIVE_OFF, AGCACTIVE_ON
PARMCH_TOS	type of service, range = 0-255
PARMCH_RFC2833EVT_TX_PLT	RFC2833 event transmit payload
PARMCH_RFC2833EVT_RX_PLT	RFC2833 event receive payload
PARMCH_RFC2833TONE_TX_PLT	RFC2833 tone transmit payload
PARMCH_RFC2833TONE_RX_PLT	RFC2833 tone receive payload
PARMCH_RFC2833MUTE_AUDIO	clamping mode for DTMF data sent using RFC 2833 mode. This parameter is set to ON by default. Values are: RFC2833MUTE_AUDIO_ON (default), RFC2833MUTE_AUDIO_OFF Note: This parameter is invalid for in-band mode, since the data is automatically transmitted on the RTP stream. This parameter is not applicable to out-of-band mode, since the data is automatically muted (clamped). See the IP Media Library API Programming Guide for more details.

Click here to contact Telecom Support Resources