Construct a MediaConnectionBitrateTest instance. The test will start immediately. Test should be allowed to run for a minimum of 8 seconds. To stop the test, call MediaConnectionBitrateTest.stop.
Raised every second with a bitrate
parameter in kbps which represents the connection's bitrate since the last time this event was raised.
The bitrate value is limited by either your downlink or uplink, whichever is lower.
For example, if your downlink and uplink is 50mbps and 10mbps respectively, bitrate value will not exceed 10mbps.
A callback with a bitrate
(kbps) parameter since the last time this event was raised.
This MediaConnectionBitrateTest instance.
Raised when the test encounters an error. When this happens, the test will immediately stop and emit MediaConnectionBitrateTest.Events.End.
A callback with a DiagnosticError parameter.
This MediaConnectionBitrateTest instance.
Raised upon completion of the test.
A callback with a MediaConnectionBitrateTest.Report parameter.
This MediaConnectionBitrateTest instance.
Raised when the test encounters a non-fatal warning during its run-time.
A callback with a WarningName parameter.
This MediaConnectionBitrateTest instance.
Raised when the test clears a previously encountered non-fatal warning during its run-time.
A callback with a WarningName parameter.
This MediaConnectionBitrateTest instance.
Active warnings to keep track of.
Name of this test
Stops the current test.
Generated using TypeDoc
MediaConnectionBitrateTest uses two RTCPeerConnections connected via a Twilio Network Traversal Service. Using RTCDataChannel, one RTCPeerConnection will saturate the data channel buffer and will constantly send data packets to the other RTCPeerConnection. The receiving peer will measure the bitrate base on the amount of packets received every second. See MediaConnectionBitrateTest.Options.iceServers for information how to use Twilio NTS.