SIGN UP

IQualityIssueListener

Interface to monitor issues that affect call quality during a call. Use the ICall.setQualityIssueListener(IQualityIssueListener) API to subscribe to the following events.

Methods

onCodecMismatch

Since 2.6.0
void onCodecMismatch(ICall call, QualityIssueLevel level, String sendCodec)

BETA

Invoked if local video is encoded by a codec different from specified in ClientConfig.preferredVideoCodec or CallSettings.preferredVideoCodec

Issue level is QualityIssueLevel.CRITICAL if video is not sent, QualityIssueLevel.MAJOR in case of codec mismatch or QualityIssueLevel.NONE if the issue is not detected.

Possible reasons:

  1. The device does not support a selected codec. For example, if H264 is specified and the device does not support this hardware codec, the issue will be triggered
  2. The video is not sent for some reasons. In this case sendCodec will be null
  3. Different codecs are specified in the call endpoints

Parameters

  • call:

    ICall

    Call the issue belongs to

  • Issue level

  • sendCodec:

    String

    Codec that is currently used or null if the video is not sent

onHighMediaLatency

Since 2.6.0
void onHighMediaLatency(ICall call, QualityIssueLevel level, double latency)

BETA

Invoked if network-based media latency is detected in the call. Network-based media latency is calculated based on rtt (round trip time) and jitter buffer. Latency refers to the time it takes a voice/video packet to reach its destination. Sufficient latency causes call participants to speak over the top of each other.

Issue level may vary during the call.

Possible reasons:

  1. Network congestion/delays
  2. Lack of bandwidth

Parameters

  • call:

    ICall

    Call the issue belongs to

  • Issue level

  • latency:

    double

    Network-based latency measured in milliseconds at the moment the issue triggered.

onIceDisconnected

Since 2.6.0
void onIceDisconnected(ICall call, QualityIssueLevel level)

BETA

Invoked if ICE connection is switched to the "disconnected" state during the call.

Issue level is always QualityIssueLevel.CRITICAL, because there is no media in the call until the issue is resolved.

Event may be triggered intermittently and be resolved just as spontaneously on less reliable networks, or during temporary disconnections.

Possible reasons:

  1. Network issues

Parameters

onLocalVideoDegradation

Since 2.6.0
void onLocalVideoDegradation(ICall call, QualityIssueLevel level, int targetWidth, int targetHeight, int actualWidth, int actualHeight)

BETA

Invoked if the video resolution sent to the endpoint is lower than a captured video resolution. As a result it affects remote video quality on the remote participant side, but do not affect the quality of local video preview on the android application.

The issue level may vary during the call.

Possible reasons:

  1. High CPU load during the video call
  2. Network issues such as poor internet connection or low bandwidth

Parameters

  • call:

    ICall

    Call the issue belongs to

  • Issue level

  • targetWidth:

    int

    Captured frame width

  • targetHeight:

    int

    Captured frame height

  • actualWidth:

    int

    Sent frame width

  • actualHeight:

    int

    Sent frame height

onLowBandwidth

Since 2.6.0
void onLowBandwidth(ICall call, QualityIssueLevel level, double targetBitrate, double actualBitrate)

BETA

Invoked if current bitrate is insufficient for sending video with current resolution.

Issue level may vary during the call. SDK may report QualityIssueLevel.MAJOR or QualityIssueLevel.MINOR while detecting network capabilities right after the call start.

Target bitrate depends on the sent video frame resolution. If the resolution of video frames sent is changed, target bitrate can also be changed (increased or degraded).

It is not recommended to change the resolution or other video call parameters once the issue is detected; in such case, SDK tries to adapt to the current congestion automatically. Only if the issue level is constantly QualityIssueLevel.MAJOR or QualityIssueLevel.CRITICAL, you can change the video call parameters.

Issue may be triggered and constantly report QualityIssueLevel.MAJOR or QualityIssueLevel.CRITICAL if the application is running in the background.

Possible reasons:

  1. Network issues
  2. Background state of an application

Parameters

  • call:

    ICall

    Call the issue belongs to

  • Issue level

  • targetBitrate:

    double

    Bitrate required to send video with current resolution with a good quality. Measured in bits per second.

  • actualBitrate:

    double

    Actual bitrate. Measured in bits per second.

onNoAudioSignal

Since 2.6.0
void onNoAudioSignal(ICall call, QualityIssueLevel level)

BETA

Invoked if no audio is captured by the microphone.

Issue level can be only QualityIssueLevel.CRITICAL if the issue is detected or QualityIssueLevel.NONE if the issue is not detected or resolved.

Depending on the device manufacturer, the issue may be occasionally reported in case of pause in the conversation.

Possible reasons:

  1. Application or other library mutes the microphone via the setMicrophoneMute android sdk API
  2. Application is running in the background for more than 1 minute and foreground service was not started. Only Android 9+ applications are sensitive.

Parameters

onPacketLoss

Since 2.6.0
void onPacketLoss(ICall call, QualityIssueLevel level, double packetLoss)

BETA

Invoked on packet loss detection. Packet loss can lead to missing of entire sentences, awkward pauses in the middle of a conversation or robotic voice during the call.

Issue level may vary during the call.

Possible reasons:

  1. Network congestion
  2. Bad hardware (parts of the network infrastructure)

Parameters

  • call:

    ICall

    Call the issue belongs to

  • Issue level

  • packetLoss:

    double

    Average packet loss for 2.5 seconds.