call.is() returns the requested read-only boolean (true/false) parameter. The provided string argument decides what parameter value to return.
For example call.is("outgoing") returns true if call has been started by us (we called someone).
call.is(key)
| active | returns true if call is not disabled |
| available | returns true if call is idle, available to make a new call |
| connected | returns true while a call is connected, participants can talk to each other |
| connecting | returns true if call is being established |
| couldSendVideo | returns true if this is an audio only call but there is an empty channel available ready to send video |
| dataChannelSupport | returns true if both browsers (yours and the other end of the call) supports data channels |
| dataChannelUp | returns true if a data channel has been established |
| inCall | returns true during entire span of call (dialing, receiving, talking) |
| incoming | returns true if other end started the call |
| inGroupCall | returns true if call is inCall (see above) and part of a group call |
| inNonGroupCall | returns true if call is inCall and not part of a group call |
| localDataChannelSupport | returns true if your browser supports data channels |
| multiAudio | (voiceBridge only) returns true if we are receiving audio from at least one multiUser |
| mutedAudio | returns true if other end's mic is muted |
| mutedVideo | returns true if other end's cam is muted |
| onHold | returns true if we have put call on hold |
| outgoing | returns true if we started the call |
| placing | returns true if an outgoing call is being established |
| putOnHold | returns true if other end of call has put us on hold |
| receiving | returns true if an incoming call is being established |
| receivingStream | true as long as we are receiving audio stream from other end of call - goes false if stream becomes stalled |
| receivingVideo | returns true if we are receiving video |
| recorded | returns true if call is recorded |
| remoteChatSupport | returns true if client at other end of the call is capable of receiving chat messages |
| remoteDataChannelSupport | returns true if browser at other end of the call supports data channels |
| remoteGroupSupport | returns true if client at other end of the call is capable of group calls |
| remoteVideoSupport | returns true if client at other end of the call supports video calls |
| remoteWrtc | returns true if other end of call is a webrtc soft client |
| routedSIP | returns true if call is routed using SIP |
| sendAudio | returns true if we transmit audio in call |
| sendVideo | returns true if we (will) transmit video in call |
| send_SDP | returns true if we are in a state there we are supposed to send SDP |
| To:<addr> | returns true if call is to supplied address or client ID |
| voiceBridge | returns true if this call is to the voice bridge |
| voiceBridgeSIP | returns true if this call is to the voice bridge and there is at least one SIP client connected to the bridge |
| volume | returns true if volume of this call is measured |
You can also use same keys as call.getCallState() to check if call is in a specific call state.
Requested boolean (true/false) value. Return type depends on requested value, see table above
None.