Package com.twilio.voice
Class PreflightTest
java.lang.Object
com.twilio.voice.PreflightTest
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic interface
static enum
An enum describing the possible states of PreflightTest. -
Method Summary
Modifier and TypeMethodDescriptionprotected void
finalize()
Returns the call SID for the Preflight test calllong
Preflight test End time since Epoch in millisecondsorg.json.JSONObject
Returns the latest stats sample for the Preflight testorg.json.JSONObject
Returns the preflight test report.long
Preflight test start time since Epoch in millisecondsgetState()
Returns the current state of the Preflight testvoid
stop()
Stops the ongoing preflight test.
-
Method Details
-
stop
public void stop()Stops the ongoing preflight test. This will result in Preflight test to be in `kFailed` state. -
getCallSid
Returns the call SID for the Preflight test call- Returns:
- String
-
getStartTime
public long getStartTime()Preflight test start time since Epoch in milliseconds- Returns:
- long
-
getEndTime
public long getEndTime()Preflight test End time since Epoch in milliseconds- Returns:
- long
-
getLatestSample
public org.json.JSONObject getLatestSample()Returns the latest stats sample for the Preflight test- Returns:
- StatsSample as a JSONObject defined by the StatsSample Schema.
-
getReport
public org.json.JSONObject getReport()Returns the preflight test report. If called when the preflight status is anything other than kCompleted, an empty report is returned.- Returns:
- PreflightReport as a JSONObject defined by the PreflightReport Schema.
This schema refers to different sub-schemas for the various metrics and events it reports. The schemas for these individual metrics and events can be found at:Aggregate Stats - Schema
Network Stats - Schema
Time Measurement Stats - Schema
Network Timing Stats - Schema
Warning Stats - Schema
Warning Cleared Stats - Schema
Ice Candidate Stats - Schema
Selected Ice Candidate Pair Stats - Schema
Media Sample Stats - Schema
-
getState
Returns the current state of the Preflight test- Returns:
- PreflightState
-
finalize
-