VideoRenderingTracingInfo

Metric information during the video frame rendering process.

export class VideoRenderingTracingInfo {
  elapsedTime?: number;
  start2JoinChannel?: number;
  join2JoinSuccess?: number;
  joinSuccess2RemoteJoined?: number;
  remoteJoined2SetView?: number;
  remoteJoined2UnmuteVideo?: number;
  remoteJoined2PacketReceived?: number;
}

Properties

elapsedTime
Time interval (ms) from calling startMediaRenderingTracing to triggering the onVideoRenderingTracingResult callback. It is recommended to call startMediaRenderingTracing before joining the channel.
start2JoinChannel
Time interval (ms) from calling startMediaRenderingTracing to calling joinChannel. A negative value indicates startMediaRenderingTracing was called after joinChannel.
join2JoinSuccess
Time interval (ms) from calling joinChannel1 or joinChannel to successfully joining the channel.
joinSuccess2RemoteJoined
Note:
  • If startMediaRenderingTracing is called after the remote user joins the channel, this value is 0 and has no reference value.
  • To improve the rendering speed of the remote user, it is recommended that the local user joins the channel after the remote user, to reduce this value.
remoteJoined2SetView
Note:
  • If startMediaRenderingTracing is called after setting the remote view, this value is 0 and has no reference value.
  • To improve the rendering speed of the remote user, it is recommended to set the remote view before the remote user joins the channel, or immediately after the remote user joins, to reduce this value.
remoteJoined2UnmuteVideo
Note:
  • If startMediaRenderingTracing is called after subscribing to the remote video stream, this value is 0 and has no reference value.
  • To improve the rendering speed of the remote user, it is recommended to subscribe to the remote video stream immediately after the remote user joins the channel, to reduce this value.
  • If startMediaRenderingTracing is called before the remote user joins the channel, this value is the time interval (ms) from the remote user joining to subscribing to the remote video stream.
  • If startMediaRenderingTracing is called after the remote user joins the channel, this value is the time interval (ms) from calling startMediaRenderingTracing to subscribing to the remote video stream.
remoteJoined2PacketReceived
Note:
  • If startMediaRenderingTracing is called after receiving the remote video stream, this value is 0 and has no reference value.
  • To improve the rendering speed of the remote user, it is recommended that the remote user publishes the video stream immediately after joining the channel, and the local user subscribes to the remote stream immediately, to reduce this value.
  • If startMediaRenderingTracing is called before the remote user joins the channel, this value is the time interval (ms) from the remote user joining to the local user receiving the first remote data packet.
  • If startMediaRenderingTracing is called after the remote user joins the channel, this value is the time interval (ms) from calling startMediaRenderingTracing to receiving the first remote data packet.