Package io.agora.rtc2

Class IRtcEngineEventHandler.RemoteAudioStats

java.lang.Object
io.agora.rtc2.IRtcEngineEventHandler.RemoteAudioStats
Enclosing class:
IRtcEngineEventHandler
public static class IRtcEngineEventHandler.RemoteAudioStats extends Object

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    int
    audioLossRate
    The frame loss rate (%) of the remote audio stream in the reported interval.
    int
    e2eDelay
    End-to-end audio delay (in milliseconds), which refers to the time from when the audio is captured by the remote user to when it is played by the local user.
    int
    frozenCntByCustom
     
    int
    frozenRate
    The total audio freeze time as a percentage (%) of the total time when the audio is available.
    int
    frozenRateByCustomPlcCount
    If the packet loss concealment (PLC) occurs for N consecutive times, freeze is considered as PLC occurring for M consecutive times.
    int
    frozenTimeByCustom
     
    int
    jitterBufferDelay
    The network delay (ms) from the audio receiver to the jitter buffer.
    int
    mosValue
    The quality of the remote audio stream in the reported interval.
    int
    networkTransportDelay
    The network delay (ms) from the sender to the receiver.
    int
    numChannels
    The number of audio channels.
    int
    plcCount
    The number of audio packet loss concealment
    long
    publishDuration
    The total duration (ms) of the remote audio stream.
    int
    qoeQuality
    The Quality of Experience (QoE) of the local user when receiving a remote audio stream.
    int
    quality
    The quality of the audio stream sent by the user.
    int
    qualityChangedReason
    Reasons why the QoE of the local user when receiving a remote audio stream is poor.
    int
    receivedBitrate
    The average bitrate (Kbps) of the received audio stream in the reported interval.
    int
    receivedSampleRate
    The sampling rate of the received audio stream in the reported interval.
    int
    rxAudioBytes
    Total number of audio bytes received (bytes) before network countermeasures, represented by an aggregate value.
    long
    totalActiveTime
    The total active time (ms) between the start of the audio call and the callback of the remote user.
    int
    totalFrozenTime
    The total freeze time (ms) of the remote audio stream after the remote user joins the channel.
    int
    uid
    The user ID of the remote user.

  • Constructor Summary

    Constructors
    Constructor
    Description
    RemoteAudioStats()
     

  • Method Summary

    Methods inherited from class java.lang.Object

    equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Field Details

    • uid

      public int uid
      The user ID of the remote user.

    • quality

      public int quality
      The quality of the audio stream sent by the user. - QUALITY_UNKNOWN (0): The quality is unknown. - QUALITY_EXCELLENT (1): The quality is excellent. - QUALITY_GOOD (2): The network quality seems excellent, but the bitrate can be slightly lower than excellent. - QUALITY_POOR (3): Users can feel the communication is slightly impaired. - QUALITY_BAD (4): Users cannot communicate smoothly. - QUALITY_VBAD (5): The quality is so bad that users can barely communicate. - QUALITY_DOWN (6): The network is down, and users cannot communicate at all. - QUALITY_DETECTING (8): The last-mile probe test is in progress.

    • networkTransportDelay

      public int networkTransportDelay
      The network delay (ms) from the sender to the receiver.

    • jitterBufferDelay

      public int jitterBufferDelay
      The network delay (ms) from the audio receiver to the jitter buffer.

    • audioLossRate

      public int audioLossRate
      The frame loss rate (%) of the remote audio stream in the reported interval.

    • numChannels

      public int numChannels
      The number of audio channels.

    • receivedSampleRate

      public int receivedSampleRate
      The sampling rate of the received audio stream in the reported interval.

    • receivedBitrate

      public int receivedBitrate
      The average bitrate (Kbps) of the received audio stream in the reported interval.

    • totalFrozenTime

      public int totalFrozenTime
      The total freeze time (ms) of the remote audio stream after the remote user joins the channel. In a session, audio freeze occurs when the audio frame loss rate reaches 4%.

    • frozenRate

      public int frozenRate
      The total audio freeze time as a percentage (%) of the total time when the audio is available. The audio is considered available when the remote user neither stops sending the audio stream nor disables the audio module after joining the channel.

    • mosValue

      public int mosValue
      The quality of the remote audio stream in the reported interval. The quality is determined by the Agora real-time audio MOS (Mean Opinion Score) measurement method. The return value range is [0, 500]. Dividing the return value by 100 gets the MOS score, which ranges from 0 to 5. The higher the score, the better the audio quality. The subjective perception of audio quality corresponding to the Agora real-time audio MOS scores is as follows: | MOS score | Perception of audio quality | | -------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------ | | Greater than 4 | Excellent. The audio sounds clear and smooth. | | From 3.5 to 4 | Good. The audio has some perceptible impairment but still sounds clear. | | From 3 to 3.5 | Fair. The audio freezes occasionally and requires attentive listening. | | From 2.5 to 3 | Poor. The audio sounds choppy and requires considerable effort to understand. | | From 2 to 2.5 | Bad. The audio has occasional noise. Consecutive audio dropouts occur, resulting in some information loss. The users can communicate only with difficulty. | | Less than 2 | Very bad. The audio has persistent noise. Consecutive audio dropouts are frequent, resulting in severe information loss. Communication is nearly impossible. |

    • frozenRateByCustomPlcCount

      public int frozenRateByCustomPlcCount
      If the packet loss concealment (PLC) occurs for N consecutive times, freeze is considered as PLC occurring for M consecutive times. freeze cnt = (n_plc - n) / m

    • plcCount

      public int plcCount
      The number of audio packet loss concealment

    • frozenCntByCustom

      public int frozenCntByCustom

    • frozenTimeByCustom

      public int frozenTimeByCustom

    • totalActiveTime

      public long totalActiveTime
      The total active time (ms) between the start of the audio call and the callback of the remote user. The active time refers to the total duration of the remote user without the mute state.

    • publishDuration

      public long publishDuration
      The total duration (ms) of the remote audio stream.

    • qoeQuality

      public int qoeQuality
      The Quality of Experience (QoE) of the local user when receiving a remote audio stream. - EXPERIENCE_QUALITY_GOOD (0): The QoE of the local user is good. - EXPERIENCE_QUALITY_BAD (1): The QoE of the local user is poor.

    • qualityChangedReason

      public int qualityChangedReason
      Reasons why the QoE of the local user when receiving a remote audio stream is poor. - EXPERIENCE_REASON_NONE (0): No reason, indicating a good QoE of the local user. - REMOTE_NETWORK_QUALITY_POOR (1): The remote user's network quality is poor. - LOCAL_NETWORK_QUALITY_POOR (2): The local user's network quality is poor. - WIRELESS_SIGNAL_POOR (4): The local user's Wi-Fi or mobile network signal is weak. - WIFI_BLUETOOTH_COEXIST (8): The local user enables both Wi-Fi and bluetooth, and their signals interfere with each other. As a result, audio transmission quality is undermined.

    • rxAudioBytes

      public int rxAudioBytes
      Total number of audio bytes received (bytes) before network countermeasures, represented by an aggregate value.

    • e2eDelay

      public int e2eDelay
      End-to-end audio delay (in milliseconds), which refers to the time from when the audio is captured by the remote user to when it is played by the local user.

  • Constructor Details

    • RemoteAudioStats

      public RemoteAudioStats()