Class: MeasurementSet

measurement-set~MeasurementSet(latency, jitterUp, jitterDown, bandwidthUp, bandwidthDown, packetlossUp, packetlossDown)

Represents a complete q4s session quality measures. This class contains methods to serve as reference quality metric. Contains too methods that allow to map server and client measures into a session set of measures.

Constructor

new MeasurementSet(latency, jitterUp, jitterDown, bandwidthUp, bandwidthDown, packetlossUp, packetlossDown)

Constructor for the MeasurementSet class. Does not validate input data coherence. Simply sets the passed data into the object.
Parameters:
Name Type Description
latency Number RTT latency. ms
jitterUp Number Jitter in the uplink. ms
jitterDown Number Jitter in the downlink.ms
bandwidthUp Number Bandwidth in the uplink. kbits/s
bandwidthDown Number Bandwidth in the downlink. kbits/s
packetlossUp Number Packet loss in the uplink. Probability.
packetlossDown Number Packet loss in the downlink. Probability.
Source:

Members

bandwidthDown :Number

Bandwidth in the downlink. kbits/s
Type:
  • Number
Source:

bandwidthUp :Number

Bandwidth in the uplink. kbits/s
Type:
  • Number
Source:

jitterDown :Number

Jitter in the downlink.ms
Type:
  • Number
Source:

jitterUp :Number

Jitter in the uplink. ms
Type:
  • Number
Source:

latency :Number

RTT latency. ms
Type:
  • Number
Source:

packetlossDown :Number

Packet loss in the downlink. Probability.
Type:
  • Number
Source:

packetlossUp :Number

Packet loss in the uplink. Probability.
Type:
  • Number
Source:

Methods

constrain(constr)

Given an object wich contains maximum and minimum possible values. The attributes of this object are constrained between maximum and minimum values.
Parameters:
Name Type Description
constr Object
Properties
Name Type Description
latency.max Number
latency.min Number
jitterUp.max Number
jitterUp.min Number
jitterDown.max Number
jitterDown.min Number
bandwidthUp.max Number
bandwidthUp.min Number
bandwidthDown.max Number
bandwidthDown.min Number
packetlossUp.max Number
packetlossUp.min Number
packetlossDown.max Number
packetlossDown.min Number
Source:

doesMetQuality(measurement) → {bool}

Given another instance of MeasurementSet check those measures with this object as reference.
Parameters:
Name Type Description
measurement MeasurementSet Measures to be checked.
Source:
Returns:
True if the requirements where fullfilled false otherwise
Type
bool

introduceClientMeasures(measure)

Import a measure generated by the client. The imported measure overrrides the current attributes.
Parameters:
Name Type Description
measure Measure A client measure.
Source:

introduceServerMeasures(measure)

Import a measure generated by the server. The imported measure overrrides the current attributes.
Parameters:
Name Type Description
measure Measure A server measure.
Source:

requireReady1() → {Boolean}

Determines if continuity bandwidth measurements are required, given the object as a reference metrics.
Source:
Returns:
- True if required otherwise false
Type
Boolean

toSDPAttr() → {String}

Returns a string form of the information in this object. This view is intended to be included inside an sdp.
Source:
Returns:
- The SDP attributes.
Type
String

updateWithSDP(sdp)

Parses a string finding sdp attributes related to mesurement levels. If any attribute is found parsing the string, the object gets updated with the parsed value.
Parameters:
Name Type Description
sdp String Contains one or more sdp atttributes.
Source: