The FilterReceivedRtpPackets procedure allows application software to change the default receive RTP packet filtering behavior of the media engine. This capability is useful if the application receives encrypted RTP packets from another telephony device.

By default the media engine performs RTP payload ID and packet size filtering for all incoming RTP media packets. The application can use this API procedure to selectively enable or disable the filtering behavior. For additional information regarding RTP packet encryption, see the EnableRawRtpPacketAccess(VoipMediaEngine, Int32, Boolean, VoipMediaEngine..::.RTP_CALLBACK_PROC, Object) API procedure.

Namespace:  LanScape
Assembly:  LMEVoipManaged (in LMEVoipManaged.dll) Version: 6.0.5226.26700

Syntax

C#
public VoipMediaEngine..::.TELEPHONY_RETURN_VALUE FilterReceivedRtpPackets(
	VoipMediaEngine MediaEngine,
	int PhoneLine,
	VoipMediaEngine..::.RtpPacketAccess..::.FILTER_RECEIVED_RTP_PACKETS FilterType,
	bool EnableState
)
Visual Basic (Declaration)
Public Function FilterReceivedRtpPackets ( _
	MediaEngine As VoipMediaEngine, _
	PhoneLine As Integer, _
	FilterType As VoipMediaEngine..::.RtpPacketAccess..::.FILTER_RECEIVED_RTP_PACKETS, _
	EnableState As Boolean _
) As VoipMediaEngine..::.TELEPHONY_RETURN_VALUE
Visual C++
public:
VoipMediaEngine..::.TELEPHONY_RETURN_VALUE FilterReceivedRtpPackets(
	VoipMediaEngine^ MediaEngine, 
	int PhoneLine, 
	VoipMediaEngine..::.RtpPacketAccess..::.FILTER_RECEIVED_RTP_PACKETS FilterType, 
	bool EnableState
)
J#
public VoipMediaEngine..::.TELEPHONY_RETURN_VALUE FilterReceivedRtpPackets(
	VoipMediaEngine MediaEngine,
	int PhoneLine,
	VoipMediaEngine..::.RtpPacketAccess..::.FILTER_RECEIVED_RTP_PACKETS FilterType,
	boolean EnableState
)

Parameters

MediaEngine
Type: LanScape..::.VoipMediaEngine
An instance of the media engine.
PhoneLine
Type: System..::.Int32
The zero based phone line to access.
FilterType
Type: LanScape..::.VoipMediaEngine..::.RtpPacketAccess..::.FILTER_RECEIVED_RTP_PACKETS
Specifies the receive RTP filter characteristic type to change. For additional details, see the VoipMediaEngine..::.RtpPacketAccess..::.FILTER_RECEIVED_RTP_PACKETS enumeration.
EnableState
Type: System..::.Boolean
Specifies the enable state of the specified filter characteristic.

Return Value

If the function succeeds, the return value will be SipSuccess.

If the function fails, the return value will be one of the following values as specified by the VoipMediaEngine..::.TELEPHONY_RETURN_VALUE data type.

Return ValueDescription
SipCallFailure
This value is returned by telephony API procedures to indicate general API failure. This error value is used as a "catch all error". If you receive this error, check to make sure that all parameters specified in the API procedure call are correct. Particularly, verify that pointers to memory regions are valid. This error return value is only used if a mapping to another specific error value does not exist.

(API return value)

SipInvalidHandle
Application software specified an invalid telephony handle in one of the API procedures. This usually indicates memory corruption on the part of application software.

(API return value)

SipBadPhoneLine
Application software called a telephony API procedure and specified an invalid phone line. Phone lines are numbered starting from zero. This error is most commonly returned when attempting to access phone lines in excess of the max number of lines supported by the telephony engine.

(API return value)

Remarks

None.

See Also