Class Stats

externalStats

rttSamples

showStatus

_constructBaseBlock

• _constructBaseBlock(): void

• Returns void

addBusinessStats

• addBusinessStats(newData): void

• Parameters

  • newData: IBusinessMetric[]

    需要添加到 stats 的数据

  Returns void

  Description

  业务增加需要在 stats 中显示的数据

appendDynamicCollector

• appendDynamicCollector(func): void

• 注入收集函数

  Parameters

  • func: IStatsCollector

  Returns void

appendLagAnalyzeCollector

• appendLagAnalyzeCollector(func): void

• Parameters

  • func: ILagCollectors

  Returns void

assignStaticStats

• assignStaticStats(stats): void

• Parameters

  • stats: Partial<IStaticStats>

  Returns void

destroy

• destroy(): void

• Returns void

getFps

• getFps(): number

• 获取当前的 FPS

  Returns number

getRtcFps

• getRtcFps(): undefined | number

• 获取RTC收帧FPS

  Returns undefined | number

getRtt

• getRtt(): number

• 获取当前的 Rtc RTT，ms

  Returns number

getSDKVersion

• getSDKVersion(): string

• 获取SDK版本

  Returns string

getStats

• getStats(): {
      activeAnimation: number;
      activeBones: number;
      activeParticles: number;
      animationTime: number;
      appId: string;
      audioCount: number;
      avatar: IAvatarStats;
      avatarNumber: number;
      avgJoystickDiff: number;
      beforeCameraRenderTime: number;
      browser: string;
      browserEngine: string;
      browserVersion: string;
      bufReadyNotUse: number;
      bufWaitGPU: number;
      bufferDropCount: number;
      bweKbps: number;
      centerDiff: string;
      decoderStats: StatData;
      drawcall: number;
      drawcallTime: number;
      engineVersion: string;
      env: string;
      fps: number;
      interFrameTime: number;
      joystickProtoMode: EJoystickProtoMode;
      mainTickRunning: boolean;
      maxJoystickDiff: number;
      maxVideoJump: number;
      meanReadPixelDeltaTime: string;
      meshSelectTime: number;
      model: string;
      movementTriggerMode: IMovementTriggerMode;
      networkQuality: MainNetworkQualityDetail;
      oldFrameDueWaitGPU: number;
      onlinePathType: EOnlinePathType;
      os: string;
      osVersion: string;
      quality: string;
      readPixelRunning: boolean;
      readPixelTimeMean: number;
      registerAfterCount: number;
      registerAfterRenderTime: number;
      registerBeforeCount: number;
      registerBeforeRenderTime: number;
      releaseId: string;
      renderAvatarTriangle: number;
      renderDeltaTime: number;
      renderFrameTime: number;
      renderTargetRenderTime: number;
      resolution: string;
      scaling: string;
      sdJoystickDiff: number;
      sdkVersion: string;
      skeletonAvatarNumber: number;
      softSkinningTime: number;
      systemBenchmark: string;
      terminalType: string;
      timerCount: number;
      totalGeometries: number;
      totalLowpolyTriangle: number;
      totalMaterials: number;
      totalMeshes: number;
      totalRootNodes: number;
      totalTextures: number;
      transportState: ITransportState;
      triangle: number;
      userId: string;
      vatAvatarNumber: number;
      vender: string;
      videoCount: number;
      videoFrameJumpCount: number;
      videoJumpRatio: number;
      webgl: string;
      worldStage: EWorldStage;
      xmitStats: any;
      xrtcStats: IRTCStats;
  }

