VideoRenderingTracingInfo

Metrics during video frame rendering.

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 that startMediaRenderingTracing was called after joinChannel.

join2JoinSuccess

Time interval (ms) from calling joinChannel1 or joinChannel to successfully joining the channel.

joinSuccess2RemoteJoined

Note:

If the local user calls startMediaRenderingTracing after the remote user has joined, this value is 0 and has no reference value.
To improve the remote user's rendering speed, it is recommended that the remote user joins the channel first, followed by the local user, to reduce this value.

If the local user calls startMediaRenderingTracing before successfully joining the channel, this is the time interval (ms) from the local user joining the channel to the remote user joining.
If the local user calls startMediaRenderingTracing after joining the channel, this is the time interval (ms) from calling startMediaRenderingTracing to the remote user joining.

remoteJoined2SetView

Note:

If the local user calls startMediaRenderingTracing after setting the remote view, this value is 0 and has no reference value.
To improve the remote user's rendering speed, it is recommended to set the remote view before the remote user joins, or immediately after the remote user joins, to reduce this value.

If the local user calls startMediaRenderingTracing before the remote user joins the channel, this is the time interval (ms) from the remote user joining to the local user setting the remote view.
If the local user calls startMediaRenderingTracing after the remote user joins, this is the time interval (ms) from calling startMediaRenderingTracing to setting the remote view.

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 remote user's rendering speed, it is recommended to subscribe to the remote video stream immediately after the remote user joins, to reduce this value.

If the local user calls startMediaRenderingTracing before the remote user joins the channel, this is the time interval (ms) from the remote user joining to subscribing to the remote video stream.
If the local user calls startMediaRenderingTracing after the remote user joins, this 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 remote user's rendering speed, it is recommended that the remote user publishes the video stream immediately after joining the channel, and the local user subscribes to the remote video stream immediately, to reduce this value.

If the local user calls startMediaRenderingTracing before the remote user joins the channel, this is the time interval (ms) from the remote user joining to the local user receiving the first remote data packet.
If the local user calls startMediaRenderingTracing after the remote user joins, this is the time interval (ms) from calling startMediaRenderingTracing to receiving the first remote data packet.