VideoRenderingTracingInfo

Indicators during video frame rendering progress.

@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);
}

Attributes

elapsedTime
The time interval (ms) from startMediaRenderingTracing to SDK triggering the onVideoRenderingTracingResult callback. Agora recommends you call startMediaRenderingTracing before joining a channel.
start2JoinChannel
The time interval (ms) from startMediaRenderingTracing to joinChannel. A negative number indicates that startMediaRenderingTracing is called after calling joinChannel.
join2JoinSuccess
The time interval (ms) from or joinChannel to successfully joining the channel.
joinSuccess2RemoteJoined
  • If the local user calls startMediaRenderingTracing before successfully joining the channel, this value 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, the value is the time interval (ms) from startMediaRenderingTracing to when the remote user joins the channel.
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 (ms) from when the remote user joins the channel to when the local user sets the remote view.
  • If the local user calls startMediaRenderingTracing after the remote user joins the channel, this value is the time interval (ms) from calling startMediaRenderingTracing to setting the remote view.
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 (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 value is the time interval (ms) from startMediaRenderingTracing to subscribing to the remote video stream.
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 (ms) from when the remote user joins the channel to when the local user receives the remote video stream.
  • If the local user calls startMediaRenderingTracing after the remote user joins the channel, this value is the time interval (ms) from startMediaRenderingTracing to receiving the remote video stream.
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.