Class Index | File Index

Classes


Namespace SIPml


Defined in: SIPml.js.

Namespace Summary
Constructor Attributes Constructor Name and Description
 
Root namesapce.
Method Summary
Method Attributes Method Name and Description
<static>  
Gets the web browser friendly name (e.g.
<static>  
Gets the web browser version (e.g.
<static>  
Gets the Operating System friendly name (e.g.
<static>  
Gets the version name of the installed webrtc4all plugin.
<static>  
Checks whether the media engine have a valid stream or not.
<static>  
SIPml.init(readyCallback, errorCallback)
Initialize the engine.
<static>  
SIPml.isInitialized()
Checks whether the engine is initialized or not.
<static>  
Checks whether the web browser supports WebRTC but is outdated.
<static>  
SIPml.isReady()
Checks whether the engine is ready to make/receive calls or not.
<static>  
Checks whether the webrtc4all plugin is outdated or not.
<static>  
Checks whether the webrtc4all plugin is installed or not.
<static>  
Checks whether WebRTC is supported or not.
<static>  
Checks whether WebSocket is supported or not.
Namespace Detail
SIPml
Root namesapce.
Method Detail
<static> {String} SIPml.getNavigatorFriendlyName()
Gets the web browser friendly name (e.g. 'chrome', 'firefox', 'safari', 'opera', 'ie' or 'netscape'). You must initialize the engine before calling this function.
Throws:
{ERR_NOT_INITIALIZED}
ERR_NOT_INITIALIZED if the engine is not initialized.
Returns:
{String} The web browser friendly name.

<static> {String} SIPml.getNavigatorVersion()
Gets the web browser version (e.g. '1.5.beta'). You must initialize the engine before calling this function.
Throws:
{ERR_NOT_INITIALIZED}
ERR_NOT_INITIALIZED if the engine is not initialized.
Returns:
{String} The the web browser version.

<static> {String} SIPml.getSystemFriendlyName()
Gets the Operating System friendly name (e.g. 'windows', 'mac', 'lunix', 'solaris', 'sunos' or 'powerpc'). You must initialize the engine before calling this function.
Throws:
{ERR_NOT_INITIALIZED}
ERR_NOT_INITIALIZED if the engine is not initialized.
Returns:
{String} The Operating System friendly name.

<static> {String} SIPml.getWebRtc4AllVersion()
Gets the version name of the installed webrtc4all plugin. You must initialize the engine before calling this function.
Throws:
{ERR_NOT_INITIALIZED}
ERR_NOT_INITIALIZED if the engine is not initialized.
Returns:
{String} Version name (e.g. '1.12.756')

<static> {Boolean} SIPml.haveMediaStream()
Checks whether the media engine have a valid stream or not. The stream is from getUserMedia.
Returns:
{Boolean} true if the engine have a valid stream; otherwise false

<static> SIPml.init(readyCallback, errorCallback)
Initialize the engine. You must call this function before any other..
SIPml.init(function(e){ console.info('engine is ready'); }, function(e){ console.info('Error: ' + e.message); });
Parameters:
{CallbackFunction} readyCallback Optional
Optional callback function to call when the stack finish initializing and become ready.
{CallbackFunction} errorCallback Optional
Optional callback function to call when initialization fails.

<static> {Boolean} SIPml.isInitialized()
Checks whether the engine is initialized or not. To initialize the stack you must call init() function.
Returns:
{Boolean} true if the engine is initialized; otherwise false

<static> {Boolean} SIPml.isNavigatorOutdated()
Checks whether the web browser supports WebRTC but is outdated. You must initialize the engine before calling this function.
Throws:
{ERR_NOT_INITIALIZED}
ERR_NOT_INITIALIZED if the engine is not initialized.
Returns:
{Boolean} true if outdated; otherwise false

<static> {Boolean} SIPml.isReady()
Checks whether the engine is ready to make/receive calls or not.
The engine is ready when:
Throws:
{ERR_NOT_INITIALIZED}
ERR_NOT_INITIALIZED if the engine is not initialized.
Returns:
{Boolean} true if the engine is ready; otherwise false

<static> {Boolean} SIPml.isWebRtc4AllPluginOutdated()
Checks whether the webrtc4all plugin is outdated or not. You must initialize the engine before calling this function.
Throws:
{ERR_NOT_INITIALIZED}
ERR_NOT_INITIALIZED if the engine is not initialized.
Returns:
{Boolean} true if outdated; otherwise false

<static> {Boolean} SIPml.isWebRtc4AllSupported()
Checks whether the webrtc4all plugin is installed or not. You must initialize the engine before calling this function.
Throws:
{ERR_NOT_INITIALIZED}
ERR_NOT_INITIALIZED if the engine is not initialized.
Returns:
{Boolean} true if supported; otherwise false

<static> {Boolean} SIPml.isWebRtcSupported()
Checks whether WebRTC is supported or not. You must initialize the engine before calling this function.
Throws:
{ERR_NOT_INITIALIZED}
ERR_NOT_INITIALIZED if the engine is not initialized.
Returns:
{Boolean} true if supported; otherwise false

<static> {Boolean} SIPml.isWebSocketSupported()
Checks whether WebSocket is supported or not.
Returns:
{Boolean} true if supported; otherwise false

Documentation generated by JsDoc Toolkit 2.4.0 on Sun Jun 09 2013 23:21:11 GMT-0000 (UTC)