VideoRenderingTracingInfo

Indicators during video frame rendering progress.

public static class VideoRenderingTracingInfo {
  public int elapsedTime;
  public int start2JoinChannel;
  public int join2JoinSuccess;
  public int joinSuccess2RemoteJoined;
  public int remoteJoined2SetView;
  public int remoteJoined2UnmuteVideo;
  public int remoteJoined2PacketReceived;
};
Since
v4.1.1

Attributes

elapsedTime
The time interval from calling the startMediaRenderingTracing method to SDK triggering the onVideoRenderingTracingResult callback. The unit is milliseconds. Agora recommends you call startMediaRenderingTracing before joining a channel.
start2JoinChannel
The time interval from calling startMediaRenderingTracing to calling joinChannel [2/2]. The unit is milliseconds. A negative number means to call joinChannel [2/2] after calling startMediaRenderingTracing.
join2JoinSuccess
Time interval from calling joinChannel [2/2] to successfully joining the channel. The unit is milliseconds.
joinSuccess2RemoteJoined
  • If the local user calls startMediaRenderingTracing before successfully joining the channel, this value is the time interval from the local user successfully joining the channel to the remote user joining the channel. The unit is milliseconds.
  • If the local user calls startMediaRenderingTracing after successfully joining the channel, the value is the time interval from calling startMediaRenderingTracing to when the remote user joins the channel. The unit is milliseconds.
Note:
  • If the local user calls startMediaRenderingTracing after the remote user joins the channel, the value is 0 and meaningless.
  • In order to reduce the time of rendering the first frame for remote users, Agora recommends that the local user joins the channel when the remote user is in the channel to reduce this value.
remoteJoined2SetView
  • If the local user calls startMediaRenderingTracing before the remote user joins the channel, this value is the time interval from when the remote user joins the channel to when the local user sets the remote view. The unit is milliseconds.
  • If the local user calls startMediaRenderingTracing after the remote user joins the channel, this value is the time interval from calling startMediaRenderingTracing to setting the remote view. The unit is milliseconds.
Note:
  • If the local user calls startMediaRenderingTracing after setting the remote view, the value is 0 and has no effect.
  • In order to reduce the time of rendering the first frame for remote users, Agora recommends that the local user sets the remote view before the remote user joins the channel, or sets the remote view immediately after the remote user joins the channel to reduce this value.
remoteJoined2UnmuteVideo
  • If the local user calls startMediaRenderingTracing before the remote user joins the channel, this value is the time interval from the remote user joining the channel to subscribing to the remote video stream. The unit is milliseconds.
  • If the local user calls startMediaRenderingTracing after the remote user joins the channel, this value is the time interval from calling startMediaRenderingTracing to subscribing to the remote video stream. The unit is milliseconds.
Note:
  • If the local user calls startMediaRenderingTracing after subscribing to the remote video stream, the value is 0 and has no effect.
  • In order to reduce the time of rendering the first frame for remote users, Agora recommends that after the remote user joins the channel, the local user immediately subscribes to the remote video stream to reduce this value.
remoteJoined2PacketReceived
  • If the local user calls startMediaRenderingTracing before the remote user joins the channel, this value is the time interval from when the remote user joins the channel to when the local user receives the remote video stream. The unit is milliseconds.
  • If the local user calls startMediaRenderingTracing after the remote user joins the channel, this value is the time interval from calling startMediaRenderingTracing to receiving the remote video stream. The unit is milliseconds.
Note:
  • If the local user calls startMediaRenderingTracing after receiving the remote video stream, the value is 0 and has no effect.
  • In order to reduce the time of rendering the first frame for remote users, Agora recommends that the remote user publishes video streams immediately after joining the channel, and the local user immediately subscribes to remote video streams to reduce this value.