The is function returns the requested read-only boolean (true/false) parameter. The provided string argument decides what parameter value to return.
For example wrtc.is("camMuted") returns true if camera is currently muted.
wrtc.is(key)
| behindQturn | returns true if this PC is on a local LAN behind IXNX unit with QTURN server |
| camMuted | returns true if local camera is muted |
| channelReady | returns true if there is a websocket connection to the RTCgate server |
| lineAvailable | returns true if there is any free line object available not involved in any call but ready to receive incoming calls |
| localDataChannelSupport | undefined until first call has been made, then returns true if your browser supports data channels, false if not |
| https | returns true if webpage has been loaded using HTTPS |
| inCall | returns true if there is any ongoing call right now |
| inGroupCall | returns true if there is a group call going on right now |
| Internet | returns a promise that resolves to true/false within 2 seconds indicating if there is Internet access (or nothing if called within 5 seconds of previous call) |
| mediaAvailable | returns true if client at any point has had access to local mic or cam (even if wrtc.get("localStream") right now is undefined) |
| micMuted | returns true if local microphone is muted |
| online | returns true if client is logged in to RTCgate server |
| overload | returns true if data connection to IXNX server experiences connection problems with excessive packet resends |
| SIP | returns true if all lines are SIP registered |
| pushNotifications | returns true if push notifications are enabled and active |
| useQturn | returns true if QTURN server is used |
You can also use same arguments as call.is() to see if there are any matching calls. Eg wrtc.is("connecting") returns true if any call is in progress of being connected right now.
Requested boolean (true/false) value. Return type depends on requested value, see table above
None.