|
Agora RTC Objective-C API Reference
Refactor
|
Inherits <NSObject>.
Properties | |
| NSUInteger | uid |
| NSUInteger | quality |
| NSUInteger | networkTransportDelay |
| NSUInteger | jitterBufferDelay |
| NSUInteger | audioLossRate |
| NSUInteger | numChannels |
| NSUInteger | receivedSampleRate |
| NSUInteger | receivedBitrate |
| NSUInteger | totalFrozenTime |
| NSUInteger | totalActiveTime |
| NSInteger | publishDuration |
| NSUInteger | frozenRate |
| NSUInteger | mosValue |
| NSUInteger | frozenRateByCustomPlcCount |
| NSUInteger | plcCount |
| NSUInteger | frozenCntByCustom |
| NSUInteger | frozenTimeByCustom |
| AgoraExperienceQuality | qoeQuality |
| AgoraExperiencePoorReason | qualityChangedReason |
| NSUInteger | rxAudioBytes |
| NSInteger | e2eDelay |
The statistics of the remote audio.
|
readwritenonatomicassign |
ID of the user sending the audio stream.
|
readwritenonatomicassign |
The receiving audio quality.
|
readwritenonatomicassign |
The network delay (ms) from the sender to the receiver.
|
readwritenonatomicassign |
The jitter buffer delay (ms) at the receiver.
|
readwritenonatomicassign |
The packet loss rate in the reported interval.
|
readwritenonatomicassign |
The number of audio channels.
|
readwritenonatomicassign |
The sample rate (Hz) of the received audio stream, represented by an instantaneous value.
|
readwritenonatomicassign |
The bitrate (Kbps) of the received audio stream, represented by an instantaneous value.
|
readwritenonatomicassign |
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% within two seconds. Agora uses 2 seconds as an audio piece unit to calculate the audio freeze time. The total audio freeze time = The audio freeze number × 2 seconds
|
readwritenonatomicassign |
The total time (ms) when the remote user neither stops sending the audio stream nor disables the audio module after joining the channel.
|
readwritenonatomicassign |
The total publish duration (ms) of the remote audio stream.
|
readwritenonatomicassign |
The total audio freeze time as a percentage (%) of the total time when the audio is available.
|
readwritenonatomicassign |
The quality of the remote audio stream as determined by the Agora real-time audio MOS (Mean Opinion Score) measurement method in the reported interval. The return value ranges from 0 to 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. |
|
readwritenonatomicassign |
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
|
readwritenonatomicassign |
The number of audio packet loss concealment
|
readwritenonatomicassign |
@technical preview The number of times the remote audio stream has experienced freezing.
|
readwritenonatomicassign |
@technical preview The total duration (ms) that the remote audio stream has been in a frozen state.
|
readwritenonatomicassign |
Quality of experience (QoE) of the local user when receiving a remote audio stream.
|
readwritenonatomicassign |
The reason for poor QoE of the local user when receiving a remote audio stream. See #EXPERIENCE_POOR_REASON.
|
readwritenonatomicassign |
Total number of audio bytes received (bytes) before network countermeasures, represented by an aggregate value.
|
readwritenonatomicassign |
The end-to-end delay (ms) from the sender to the receiver.