RTP statistics functions

Functions
(int)	- PortSIPSDK::getNetworkStatistics:currentBufferSize:preferredBufferSize:currentPacketLossRate:currentDiscardRate:currentExpandRate:currentPreemptiveRate:currentAccelerateRate:
	Get the "in-call" statistics. The statistics are reset after the query. More...
(int)	- PortSIPSDK::getAudioRtpStatistics:averageJitterMs:maxJitterMs:discardedPackets:
	Obtain the RTP statistics of audio channel. More...
(int)	- PortSIPSDK::getAudioRtcpStatistics:bytesSent:packetsSent:bytesReceived:packetsReceived:sendFractionLost:sendCumulativeLost:recvFractionLost:recvCumulativeLost:roundTripTime:
	Obtain the RTCP statistics of audio channel. More...
(int)	- PortSIPSDK::getVideoRtpStatistics:bytesSent:packetsSent:bytesReceived:packetsReceived:
	Obtain the RTP statistics of video. More...

Detailed Description

Function Documentation

getNetworkStatistics:currentBufferSize:preferredBufferSize:currentPacketLossRate:currentDiscardRate:currentExpandRate:currentPreemptiveRate:currentAccelerateRate:()

- (int) getNetworkStatistics:		(long)	sessionId
currentBufferSize:		(int *)	currentBufferSize
preferredBufferSize:		(int *)	preferredBufferSize
currentPacketLossRate:		(int *)	currentPacketLossRate
currentDiscardRate:		(int *)	currentDiscardRate
currentExpandRate:		(int *)	currentExpandRate
currentPreemptiveRate:		(int *)	currentPreemptiveRate
currentAccelerateRate:		(int *)	currentAccelerateRate

Get the "in-call" statistics. The statistics are reset after the query.

Parameters

sessionId	The session ID of call conversation.
currentBufferSize	Current jitter buffer size in ms.
preferredBufferSize	Preferred buffer size in ms.
currentPacketLossRate	Loss rate (network + late) in percentage.
currentDiscardRate	Fraction of synthesized speech inserted through pre-emptive expansion.
currentExpandRate	Fraction (of original stream) of synthesized speech inserted through expansion.
currentPreemptiveRate	Fraction of synthesized speech inserted through pre-emptive expansion.
currentAccelerateRate	Fraction of data removed through acceleration.

Returns

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

getAudioRtpStatistics:averageJitterMs:maxJitterMs:discardedPackets:()

- (int) getAudioRtpStatistics:		(long)	sessionId
averageJitterMs:		(int *)	averageJitterMs
maxJitterMs:		(int *)	maxJitterMs
discardedPackets:		(int *)	discardedPackets

Obtain the RTP statistics of audio channel.

Parameters

sessionId	The session ID of call conversation.
averageJitterMs	Short-time average jitter, in milliseconds.
maxJitterMs	Maximum short-time jitter, in milliseconds.
discardedPackets	The number of discarded packets on a channel during the call.

Returns

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

getAudioRtcpStatistics:bytesSent:packetsSent:bytesReceived:packetsReceived:sendFractionLost:sendCumulativeLost:recvFractionLost:recvCumulativeLost:roundTripTime:()

- (int) getAudioRtcpStatistics:		(long)	sessionId
bytesSent:		(int *)	bytesSent
packetsSent:		(int *)	packetsSent
bytesReceived:		(int *)	bytesReceived
packetsReceived:		(int *)	packetsReceived
sendFractionLost:		(int *)	sendFractionLost
sendCumulativeLost:		(int *)	sendCumulativeLost
recvFractionLost:		(int *)	recvFractionLost
recvCumulativeLost:		(int *)	recvCumulativeLost
roundTripTime:		(int *)	roundTripTime

Obtain the RTCP statistics of audio channel.

Parameters

sessionId	The session ID of call conversation.
bytesSent	The number of sent bytes.
packetsSent	The number of sent packets.
bytesReceived	The number of received bytes.
packetsReceived	The number of received packets.
sendFractionLost	Fraction of sent lost in percentage.
sendCumulativeLost	The number of sent cumulative lost packet.
recvFractionLost	Fraction of received lost in percent.
recvCumulativeLost	The number of received cumulative lost packets.
roundTripTime	The round-trip time of the session.

Returns

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

getVideoRtpStatistics:bytesSent:packetsSent:bytesReceived:packetsReceived:()

- (int) getVideoRtpStatistics:		(long)	sessionId
bytesSent:		(int *)	bytesSent
packetsSent:		(int *)	packetsSent
bytesReceived:		(int *)	bytesReceived
packetsReceived:		(int *)	packetsReceived

Obtain the RTP statistics of video.

Parameters

sessionId	The session ID of call conversation.
bytesSent	The number of sent bytes.
packetsSent	The number of sent packets.
bytesReceived	The number of received bytes.
packetsReceived	The number of received packets.

Returns

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