Amazon Kinesis Webrtc C SDK
Macros | Functions
Metrics.c File Reference
#include "../Include_i.h"
Include dependency graph for Metrics.c:

Macros

#define LOG_CLASS   "Metrics"
 

Functions

STATUS getIceCandidatePairStats (PRtcPeerConnection pRtcPeerConnection, PRtcIceCandidatePairStats pRtcIceCandidatePairStats)
 Get specific ICE candidate pair stats. More...
 
STATUS getIceCandidateStats (PRtcPeerConnection pRtcPeerConnection, BOOL isRemote, PRtcIceCandidateStats pRtcIceCandidateStats)
 Get specific ICE candidate stats. More...
 
STATUS getIceServerStats (PRtcPeerConnection pRtcPeerConnection, PRtcIceServerStats pRtcIceServerStats)
 Get specific ICE server stats getIceServerStats will return stats for a specific server. In a multi server configuration, it is upto to the application to get Stats for every server being supported / desired server. The application is expected to pass in the specific iceServerIndex for which the stats are desired. More...
 
STATUS getTransportStats (PRtcPeerConnection pRtcPeerConnection, PRtcTransportStats pRtcTransportStats)
 Get specific transport stats. More...
 
STATUS getRtpRemoteInboundStats (PRtcPeerConnection pRtcPeerConnection, PRtcRtpTransceiver pTransceiver, PRtcRemoteInboundRtpStreamStats pRtcRemoteInboundRtpStreamStats)
 Get remote RTP inbound stats. More...
 
STATUS getRtpOutboundStats (PRtcPeerConnection pRtcPeerConnection, PRtcRtpTransceiver pTransceiver, PRtcOutboundRtpStreamStats pRtcOutboundRtpStreamStats)
 Get RTP outbound stats. More...
 
STATUS getRtpInboundStats (PRtcPeerConnection pRtcPeerConnection, PRtcRtpTransceiver pTransceiver, PRtcInboundRtpStreamStats pRtcInboundRtpStreamStats)
 Get RTP inbound stats. More...
 
STATUS getDataChannelStats (PRtcPeerConnection pRtcPeerConnection, PRtcDataChannelStats pRtcDataChannelStats)
 
STATUS rtcPeerConnectionGetMetrics (PRtcPeerConnection pRtcPeerConnection, PRtcRtpTransceiver pRtcRtpTransceiver, PRtcStats pRtcMetrics)
 Get the relevant/all metrics based on the RTCStatsType field. This does not include any signaling related metrics. The caller of the API is expected to populate requestedTypeOfStats member of PRtcStats object with one of the values in RTC_STATS_TYPE. More...
 

Macro Definition Documentation

◆ LOG_CLASS

#define LOG_CLASS   "Metrics"

Kinesis WebRTC Metrics

Function Documentation

◆ getDataChannelStats()

STATUS getDataChannelStats ( PRtcPeerConnection  pRtcPeerConnection,
PRtcDataChannelStats  pRtcDataChannelStats 
)
Here is the caller graph for this function:

◆ getIceCandidatePairStats()

STATUS getIceCandidatePairStats ( PRtcPeerConnection  pRtcPeerConnection,
PRtcIceCandidatePairStats  pRtcIceCandidatePairStats 
)

Get specific ICE candidate pair stats.

Parameters
[in]PRtcPeerConnectionContains the Ice agent object with diagnostics object
[in/out]PRtcIceCandidatePairStats Fill up the ICE candidate pair stats for application consumption
Returns
Pass/Fail
Here is the caller graph for this function:

◆ getIceCandidateStats()

STATUS getIceCandidateStats ( PRtcPeerConnection  pRtcPeerConnection,
BOOL  isRemote,
PRtcIceCandidateStats  pRtcIceCandidateStats 
)

Get specific ICE candidate stats.

Parameters
[in]PRtcPeerConnectionContains the Ice agent object with diagnostics object
[in/out]PRtcIceCandidateStats Fill up the ICE candidate stats for application consumption
[in]BOOLIf TRUE, remote candidate stats are extracted, else local candidate stats are extracted
Returns
Pass/Fail
Here is the caller graph for this function:

◆ getIceServerStats()

STATUS getIceServerStats ( PRtcPeerConnection  pRtcPeerConnection,
PRtcIceServerStats  pRtcIceServerStats 
)

Get specific ICE server stats getIceServerStats will return stats for a specific server. In a multi server configuration, it is upto to the application to get Stats for every server being supported / desired server. The application is expected to pass in the specific iceServerIndex for which the stats are desired.

Parameters
[in]PRtcPeerConnectionContains the Ice agent object with diagnostics object
[in/out]PRtcIceServerStats Fill up the ICE candidate stats for application consumption
Returns
Pass/Fail
Here is the caller graph for this function:

◆ getRtpInboundStats()

STATUS getRtpInboundStats ( PRtcPeerConnection  pRtcPeerConnection,
PRtcRtpTransceiver  pTransceiver,
PRtcInboundRtpStreamStats  pRtcInboundRtpStreamStats 
)

Get RTP inbound stats.

Parameters
[in]PRtcPeerConnection
[in]PRtcRtpTransceivertransceiver to get stats for, first transceiver if NULL
[in/out]PRtcInboundRtpStreamStats Fill up the RTP inbound stats for application consumption
Returns
Pass/Fail
Here is the call graph for this function:
Here is the caller graph for this function:

◆ getRtpOutboundStats()

STATUS getRtpOutboundStats ( PRtcPeerConnection  pRtcPeerConnection,
PRtcRtpTransceiver  pTransceiver,
PRtcOutboundRtpStreamStats  pRtcOutboundRtpStreamStats 
)

Get RTP outbound stats.

Parameters
[in]PRtcPeerConnection
[in]PRtcRtpTransceivertransceiver to get stats for, first transceiver if NULL
[in/out]PRtcOutboundRtpStreamStats Fill up the RTP outbound stats for application consumption
Returns
Pass/Fail
Here is the call graph for this function:
Here is the caller graph for this function:

◆ getRtpRemoteInboundStats()

STATUS getRtpRemoteInboundStats ( PRtcPeerConnection  pRtcPeerConnection,
PRtcRtpTransceiver  pTransceiver,
PRtcRemoteInboundRtpStreamStats  pRtcRemoteInboundRtpStreamStats 
)

Get remote RTP inbound stats.

Parameters
[in]PRtcPeerConnection
[in]PRtcRtpTransceivertransceiver to get stats for, first transceiver if NULL
[in/out]PRtcOutboundRtpStreamStats Fill up the RTP inbound stats for application consumption
Returns
Pass/Fail
Here is the call graph for this function:
Here is the caller graph for this function:

◆ getTransportStats()

STATUS getTransportStats ( PRtcPeerConnection  pRtcPeerConnection,
PRtcTransportStats  pRtcTransportStats 
)

Get specific transport stats.

Parameters
[in]PRtcPeerConnection
[in/out]PRtcIceCandidateStats Fill up the transport stats for application consumption
Returns
Pass/Fail
Here is the caller graph for this function: