lib-jitsi-meet
    Preparing search index...

    Statistics class provides various functionality related to collecting and reporting statistics.

    Index

    Constructors

    Properties

    conference: JitsiConference
    eventEmitter: EventEmitter
    options: IStatisticsOptions
    rtpStatsMap: Map<string, StatsCollector>

    The options to configure Statistics.

    The conference instance from which the statistics were initialized.

    The options to use creating the Statistics.

    xmpp: XMPP
    _instances: Set<Statistics>

    Stores all active Statistics instances.

    analytics: {
        addPermanentProperties: (properties: Record<string, any>) => void;
        sendEvent: (
            eventName: string | Record<string, any>,
            properties?: Record<string, any>,
        ) => void;
    } = analytics

    Analytics adapter for sending events.

    audioLevelsEnabled: boolean = false

    Flag indicating whether audio levels are enabled or not.

    audioLevelsInterval: number = 200

    The interval for audio levels stats collection.

    disableThirdPartyRequests: boolean = false

    Flag indicating whether third party requests are disabled.

    LOCAL_JID: string = LOCAL_JID

    Local JID constant.

    localStats: LocalStatsCollector[] = []

    Array holding local statistics collectors.

    pcStatsInterval: number = 10000

    The interval for peer connection stats collection.

    Accessors

    Methods

    • Adds a listener for audio level events.

      Parameters

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

        The listener to add

      Returns void

    • Adds a listener for before disposed events.

      Parameters

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

        The listener to add

      Returns void

    • Adds a listener for byte sent stats events.

      Parameters

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

        The listener to add

      Returns void

    • Adds a listener for connection stats events.

      Parameters

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

        The listener to add

      Returns void

    • Adds a listener for encode time stats events.

      Parameters

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

        The listener to add

      Returns void

    • Removes an audio level listener.

      Parameters

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

        The listener to remove

      Returns void

    • Removes a before disposed listener.

      Parameters

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

        The listener to remove

      Returns void

    • Removes a byte sent stats listener.

      Parameters

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

        The listener to remove

      Returns void

    • Removes a connection stats listener.

      Parameters

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

        The listener to remove

      Returns void

    • Removes an encode time stats listener.

      Parameters

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

        The listener to remove

      Returns 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.

    • 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

    • Init statistic options

      Parameters

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

        The options to initialize statistics with

      Returns 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

    • 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

    • 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