get()
The get function returns the requested read-only parameter. The provided string argument decides what parameter value to return.
For example wrtc.get("clientID") returns client's unique identification as string.
Arguments
wrtc.get(key)
- key - string containing what argument to return:
| audioDestinations | (Chrome only) returns an array of available audio destinations |
| audioSources | (Chrome only) returns an array of available audio sources |
| groupCallStat | returns JSON array containing group call progress status |
| localBridgeAddress | returns string containing full SIP address of voice bridge of IXNX server |
| localBridgeDisplayName | returns string containing descriptive name of voice bridge of IXNX server |
| localBridgeName | returns string containing SIP name (before @ in address) of voice bridge of IXNX server |
| localStream | returns a MediaStream object containing media from local mic/cam |
| log | returns string containing internal log |
| multiUser | returns list of users connected to voice bridge |
| nrCalls | returns number of calls in progress |
| onlineList | returns list of online users |
| RESTtoken | returns last received REST authentication token |
| serverName | returns name of RTCgate server |
| serverVersion | returns version number of RTCgate server |
| usersList | returns list of online users |
| videoSources | (Chrome only) returns an array of available video sources |
wrtc.get() also recognizes and returns same arguments as wrtc.is(). Thus for example wrtc.get("camMuted") returns the same as wrtc.is("camMuted").
Nonrecognized arguments return undefined.
Returns
Requested value. Return type depends on requested value, see table above
Events
None.
