Options that may be passed to the Device constructor for internal testing.
Custom AudioHelper constructor
Custom Publisher constructor
Overrides the native RTCPeerConnection class.
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.
Audio Constraints to pass to getUserMedia when making or accepting a Call.
This is placed directly under audio of the MediaStreamConstraints object.
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.
Custom Connection constructor
Whether to enable debug logging.
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. You may not specify both edge and
region in the Device options. Specifying both edge and region will
result in an InvalidArgumentException.
Whether to automatically restart ICE when media connection fails
Whether the ringing state should be enabled on Connection objects. This is required to enable answerOnBridge functionality.
Overrides the native MediaDevices.enumerateDevices API.
Hostname of the event gateway to connect to.
Whether or not to override the local DTMF sounds with fake dialtones. This won't affect the DTMF tone sent over the connection, but will prevent double-send issues caused by using real DTMF tones for user interface. In 2.0, this will be enabled by default.
File input stream to use instead of reading from mic
Experimental feature. Whether to use ICE Aggressive nomination.
Overrides the native MediaDevices.getUserMedia API.
A list of specific ICE servers to use. Overridden by Device.Options.rtcConfiguration.
Ignore browser support, disabling the exception that is thrown when neither WebRTC nor ORTC are supported.
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.
Whether to disable audio flag in MediaPresence (rrowland: Do we need this?)
Custom PStream constructor
Whether this is a preflight call or not
Whether Insights events should be published
The region code of the region to connect to.
An RTCConfiguration to pass to the RTCPeerConnection constructor.
RTC Constraints to pass to getUserMedia when making or accepting a Call. The format of this object depends on browser.
Custom Sound constructor
A mapping of custom sound URLs by sound name.
Whether to enable warn logging.
Generated using TypeDoc
Options that may be passed to the Device constructor for internal testing.