Audio effect functions

Functions
void	PortSIP.PortSIPLib.enableVAD (Boolean state)
	Enable/disable Voice Activity Detection (VAD). More...
void	PortSIP.PortSIPLib.enableAEC (EC_MODES ecMode)
	Enable/disable AEC (Acoustic Echo Cancellation). More...
void	PortSIP.PortSIPLib.enableCNG (Boolean state)
	Enable/disable Comfort Noise Generator (CNG). More...
void	PortSIP.PortSIPLib.enableAGC (AGC_MODES agcMode)
	Enable/disable Automatic Gain Control (AGC). More...
void	PortSIP.PortSIPLib.enableANS (NS_MODES nsMode)
	Enable/disable Audio Noise Suppression (ANS). More...
Int32	PortSIP.PortSIPLib.setAudioQos (Boolean state, Int32 DSCPValue, Int32 priority)
	Set the DSCP (differentiated services code point) value of QoS (Quality of Service) for audio channel. More...
Int32	PortSIP.PortSIPLib.setVideoQos (Boolean state, Int32 DSCPValue)
	Set the DSCP (differentiated services code point) value of QoS (Quality of Service) for video channel. More...
Int32	PortSIP.PortSIPLib.setVideoMTU (Int32 mtu)
	Set the MTU size for video RTP packet. More...

Detailed Description

Function Documentation

enableVAD()

void PortSIP.PortSIPLib.enableVAD

(

Boolean

state

)

Enable/disable Voice Activity Detection (VAD).

Parameters

state

Set to true to enable VAD, or false to disable.

enableAEC()

void PortSIP.PortSIPLib.enableAEC

(

EC_MODES

ecMode

)

Enable/disable AEC (Acoustic Echo Cancellation).

Parameters

ecMode

Allow to set the AEC mode to influence different scenarios.

Mode	Description
EC_NONE	Disable AEC.
EC_DEFAULT	Platform default AEC.
EC_CONFERENCE	Desktop platform (Windows, MAC) Conferencing default (aggressive AEC).

enableCNG()

void PortSIP.PortSIPLib.enableCNG

(

Boolean

state

)

Enable/disable Comfort Noise Generator (CNG).

Parameters

state

Set it to true to enable CNG, or false to disable.

enableAGC()

void PortSIP.PortSIPLib.enableAGC

(

AGC_MODES

agcMode

)

Enable/disable Automatic Gain Control (AGC).

Parameters

agcMode

Allow to set the AGC mode to influence different scenarios.

Mode	Description
AGC_DEFAULT	Disable AGC.
AGC_DEFAULT	Platform default.
AGC_ADAPTIVE_ANALOG	Desktop platform (Windows, MAC) adaptive mode for use when analog volume control exists.
AGC_ADAPTIVE_DIGITAL	Scaling takes place in the digital domain (e.g. for conference servers and embedded devices).
AGC_FIXED_DIGITAL	It can be used on embedded devices where the capture signal level is predictable.

enableANS()

void PortSIP.PortSIPLib.enableANS

(

NS_MODES

nsMode

)

Enable/disable Audio Noise Suppression (ANS).

Parameters

nsMode

Allow to set the NS mode to influence different scenarios.

Mode	Description
NS_NONE	Disable NS.
NS_DEFAULT	Platform default.
NS_Conference	Conferencing default.
NS_LOW_SUPPRESSION	Lowest suppression.
NS_MODERATE_SUPPRESSION	Moderate suppression.
NS_HIGH_SUPPRESSION	High suppression
NS_VERY_HIGH_SUPPRESSION	Highest suppression.

setAudioQos()

Int32 PortSIP.PortSIPLib.setAudioQos	(	Boolean	state,
		Int32	DSCPValue,
		Int32	priority
	)

Set the DSCP (differentiated services code point) value of QoS (Quality of Service) for audio channel.

Parameters

state	Set to true to enable audio QoS.
DSCPValue	The six-bit DSCP value. Valid value ranges 0-63. As defined in RFC 2472, the DSCP value is the high-order 6 bits of the IP version 4 (IPv4) TOS field and the IP version 6 (IPv6) Traffic Class field.
priority	The 802.1p priority (PCP) field in an 802.1Q/VLAN tag. Values 0-7 indicate the priority, while value -1 leaves the priority setting unchanged.

Returns

If the function succeeds, it will return value 0. If the function fails, it will return a specific error code.

setVideoQos()

Int32 PortSIP.PortSIPLib.setVideoQos	(	Boolean	state,
		Int32	DSCPValue
	)

Set the DSCP (differentiated services code point) value of QoS (Quality of Service) for video channel.

Parameters

state	Set as true to enable QoS, or false to disable.
DSCPValue	The six-bit DSCP value. Valid value ranges 0-63. As defined in RFC 2472, the DSCP value is the high-order 6 bits of the IP version 4 (IPv4) TOS field and the IP version 6 (IPv6) Traffic Class field.

Returns

If the function succeeds, it will return value 0. If the function fails, it will return a specific error code.

setVideoMTU()

Int32 PortSIP.PortSIPLib.setVideoMTU

(

Int32

mtu

)

Set the MTU size for video RTP packet.

Parameters

mtu	Set MTU value. Allow value ranges (512-65507). Other value will be modified to the default 1450.

Returns

If the function succeeds, it will return value 0. If the function fails, it will return a specific error code.