The following APIs provide useful information when first debugging any issues related to the plugin.
All these functions/attributes are accessed on a plugin <object> in the DOM.
If you are using AdapterJS, you may get a plugin instance by calling: AdapterJS.WebRTCPlugin.plugin
Generic APIs
API | Expected Value/ Functionality |
valid | Returns True if the plugin was successfully initiated by the browser. |
echo(string) | Repeats any string you provide as argument. |
VERSION | Returns the version of the plugin. |
COMPANY | Returns the name of the company/contract of the plugin. |
HasUsageRestrictionToDomains | Returns True if the plugin has the given feature enabled. |
HasFeaturesRestrictedToDomains | Returns True if the plugin has the given feature enabled. |
HasCrashReporterFeature | Returns True if the plugin has Crash Reporting enabled. |
HasPopupFeature | Returns True if the plugin has Pop Up enabled. |
Returns True if the plugin has H264 enabled. | |
HasExperimentalAEC | Returns True if the plugin has Acoustic Echo Cancellation enabled. |
Expiration Date
API | Expected Value/ Functionality |
expirationDate | Returns expiration date of the plugin if any. |
isOutOfDate | Returns True if the expiration date has passed. |
Auto Update
API | Expected Value/ Functionality |
HasAutoupdateFeature | Returns True if the plugin has Auto Update enabled. |
downloadLink | The URL queried to update the plugin. |
checkForUpdate() | Manually starts an update routine in the plugin (Will query for new version and offer it to the user if any). |
notifyVersionAvailable() | Forces the plugin to offer a new download of the plugin to the user. |
Whitelisting
API | Expected Value/ Functionality |
HasWhiteListingFeature | Returns True if the plugin has domain name whitelisting enabled. |
Returns True if the current website is among the whitelisted domains listed in your config sheet. |
API | Expected Value/ Functionality |
ApproveCert() | Returns True if a licensing certificate is available and valid (correct signature and non-expired). |
updateCert() | Manually updates the licensing certificate using a HTTP GET call on the URL configured in the plugin. If the certificate received is valid (correct signature and non-expired), it will replace the current certificate. |
isCertAboutToExpire() | Returns True if the licensing certificate expires in the upcoming days. The duration is configured by the client AT BUILD TIME. |
HTTP Proxy
API | Expected Value/ Functionality |
Returns True if the plugin has HTTP Proxy enabled. |
Screensharing
API | Expected Value/ Functionality |
HasScreensharingFeature | Returns True if the plugin has screensharing enabled. |
isScreensharingAvailable | Returns True if screen-sharing is embedded on this website; false otherwise. |
screensharingKeys.screenOrWindow | Requests a screensharing stream that captures either a screen or a single window. |
screensharingKeys.screen | Requests a screensharing stream that captures a screen. |
screensharingKeys.window | Requests a screensharing stream that captures a single window. |
isHTTPS() | Returns True if the plugin recognises the current website as HTTPS. |
Returns the list of sources available (screens and windows) for a screensharing stream. This can be used to generate a custom screensharing popup. |
Please note that a plugin having a particular feature enabled does NOT mean that that feature is available on that specific website. |