PortSIP VoIP SDK Manual for Windows  16.2
PortSIP features our newest, supported, quality-assured VoIP SDK used by Several hundred companies around the world for easy VoIP application develop and quality-assured code.
Functions
RTP statistics functions

Functions

Int32 PortSIP.PortSIPLib.getAudioStatistics (Int32 sessionId, out Int32 sendBytes, out Int32 sendPackets, out Int32 sendPacketsLost, out Int32 sendFractionLost, out Int32 sendRttMS, out Int32 sendCodecType, out Int32 sendJitterMS, out Int32 sendAudioLevel, out Int32 recvBytes, out Int32 recvPackets, out Int32 recvPacketsLost, out Int32 recvFractionLost, out Int32 recvCodecType, out Int32 recvJitterMS, out Int32 recvAudioLevel)
 Obtain the statistics of audio channel. More...
 
Int32 PortSIP.PortSIPLib.getVideoStatistics (Int32 sessionId, out Int32 sendBytes, out Int32 sendPackets, out Int32 sendPacketsLost, out Int32 sendFractionLost, out Int32 sendRttMS, out Int32 sendCodecType, out Int32 sendFrameWidth, out Int32 sendFrameHeight, out Int32 sendFramerate, out Int32 recvBytes, out Int32 recvPackets, out Int32 recvPacketsLost, out Int32 recvFractionLost, out Int32 recvCodecType, out Int32 recvFrameWidth, out Int32 recvFrameHeight, out Int32 recvBitrateBPS, out Int32 recvFramerate)
 Obtain the RTP statisics of video. More...
 

Detailed Description

Function Documentation

◆ getAudioStatistics()

Int32 PortSIP.PortSIPLib.getAudioStatistics ( Int32  sessionId,
out Int32  sendBytes,
out Int32  sendPackets,
out Int32  sendPacketsLost,
out Int32  sendFractionLost,
out Int32  sendRttMS,
out Int32  sendCodecType,
out Int32  sendJitterMS,
out Int32  sendAudioLevel,
out Int32  recvBytes,
out Int32  recvPackets,
out Int32  recvPacketsLost,
out Int32  recvFractionLost,
out Int32  recvCodecType,
out Int32  recvJitterMS,
out Int32  recvAudioLevel 
)

Obtain the statistics of audio channel.

Parameters
sessionIdThe session ID of call conversation.
sendBytesThe number of sent bytes.
sendPacketsThe number of sent packets.
sendPacketsLostThe number of sent but lost packets.
sendFractionLostFraction of sent but lost packets in percentage.
sendRttMSThe round-trip time of the session, in milliseconds.
sendCodecTypeThe sent Audio codec Type.
sendJitterMSThe sent jitter, in milliseconds.
sendAudioLevelThe sent audio level.It ranges 0 - 9.
recvBytesThe number of received bytes.
recvPacketsThe number of received packets.
recvPacketsLostThe number of received but lost packet.
recvFractionLostFraction of received but lost packet in percentage.
recvCodecTypeReceived Audio codec Type.
recvJitterMSThe received jitter, in milliseconds.
recvAudioLevelThe received audio level. It ranges 0 - 9.
Returns
If the function succeeds, it will return value 0. If the function fails, it will return a specific error code.

◆ getVideoStatistics()

Int32 PortSIP.PortSIPLib.getVideoStatistics ( Int32  sessionId,
out Int32  sendBytes,
out Int32  sendPackets,
out Int32  sendPacketsLost,
out Int32  sendFractionLost,
out Int32  sendRttMS,
out Int32  sendCodecType,
out Int32  sendFrameWidth,
out Int32  sendFrameHeight,
out Int32  sendFramerate,
out Int32  recvBytes,
out Int32  recvPackets,
out Int32  recvPacketsLost,
out Int32  recvFractionLost,
out Int32  recvCodecType,
out Int32  recvFrameWidth,
out Int32  recvFrameHeight,
out Int32  recvBitrateBPS,
out Int32  recvFramerate 
)

Obtain the RTP statisics of video.

Parameters
sessionIdThe session ID of call conversation.
sendBytesThe number of sent bytes.
sendPacketsThe number of sent packets.
sendPacketsLostThe number of sent but lost packets.
sendFractionLostFraction of sent but lost packets in percentage.
sendRttMSThe round-trip time of the session, in milliseconds.
sendCodecTypeThe sent Video codec type.
sendFrameWidthFrame width for the sent video.
sendFrameHeightFrame height for the sent video.
sendBitrateBPSBitrate in BPS for the sent video.
sendFramerateFrame rate for the sent video.
recvBytesThe number of received bytes.
recvPacketsThe number of received packets.
recvPacketsLostThe number of received but lost packet.
recvFractionLostFraction of received but lost packet in percentage.
recvCodecTypeReceived Video codec type.
recvFrameWidthFrame width for the received video.
recvFrameHeightFrame height for the received video.
recvBitrateBPS(This parameter is not implemented yet) Bitrate in BPS for the received video.
recvFramerateFramerate for the received video.
Returns
If the function succeeds, it will return value 0. If the function fails, it will return a specific error code.