The GetRtpTransceiverStatistics procedure allows application software to access RTP transceiver statistical information on a per phone line basis. Application software can call this API procedure to determine such things as total number of received and transmitted RTP media packets and total transmitted and received RTP packet errors.

RTP transceiver statistics can be used to monitor or determine RTP transmitter and receiver activity. One such use of this information is to detect RTP transmit and receive errors on a polled basis or to detect received media timeouts. The RTP statistic values are reset to zero at the beginning of each call.

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

Syntax

C#
public VoipMediaEngine..::.TELEPHONY_RETURN_VALUE GetRtpTransceiverStatistics(
	int PhoneLine,
	VoipMediaEngine..::.RTP_TRANSCEIVER_STATISTICS RtpTransceiverStatistics
)
Visual Basic (Declaration)
Public Function GetRtpTransceiverStatistics ( _
	PhoneLine As Integer, _
	RtpTransceiverStatistics As VoipMediaEngine..::.RTP_TRANSCEIVER_STATISTICS _
) As VoipMediaEngine..::.TELEPHONY_RETURN_VALUE
Visual C++
public:
VoipMediaEngine..::.TELEPHONY_RETURN_VALUE GetRtpTransceiverStatistics(
	int PhoneLine, 
	VoipMediaEngine..::.RTP_TRANSCEIVER_STATISTICS^ RtpTransceiverStatistics
)
J#
public VoipMediaEngine..::.TELEPHONY_RETURN_VALUE GetRtpTransceiverStatistics(
	int PhoneLine,
	VoipMediaEngine..::.RTP_TRANSCEIVER_STATISTICS RtpTransceiverStatistics
)

Parameters

PhoneLine
Type: System..::.Int32
The zero based phone line to enable or disable RTP packet access. Application software can enable/disable RTP packet access individually for each phone line.
RtpTransceiverStatistics
Type: LanScape..::.VoipMediaEngine..::.RTP_TRANSCEIVER_STATISTICS
Specifies the user supplied structure variable that will contain the returned RTP transceiver values.

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)

SipBadParameter
One of the telephony API procedures was called by application software and was passed a pointer to an invalid memory address. Normally this error will occur when application software passes NULL pointer values to the telephony API. For managed code applications, you should never see this error unless your process space has exhausted memory.

(API return value)

Remarks

None.

See Also