Class Statistics

constructor

• new Statistics(
      conference: JitsiConference,
      options: IStatisticsOptions,
  ): Statistics

  Parameters

  • conference: JitsiConference
  • options: IStatisticsOptions

  Returns Statistics

conference

eventEmitter

options

rtpStatsMap

xmpp

Static_instances

Staticanalytics

StaticaudioLevelsEnabled

StaticaudioLevelsInterval

StaticdisableThirdPartyRequests

StaticLOCAL_JID

StaticlocalStats

StaticpcStatsInterval

Staticinstances

• get instances(): Set<Statistics>

  Static getter for instances property Returns the Set holding all active Statistics instances. Lazily initializes the Set to allow any Set polyfills to be applied.

  Returns Set<Statistics>

addAudioLevelListener

• addAudioLevelListener(listener: (...args: any[]) => void): void

  Adds a listener for audio level events.

  Parameters

  • listener: (...args: any[]) => void

    The listener to add

  Returns void

addBeforeDisposedListener

• addBeforeDisposedListener(listener: (...args: any[]) => void): void

  Adds a listener for before disposed events.

  Parameters

  • listener: (...args: any[]) => void

    The listener to add

  Returns void

addByteSentStatsListener

• addByteSentStatsListener(listener: (...args: any[]) => void): void

  Adds a listener for byte sent stats events.

  Parameters

  • listener: (...args: any[]) => void

    The listener to add

  Returns void

addConnectionStatsListener

• addConnectionStatsListener(listener: (...args: any[]) => void): void

  Adds a listener for connection stats events.

  Parameters

  • listener: (...args: any[]) => void

    The listener to add

  Returns void

addEncodeTimeStatsListener

• addEncodeTimeStatsListener(listener: (...args: any[]) => void): void

  Adds a listener for encode time stats events.

  Parameters

  • listener: (...args: any[]) => void

    The listener to add

  Returns void

addInboundVideoStatsListener

• addInboundVideoStatsListener(listener: (...args: any[]) => void): void

  Adds a listener for inbound video stats events. The event fires when at least one remote video stream is receiving bytes but decoding no frames, and once more with an empty map when all such streams recover.

  Parameters

  • listener: (...args: any[]) => void

    The listener to add

  Returns void

dispose

• dispose(): void

  Disposes of this instance, stopping any ongoing stats collection.

  Returns void

removeAudioLevelListener

• removeAudioLevelListener(listener: (...args: any[]) => void): void

  Removes an audio level listener.

  Parameters

  • listener: (...args: any[]) => void

    The listener to remove

  Returns void

removeBeforeDisposedListener

• removeBeforeDisposedListener(listener: (...args: any[]) => void): void

  Removes a before disposed listener.

  Parameters

  • listener: (...args: any[]) => void

    The listener to remove

  Returns void

removeByteSentStatsListener

• removeByteSentStatsListener(listener: (...args: any[]) => void): void

  Removes a byte sent stats listener.

  Parameters

  • listener: (...args: any[]) => void

    The listener to remove

  Returns void

removeConnectionStatsListener

• removeConnectionStatsListener(listener: (...args: any[]) => void): void

  Removes a connection stats listener.

  Parameters

  • listener: (...args: any[]) => void

    The listener to remove

  Returns void

removeEncodeTimeStatsListener

• removeEncodeTimeStatsListener(listener: (...args: any[]) => void): void

  Removes an encode time stats listener.

  Parameters

  • listener: (...args: any[]) => void

    The listener to remove

  Returns void

removeInboundVideoStatsListener

• removeInboundVideoStatsListener(listener: (...args: any[]) => void): void

  Removes an inbound video stats listener.

  Parameters

  • listener: (...args: any[]) => void

    The listener to remove

  Returns void

sendFeedback

• sendFeedback(overall: number, comment: string): Promise<void>

  Sends the given feedback

  Parameters

  • overall: number

    an integer between 1 and 5 indicating the user's rating.
  • comment: string

    the comment from the user.

  Returns Promise<void>

  Resolves immediately.

setSpeakerList

• setSpeakerList(speakerList: string[]): void

  Updates the list of speakers for which the audio levels are to be calculated. This is needed for the jvb pc only.

  Parameters

  • speakerList: string[]

    The list of remote endpoint ids.

  Returns void

startRemoteStats

• startRemoteStats(peerconnection: TraceablePeerConnection): void

  Starts collecting RTP stats for given peerconnection.

  Parameters

  • peerconnection: TraceablePeerConnection

  Returns void

stopRemoteStats

• stopRemoteStats(tpc: TraceablePeerConnection): void

  Stops collecting RTP stats for given peerconnection

  Parameters

  • tpc: TraceablePeerConnection

  Returns void

Staticinit

• init(
      options: {
          audioLevelsInterval?: number;
          disableAudioLevels?: boolean;
          disableThirdPartyRequests?: boolean;
          pcStatsInterval?: number;
      },
  ): void

  Init statistic options

  Parameters

  • options: {
        audioLevelsInterval?: number;
        disableAudioLevels?: boolean;
        disableThirdPartyRequests?: boolean;
        pcStatsInterval?: number;
    }

    The options to initialize statistics with

  Returns void

  Static

StaticsendAnalytics

• sendAnalytics(
      eventName: string | Record<string, any>,
      properties?: Record<string, any>,
  ): void

  Sends event to analytics.

  Parameters

  • eventName: string | Record<string, any>

    The event name, or an object which represents the entire event
  • properties: Record<string, any> = {}

    Properties to attach to the event

  Returns void

  Static

StaticsendAnalyticsAndLog

• sendAnalyticsAndLog(
      event: string | Record<string, any>,
      properties?: Record<string, any>,
  ): void

  Sends event to analytics and logs a message to the logger/console.

  Parameters

  • event: string | Record<string, any>

    The event name, or an object which represents the entire event
  • properties: Record<string, any> = {}

    Properties to attach to the event

  Returns void

  Static

StaticstartLocalStats

• startLocalStats(track: JitsiTrack, callback: (audioLevel: number) => void): void

  Starts collecting local statistics for a track.

  Parameters

  • track: JitsiTrack

    The track to collect statistics for
  • callback: (audioLevel: number) => void

    The callback to invoke with audio levels

  Returns void

  Static

StaticstopLocalStats

• stopLocalStats(track: JitsiTrack): void

  Stops collecting local statistics for a track.

  Parameters

  • track: JitsiTrack

    The track to stop collecting statistics for

  Returns void

  Static