Type Alias WebRTCStatsEvents

Type declaration

• error:function

  • error(reason): void

  • Event triggered when an error is triggered by this library.

    Parameters

    • reason: string

      The reason of the error.

    Returns void

    Example

    import { WebRTCStats } from '@dolbyio/webrtc-stats';
    
    const collection = new WebRTCStats({
        getStatsInterval: 1000,
        getStats: () => {
            // TODO: return the statistics.
        },
    });
    
    collection.on('error', (reason: string) => {
        // An error has been triggered
        console.error(reason);
    });
    Copy

• stats:function

  • stats(stats): void

  • Event triggered when the statistics are available.

    Parameters

    • stats: OnStats

      The OnStats object that contains the collected WebRTC statistics.

    Returns void

    Example

    import { WebRTCStats, OnStats } from '@dolbyio/webrtc-stats';
    
    const collection = new WebRTCStats({
        getStatsInterval: 1000,
        getStats: () => {
            // TODO: return the statistics.
        },
    });
    
    collection.on('stats', (stats: OnStats) => {
        // The statistics are available
        console.log(stats);
    });
    Copy