Documentation

Class: PreflightTest

PreflightTest

A PreflightTest monitors progress of an ongoing preflight test.

Instance of PreflightTest is returned by calling module:twilio-video.runPreflight

Fires:

Extends

  • EventEmitter

Methods

stop()

stops ongoing tests and emits error

Events

completed

Preflight test has completed successfully.

Parameters:
Name Type Description
report PreflightTestReport

Results of the test.

failed

Preflight test has encountered a failure and is now stopped.

Parameters:
Name Type Description
error TwilioError | Error

A TwilioError or a DOMException. Possible TwilioErrors include Signaling and Media related errors which can be found here.
report PreflightTestReport

Partial results gathered during the test. Use this information to help determine the cause of failure.

progress

Emitted to indicate progress of the test

Parameters:
Name Type Description
progress PreflightProgress

Indicates the status completed.