Namespace SIPml
Defined in: SIPml.js.
| Constructor Attributes | Constructor Name and Description |
|---|---|
|
Root namesapce.
|
| Method Attributes | Method Name and Description |
|---|---|
| <static> |
SIPml.getNavigatorFriendlyName()
Gets the web browser friendly name (e.g.
|
| <static> |
SIPml.getNavigatorVersion()
Gets the web browser version (e.g.
|
| <static> |
SIPml.getRunningApps()
Gets the list of running apps.
|
| <static> |
SIPml.getSystemFriendlyName()
Gets the Operating System friendly name (e.g.
|
| <static> |
SIPml.getWebRtc4AllVersion()
Gets the version name of the installed webrtc4all plugin.
|
| <static> |
SIPml.getWebRtcType()
Gets the current WebRTC type being used.
|
| <static> |
SIPml.haveMediaStream()
Checks whether getUserMedia is supported or not.
|
| <static> |
SIPml.init(readyCallback, errorCallback)
Initialize the engine.
|
| <static> |
SIPml.isInitialized()
Checks whether the engine is initialized or not.
|
| <static> |
SIPml.isNavigatorOutdated()
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> |
SIPml.isScreenShareSupported()
Checks whether Screen share is supported on this browser.
|
| <static> |
SIPml.isWebRtc4AllPluginOutdated()
Checks whether the webrtc4all plugin is outdated or not.
|
| <static> |
SIPml.isWebRtc4AllSupported()
Checks whether the webrtc4all plugin is installed or not.
|
| <static> |
SIPml.isWebRtcSupported()
Checks whether WebRTC is supported or not.
|
| <static> |
SIPml.isWebSocketSupported()
Checks whether WebSocket is supported or not.
|
| <static> |
SIPml.setDebugLevel(level)
Sets the debug level.
|
| <static> |
SIPml.setFps(fps)
Sets the video fps.
|
| <static> |
SIPml.setMaxBandwidthDown(maxBandwidthUp)
Sets the maximum bandwidth (down).
|
| <static> |
SIPml.setMaxBandwidthUp(maxBandwidthUp)
Sets the maximum bandwidth (upload).
|
| <static> |
SIPml.setMaxVideoSize(maxVideoSize)
Sets the maximum video size.
|
| <static> |
SIPml.setWebRtcType(type)
Sets the default webrtc type.
|
| <static> |
SIPml.setZeroArtifacts(zeroArtifacts)
Defines whether to enable "zero-artifacts" features.
|
| <static> |
SIPml.startNativeDebug()
Starts debugging the native (C/C++) code.
|
| <static> |
SIPml.stopNativeDebug()
Stops debugging the native (C/C++) code.
|
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.getRunningApps()
Gets the list of running apps. Requires webrt4all plugin.
- Since:
- version 2.0.0
- Throws:
- {ERR_NOT_READY | ERR_NOT_SUPPORTED}
- ERR_NOT_READY | ERR_NOT_SUPPORTED
- Returns:
- {String} the the list of running apps. Format: (base64($$WindowID$$=str(...)$$Description$$=str(...)$$IconData$$=base64(...)$$IconType$$=str(...)))*
<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>
{String}
SIPml.getWebRtcType()
Gets the current WebRTC type being used.
- Since:
- version 1.4.217
- Returns:
- {String} the WebRTC type. Possible values: native, w4a, erisson or unknown.
<static>
{Boolean}
SIPml.haveMediaStream()
Checks whether getUserMedia is supported or not. The engined must be initialized before calling this function.
- Returns:
- {Boolean} true if getUserMedia is supported; 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:
The engine is ready when:
- engine is initialized
- webrtc is supported
- we got a valid media stream (from getUserMedia)
- 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.isScreenShareSupported()
Checks whether Screen share is supported on this browser.
You must initialize the engine before calling this function.
- Since:
- version 1.3.203
- Throws:
- {ERR_NOT_INITIALIZED}
- ERR_NOT_INITIALIZED if the engine is not initialized.
- Returns:
- {Boolean} true if supported; 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
<static>
SIPml.setDebugLevel(level)
Sets the debug level.
- Parameters:
- {String} level
- The level. Supported values: info, warn, error and fatal.
- Since:
- version 1.3.203
<static>
{Integer}
SIPml.setFps(fps)
Sets the video fps. Requires webrt4all plugin.
- Parameters:
- {Integer} fps
- fps value.
- Since:
- version 2.0.0
- Throws:
- {ERR_NOT_READY | ERR_NOT_SUPPORTED}
- ERR_NOT_READY | ERR_NOT_SUPPORTED
- Returns:
- {Integer} 0 if successful; otherwise nonzero
<static>
{Integer}
SIPml.setMaxBandwidthDown(maxBandwidthUp)
Sets the maximum bandwidth (down). Requires webrt4all plugin.
- Parameters:
- {Integer} maxBandwidthUp
- maxBandwidthUp value (kbps).
- Since:
- version 2.0.0
- Throws:
- {ERR_NOT_READY | ERR_NOT_SUPPORTED}
- ERR_NOT_READY | ERR_NOT_SUPPORTED
- Returns:
- {Integer} 0 if successful; otherwise nonzero
<static>
{Integer}
SIPml.setMaxBandwidthUp(maxBandwidthUp)
Sets the maximum bandwidth (upload). Requires webrt4all plugin.
- Parameters:
- {Integer} maxBandwidthUp
- maxBandwidthUp value (kbps).
- Since:
- version 2.0.0
- Throws:
- {ERR_NOT_READY | ERR_NOT_SUPPORTED}
- ERR_NOT_READY | ERR_NOT_SUPPORTED
- Returns:
- {Integer} 0 if successful; otherwise nonzero
<static>
{Integer}
SIPml.setMaxVideoSize(maxVideoSize)
Sets the maximum video size. Requires webrt4all plugin.
- Parameters:
- {String} maxVideoSize
- maxVideoSize value. Supported values: "sqcif", "qcif" "qvga" "cif" "hvga", "vga", "4cif", "svga", "480p", "720p", "16cif", "1080p", "2160p".
- Since:
- version 2.0.0
- Throws:
- {ERR_NOT_READY | ERR_NOT_SUPPORTED}
- ERR_NOT_READY | ERR_NOT_SUPPORTED
- Returns:
- {Integer} 0 if successful; otherwise nonzero
<static>
{Boolean}
SIPml.setWebRtcType(type)
Sets the default webrtc type. Must be called before initializing the engine.
- Parameters:
- {String} type
- The type. Supported values: native, w4a and erisson.
- Since:
- version 2.0.0
- Returns:
- {Boolean} true if succeed; otherwise false
<static>
{Integer}
SIPml.setZeroArtifacts(zeroArtifacts)
Defines whether to enable "zero-artifacts" features. Requires webrt4all plugin.
More information about this option on Doubango's TelePresence wiki page: https://code.google.com/p/telepresence/wiki/Technical_Video_quality#Zero-artifacts
More information about this option on Doubango's TelePresence wiki page: https://code.google.com/p/telepresence/wiki/Technical_Video_quality#Zero-artifacts
- Parameters:
- {Boolean} zeroArtifacts
- New optional value.
- Since:
- version 2.0.0
- Throws:
- {ERR_NOT_READY | ERR_NOT_SUPPORTED}
- ERR_NOT_READY | ERR_NOT_SUPPORTED
- Returns:
- {Integer} 0 if successful; otherwise nonzero
<static>
SIPml.startNativeDebug()
Starts debugging the native (C/C++) code. Requires webrt4all plugin.
On Windows, the output file should be at C:\Users\<YOUR LOGIN>\AppData\Local\Temp\Low\webrtc4all.log.
Starting the native debug isn't recommended and must be done to track issues only.
- Since:
- version 2.0.0
<static>
SIPml.stopNativeDebug()
Stops debugging the native (C/C++) code. Requires webrt4all plugin.
- Since:
- version 2.0.0