• 获取最新的 Stats 数据

  Returns {
      activeAnimation: number;
      activeBones: number;
      activeParticles: number;
      animationTime: number;
      appId: string;
      audioCount: number;
      avatar: IAvatarStats;
      avatarNumber: number;
      avgJoystickDiff: number;
      beforeCameraRenderTime: number;
      browser: string;
      browserEngine: string;
      browserVersion: string;
      bufReadyNotUse: number;
      bufWaitGPU: number;
      bufferDropCount: number;
      bweKbps: number;
      centerDiff: string;
      decoderStats: StatData;
      drawcall: number;
      drawcallTime: number;
      engineVersion: string;
      env: string;
      fps: number;
      interFrameTime: number;
      joystickProtoMode: EJoystickProtoMode;
      mainTickRunning: boolean;
      maxJoystickDiff: number;
      maxVideoJump: number;
      meanReadPixelDeltaTime: string;
      meshSelectTime: number;
      model: string;
      movementTriggerMode: IMovementTriggerMode;
      networkQuality: MainNetworkQualityDetail;
      oldFrameDueWaitGPU: number;
      onlinePathType: EOnlinePathType;
      os: string;
      osVersion: string;
      quality: string;
      readPixelRunning: boolean;
      readPixelTimeMean: number;
      registerAfterCount: number;
      registerAfterRenderTime: number;
      registerBeforeCount: number;
      registerBeforeRenderTime: number;
      releaseId: string;
      renderAvatarTriangle: number;
      renderDeltaTime: number;
      renderFrameTime: number;
      renderTargetRenderTime: number;
      resolution: string;
      scaling: string;
      sdJoystickDiff: number;
      sdkVersion: string;
      skeletonAvatarNumber: number;
      softSkinningTime: number;
      systemBenchmark: string;
      terminalType: string;
      timerCount: number;
      totalGeometries: number;
      totalLowpolyTriangle: number;
      totalMaterials: number;
      totalMeshes: number;
      totalRootNodes: number;
      totalTextures: number;
      transportState: ITransportState;
      triangle: number;
      userId: string;
      vatAvatarNumber: number;
      vender: string;
      videoCount: number;
      videoFrameJumpCount: number;
      videoJumpRatio: number;
      webgl: string;
      worldStage: EWorldStage;
      xmitStats: any;
      xrtcStats: IRTCStats;
  }

  • activeAnimation: number

  • activeBones: number

  • activeParticles: number

  • animationTime: number

  • appId: string

  • audioCount: number

  • avatar: IAvatarStats

  • avatarNumber: number

  • avgJoystickDiff: number

  • beforeCameraRenderTime: number

  • browser: string

  • browserEngine: string

  • browserVersion: string

  • bufReadyNotUse: number

  • bufWaitGPU: number

  • bufferDropCount: number

  • bweKbps: number

  • centerDiff: string

  • decoderStats: StatData

  • drawcall: number

  • drawcallTime: number

  • engineVersion: string

  • env: string

  • fps: number

  • interFrameTime: number

  • joystickProtoMode: EJoystickProtoMode

  • mainTickRunning: boolean

  • maxJoystickDiff: number

  • maxVideoJump: number

  • meanReadPixelDeltaTime: string

  • meshSelectTime: number

  • model: string

  • movementTriggerMode: IMovementTriggerMode

  • networkQuality: MainNetworkQualityDetail

  • oldFrameDueWaitGPU: number

  • onlinePathType: EOnlinePathType

  • os: string

  • osVersion: string

  • quality: string

  • readPixelRunning: boolean

  • readPixelTimeMean: number

  • registerAfterCount: number

  • registerAfterRenderTime: number

  • registerBeforeCount: number

  • registerBeforeRenderTime: number

  • releaseId: string

  • renderAvatarTriangle: number

  • renderDeltaTime: number

  • renderFrameTime: number

  • renderTargetRenderTime: number

  • resolution: string

  • scaling: string

  • sdJoystickDiff: number

  • sdkVersion: string

  • skeletonAvatarNumber: number

  • softSkinningTime: number

  • systemBenchmark: string

  • terminalType: string

  • timerCount: number

  • totalGeometries: number

  • totalLowpolyTriangle: number

  • totalMaterials: number

  • totalMeshes: number

  • totalRootNodes: number

  • totalTextures: number

  • transportState: ITransportState

  • triangle: number

  • userId: string

  • vatAvatarNumber: number

  • vender: string

  • videoCount: number

  • videoFrameJumpCount: number

  • videoJumpRatio: number

  • webgl: string

  • worldStage: EWorldStage

  • xmitStats: any

  • xrtcStats: IRTCStats

getXmitNetworkQuality

• getXmitNetworkQuality(): MainNetworkQualityDetail

• 获取网络质量评分

  Returns MainNetworkQualityDetail

getXmitRtt

• getXmitRtt(): number

• 获取当前的 xmit RTT，ms

  Returns number

hide

• hide(): void

• 关闭 stats 控件

  Returns void

injectStyle

• injectStyle(): void

• Returns void

removeDynamicCollector

• removeDynamicCollector(func): void

• Parameters

  • func: IStatsCollector

  Returns void

removeLagAnalyzeCollector

• removeLagAnalyzeCollector(func): void

• Parameters

  • func: ILagCollectors

  Returns void

setExternalStats

• setExternalStats(data): void

• 外部上报额外统计数据

  Parameters

  • data: Record<string, any>

  Returns void

show

• show(): void

• 展示 stats 控件

  Returns void