Interface StatsReader

Collection of methods to read the collected and organized stats

Hierarchy

StatsReader

Index

Methods

dump getInboundRtpPad getNumberOfInboundRtpPads getNumberOfOutboundRtpPads getNumberOfSctpChannels getNumberOfTransports getOutboundRtpPad getSctpChannel getTransportEntry inboundRtpPads outboundRtpPads sctpChannels transports

Methods

dump

dump(withStats: boolean): string
Dump the content of the storage
Parameters
- withStats: boolean
  
  flag indicating if the stats of the entries should be included or not
Returns string
- Defined in src/entries/StatsStorage.ts:89

getInboundRtpPad

getInboundRtpPad(id: string): undefined | SfuInboundRtpPadEntry
Gets the monitored object based on identifier
Parameters
- id: string
  
  the identifier of the inbound RTP stream the monitored entry belongs to
Returns undefined | SfuInboundRtpPadEntry
- Defined in src/entries/StatsStorage.ts:41

getNumberOfInboundRtpPads

getNumberOfInboundRtpPads(): number
Gets the number of tracked inbound rtp pads

Returns number
- Defined in src/entries/StatsStorage.ts:73

getNumberOfOutboundRtpPads

getNumberOfOutboundRtpPads(): number
Gets the number of tracked outbound rtp pads

Returns number
- Defined in src/entries/StatsStorage.ts:78

getNumberOfSctpChannels

getNumberOfSctpChannels(): number
Gets the number of tracked sctp channel

Returns number
- Defined in src/entries/StatsStorage.ts:83

getNumberOfTransports

getNumberOfTransports(): number
Gets the number of tracked transports

Returns number
- Defined in src/entries/StatsStorage.ts:68

getOutboundRtpPad

getOutboundRtpPad(id: string): undefined | SfuOutboundRtpPadEntry
Gets the monitored object based on identifier
Parameters
- id: string
  
  the identifier of the outbound RTP stream the monitored entry belongs to
Returns undefined | SfuOutboundRtpPadEntry
- Defined in src/entries/StatsStorage.ts:52

getSctpChannel

getSctpChannel(id: string): undefined | SfuSctpChannelEntry
Gets the monitored object based on identifier
Parameters
- id: string
  
  the identifier of the SCTP channel the monitored entry belongs to
Returns undefined | SfuSctpChannelEntry
- Defined in src/entries/StatsStorage.ts:63

getTransportEntry

getTransportEntry(id: string): undefined | SfuTransportEntry
Gets the monitored object based on identifier
Parameters
- id: string
  
  the identifier of the transport the monitored entry belongs to
Returns undefined | SfuTransportEntry
- Defined in src/entries/StatsStorage.ts:30

inboundRtpPads

inboundRtpPads(): Generator<SfuInboundRtpPadEntry, void, undefined>
Iterable iterator to list all collected inbound rtp pads

Returns Generator<SfuInboundRtpPadEntry, void, undefined>
- Defined in src/entries/StatsStorage.ts:35

outboundRtpPads

outboundRtpPads(): Generator<SfuOutboundRtpPadEntry, void, undefined>
Iterable iterator to list all collected outbound rtp pads

Returns Generator<SfuOutboundRtpPadEntry, void, undefined>
- Defined in src/entries/StatsStorage.ts:46

sctpChannels

sctpChannels(): Generator<SfuSctpChannelEntry, void, undefined>
Iterable iterator to list all collected sctp channels

Returns Generator<SfuSctpChannelEntry, void, undefined>
- Defined in src/entries/StatsStorage.ts:57

transports

transports(): Generator<SfuTransportEntry, void, undefined>
Iterable iterator to list all collected transports

Returns Generator<SfuTransportEntry, void, undefined>
- Defined in src/entries/StatsStorage.ts:24

Generated using TypeDoc