VideoRenderingTracingInfo

Metric information during video frame rendering.

@JsonSerializable(explicitToJson: true, includeIfNull: false)
class VideoRenderingTracingInfo {
  const VideoRenderingTracingInfo(
      {this.elapsedTime,
      this.start2JoinChannel,
      this.join2JoinSuccess,
      this.joinSuccess2RemoteJoined,
      this.remoteJoined2SetView,
      this.remoteJoined2UnmuteVideo,
      this.remoteJoined2PacketReceived});

  @JsonKey(name: 'elapsedTime')
  final int? elapsedTime;

  @JsonKey(name: 'start2JoinChannel')
  final int? start2JoinChannel;

  @JsonKey(name: 'join2JoinSuccess')
  final int? join2JoinSuccess;

  @JsonKey(name: 'joinSuccess2RemoteJoined')
  final int? joinSuccess2RemoteJoined;

  @JsonKey(name: 'remoteJoined2SetView')
  final int? remoteJoined2SetView;

  @JsonKey(name: 'remoteJoined2UnmuteVideo')
  final int? remoteJoined2UnmuteVideo;

  @JsonKey(name: 'remoteJoined2PacketReceived')
  final int? remoteJoined2PacketReceived;

  factory VideoRenderingTracingInfo.fromJson(Map<String, dynamic> json) =>
      _$VideoRenderingTracingInfoFromJson(json);

  Map<String, dynamic> toJson() => _$VideoRenderingTracingInfoToJson(this);
}

Properties

elapsedTime
The time interval (ms) from calling startMediaRenderingTracing to triggering the onVideoRenderingTracingResult callback. It is recommended to call startMediaRenderingTracing before joining the channel.
start2JoinChannel
The time interval (ms) from calling startMediaRenderingTracing to calling joinChannel. A negative value indicates that startMediaRenderingTracing was called after joinChannel.
join2JoinSuccess
The 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 the channel, this value is 0 and has no reference value.
  • To improve the speed of remote user video display, it is recommended that the local user joins the channel after the remote user has joined 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 successfully joining the channel to the remote user joining the channel.
  • If the local user calls startMediaRenderingTracing after successfully joining the channel, this is the time interval (ms) from calling startMediaRenderingTracing to the remote user joining the channel.
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 speed of remote user video display, 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.
  • If the local user calls startMediaRenderingTracing before the remote user joins the channel, this is the time interval (ms) from the remote user joining the channel to the local user setting the remote view.
  • If the local user calls startMediaRenderingTracing after the remote user joins the channel, 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 speed of remote user video display, it is recommended that the local user subscribes to the remote video stream immediately after the remote user joins the channel 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 the channel to subscribing to the remote video stream.
  • If the local user calls startMediaRenderingTracing after the remote user joins the channel, 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 speed of remote user video display, 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 the channel to the local user receiving the first remote data packet.
  • If the local user calls startMediaRenderingTracing after the remote user joins the channel, this is the time interval (ms) from calling startMediaRenderingTracing to receiving the first remote data packet.