Interface SfuMonitor

SfuMonitor is responsible for monitoring and collecting SFU-related data.

Hierarchy

  • SfuMonitor

Properties

closed config metrics sfuId storage

Methods

addExtensionStats addRtpStreamAdded addRtpStreamRemoved addTransportClosedEvent addTransportOpenedEvent close collect createAuxCollector createMediasoupCollector sample send setMarker

Properties

Readonly closed

closed: boolean

Indicates if the SfuObserver is closed or not.

Readonly config

config: SfuMonitorConfig

The SfuMonitor configuration object.

Readonly metrics

metrics: MonitorMetrics

Access to general monitor-related metrics.

Readonly sfuId

sfuId: string

Gets the SFU identifier.

Readonly storage

storage: StatsReader

Access to the collected stats.

Methods

addExtensionStats

  • Adds an arbitrary stats object that will be sent to the backend observer.

    Parameters

    • stats: ExtensionStat

      The arbitrary stats object.

    Returns void

addRtpStreamAdded

  • Adds an RTP stream added event to the SFU event list.

    Parameters

    • transportId: string

      The identifier of the transport associated with the RTP stream.

    • rtpPadId: string

      The identifier of the RTP pad.

    • sfuStreamId: string

      The identifier of the SFU stream.

    • Optional sfuSinkId: string

      Optional identifier of the SFU sink.

    • Optional timestamp: number

      Optional timestamp for the event. If not provided, the current date and time will be used.

    Returns void

addRtpStreamRemoved

  • Adds an RTP stream removed event to the SFU event list.

    Parameters

    • transportId: string

      The identifier of the transport associated with the RTP stream.

    • rtpPadId: string

      The identifier of the RTP pad.

    • sfuStreamId: string

      The identifier of the SFU stream.

    • Optional sfuSinkId: string

      Optional identifier of the SFU sink.

    • Optional timestamp: number

      Optional timestamp for the event. If not provided, the current date and time will be used.

    Returns void

addTransportClosedEvent

  • Adds a transport closed event to the custom SFU event list.

    Parameters

    • transportId: string

      The identifier of the closed transport.

    • Optional timestamp: number

      Optional timestamp for the event. If not provided, the current date and time will be used.

    Returns void

addTransportOpenedEvent

  • Adds a transport opened event to the custom SFU event list.

    Parameters

    • transportId: string

      The identifier of the opened transport.

    • Optional timestamp: number

      Optional timestamp for the event. If not provided, the current date and time will be used.

    Returns void

close

  • Closes the observer and all its used resources.

    Returns void

collect

createAuxCollector

createMediasoupCollector

sample

  • Creates a sfu sample from the collected stats.

    Returns void

send

setMarker

  • Marks all of the created samples with a given string.

    Parameters

    • marker: string

      The string to mark the samples with.

    Returns void

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc