Custom AudioHelper constructor
Custom Call constructor
MediaStream constructor.
Custom PStream constructor
Custom Publisher constructor
Custom Sound constructor
Whether the Device should raise the incomingEvent event when a new call invite is received while already on an active call. Default behavior is false.
A name for the application that is instantiating the Device. This is used to improve logging in Insights by associating Insights data with a specific application, particularly in the case where one account may be connected to by multiple applications.
A version for the application that is instantiating the Device. This is used to improve logging in Insights by associating Insights data with a specific version of the given application. This can help track down when application-level bugs were introduced.
The max amount of time in milliseconds to allow stream (re)-connect backoffs.
Hostname of the signaling gateway to connect to.
Whether to enable close protection, to prevent users from accidentally navigating away from the page during a call. If string, the value will be used as a custom message.
An ordered array of codec names, from most to least preferred.
Whether AudioContext sounds should be disabled. Useful for trouble shooting sound issues that may be caused by AudioContext-specific sounds. If set to true, will fall back to HTMLAudioElement sounds.
Whether to use googDscp in RTC constraints.
The edge value corresponds to the geographic location that the client will use to connect to Twilio infrastructure. The default value is "roaming" which automatically selects an edge based on the latency of the client relative to available edges.
Hostname of the event gateway to connect to.
File input stream to use instead of reading from mic
Experimental feature. Whether to use ICE Aggressive nomination.
Ignore browser support, disabling the exception that is thrown when neither WebRTC nor ORTC are supported.
Log level.
The maximum average audio bitrate to use, in bits per second (bps) based on RFC-7587 7.1. By default, the setting is not used. If you specify 0, then the setting is not used. Any positive integer is allowed, but values outside the range 6000 to 510000 are ignored and treated as 0. The recommended bitrate for speech is between 8000 and 40000 bps as noted in RFC-7587 3.1.1.
The maximum duration to attempt to reconnect to a preferred URI. This is used by signaling reconnection in that during the existence of any call, edge-fallback is disabled until this length of time has elapsed.
Using a value of 30000 as an example: while a call exists, the Device will attempt to reconnect to the edge that the call was established on for approximately 30 seconds. After the next failure to connect, the Device will use edge-fallback.
This feature is opt-in, and will not work until a number greater than 0 is explicitly specified within the Device options.
Whether this is a preflight call or not
Whether or not to publish events to insights using {@link Device._publisher}.
MediaStreamConstraints to pass to getUserMedia when making or accepting a Call.
A mapping of custom sound URLs by sound name.
Number of milliseconds fewer than the token's TTL to emit the tokenWillExpire event. Default is 10000 (10 seconds).
Generated using TypeDoc
Options that may be passed to the Device constructor for internal testing.