Detailed Description
When a call is running, it is possible to retrieve in real time current measured volumes and quality indicator.
Define Documentation
Every seconds LinphoneCallStats object has been updated
received_rtcp field of LinphoneCallStats object has been updated
sent_rtcp field of LinphoneCallStats object has been updated
Typedef Documentation
Function Documentation
Access last known statistics for audio stream, for a given call.
Obtain real-time quality rating of the call
Based on local RTP statistics and RTCP feedback, a quality rating is computed and updated during all the duration of the call. This function returns its value at the time of the function call. It is expected that the rating is updated at least every 5 seconds or so. The rating is a floating point number comprised between 0 and 5.
4-5 = good quality
3-4 = average quality
2-3 = poor quality
1-2 = very poor quality
0-1 = can't be worse, mostly unusable
- Returns:
- The function returns -1 if no quality measurement is available, for example if no active audio stream exist. Otherwise it returns the quality rating.
Get microphone volume gain. If the sound backend supports it, the returned gain is equal to the gain set with the system mixer.
- Parameters:
-
- Returns:
- double Percenatge of the max supported volume gain. Valid values are in [ 0.0 : 1.0 ]. In case of failure, a negative value is returned
Returns the measured sound volume played locally (received from remote). It is expressed in dbm0.
Returns the measured sound volume recorded locally (sent to remote). It is expressed in dbm0.
Get speaker volume gain. If the sound backend supports it, the returned gain is equal to the gain set with the system mixer.
- Parameters:
-
- Returns:
- Percenatge of the max supported volume gain. Valid values are in [ 0.0 : 1.0 ]. In case of failure, a negative value is returned
Access last known statistics for video stream, for a given call.
Access last known statistics for video stream, for a given call.
Indicates whether an operation is in progress at the media side. It can be a bad idea to initiate signaling operations (adding video, pausing the call, removing video, changing video parameters) while the media is busy in establishing the connection (typically ICE connectivity checks). It can result in failures generating loss of time in future operations in the call. Applications are invited to check this function after each call state change to decide whether certain operations are permitted or not.
- Parameters:
-
- Returns:
- TRUE if media is busy in establishing the connection, FALSE otherwise.
Set microphone volume gain. If the sound backend supports it, the new gain will synchronized with the system mixer.
- Parameters:
-
call | The call. |
volume | Percentage of the max supported gain. Valid values are in [ 0.0 : 1.0 ]. |
Set speaker volume gain. If the sound backend supports it, the new gain will synchronized with the system mixer.
- Parameters:
-
call | The call. |
volume | Percentage of the max supported gain. Valid values are in [ 0.0 : 1.0 ]. |
Get the bandwidth measurement of the received stream, expressed in kbit/s, including IP/UDP/RTP headers.
- Parameters:
-
[in] | stats | LinphoneCallStats object |
- Returns:
- The bandwidth measurement of the received stream in kbit/s.
Get the state of ICE processing.
- Parameters:
-
[in] | stats | LinphoneCallStats object |
- Returns:
- The state of ICE processing.
Gets the cumulative number of late packets
- Returns:
- The cumulative number of late packets
Gets the remote reported interarrival jitter
- Returns:
- The interarrival jitter at last received receiver report
Gets the remote reported loss rate since last report
- Returns:
- The receiver loss rate
Gets the local interarrival jitter
- Returns:
- The interarrival jitter at last emitted sender report
Get the local loss rate since last report
- Returns:
- The sender loss rate
Get the bandwidth measurement of the sent stream, expressed in kbit/s, including IP/UDP/RTP headers.
- Parameters:
-
[in] | stats | LinphoneCallStats object |
- Returns:
- The bandwidth measurement of the sent stream in kbit/s.
Get the state of uPnP processing.
- Parameters:
-
[in] | stats | LinphoneCallStats object |
- Returns:
- The state of uPnP processing.