Type alias SfuMonitorConfig

SfuMonitorConfig: {
    accumulator?: AccumulatorConfig;
    collectingPeriodInMs?: number;
    createSfuEvents?: boolean;
    logLevel: LogLevel;
    maxListeners?: number;
    pollingBatchPaceTimeInMs?: number;
    pollingBatchSize?: number;
    samplingPeriodInMs?: number;
    sendingPeriodInMs?: number;
    sfuId: string;
    tickingTimeInMs?: number;
}

Type declaration

  • Optional accumulator?: AccumulatorConfig

    If the sender component is configured, accumulator sets the buffer between sampling and sending.

  • Optional collectingPeriodInMs?: number

    By setting it, the observer calls the added statsCollectors periodically and pulls the stats.

    DEFAULT: undefined

  • Optional createSfuEvents?: boolean

    Flag indicating if the monitor creates sfu events. If true, events happening on the collected sources create sfu events such as SFU_TRANSPORT_OPENED, SFU_TRANSPORT_CLOSED.

    If this flag is false, the application is responsible for adding sfu events by calling the appropriate SfuMonitor method for the corresponding event.

    DEFAULT: false

  • logLevel: LogLevel

    Sets the default logging level for sfu-monitor-js

  • Optional maxListeners?: number

    Sets the maximum number of listeners for event emitters

  • Optional pollingBatchPaceTimeInMs?: number

    Pacing time between polling batches of stats

  • Optional pollingBatchSize?: number

    Limits the number of stats polled at once from the collector.

  • Optional samplingPeriodInMs?: number

    By setting it, the observer make samples periodically.

    DEFAULT: undefined

  • Optional sendingPeriodInMs?: number

    By setting it, the observer sends the samples periodically.

    DEFAULT: undefined

  • sfuId: string

    The identifier of the SFU.

    DEFAULT: a generated unique value

  • Optional tickingTimeInMs?: number

    Set the ticking time of the timer invokes processes for collecting, sampling, and sending.

    DEFAULT: 1000

Generated using TypeDoc