UNPKG

zdpjs_webrtc

Version:
718 lines (240 loc) 13.8 kB
<!DOCTYPE html> <html lang="en"> <head> <meta charset="utf-8"> <title>EasyRTC Documentation</title> <script src="scripts/prettify/prettify.js"> </script> <script src="scripts/prettify/lang-css.js"> </script> <!--[if lt IE 9]> <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script> <![endif]--> <link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css"> <link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css"> <link href="../assets/easyrtc-docs-jsdoc-styles-1.css" media="all" rel="stylesheet" /> </head> <body> <header class="template"> <div class="wrapper-content"> <a href="../index.html"><img src="../assets/easyrtc-logo.png" alt="EasyRTC Documentation"></a> <h1 title="EasyRTC Documentation">Documentation</h1> </div> </header> <div class="wrapper-docs"> <nav> <h2><a href="../index.html">Docs Home</a></h2> <h3>EasyRTC Guides</h3> <ul> <li><a href="../easyrtc_faq.html">FAQ</a></li> <li><a href="../easyrtc_gettingStarted.html">Getting Started</a></li> <li><a href="../easyrtc_server_install.html">EasyRTC Server: Installation</a></li> <li><a href="../easyrtc_client_tutorial.html">EasyRTC Framework Tutorial</a></li> <li><a href="../easyrtc_rooms.html">Rooms</a></li> <li><a href="../easyrtc_server_configuration.html">EasyRTC Server: Configuration</a></li> <li><a href="../easyrtc_server_events.html">EasyRTC Server: Events</a></li> <li><a href="../easyrtc_server_ice.html">EasyRTC Server: ICE Configuration</a></li> <li><a href="../easyrtc_with_other_servers.html">Using Alongside Other Servers</a></li> <li><a href="../easyrtc_server_ssl.html">EasyRTC Server: Using SSL</a></li> <li><a href="../easyrtc_webrtc_problems.html">WebRTC Problems and Possible Fixes</a></li> <li><a href="../easyrtc_upcoming_features.html">Upcoming Features</a></li> <li><a href="../easyrtc_changelog.html">Change Log</a></li> </ul> <h3>EasyRTC Client Classes</h3> <ul> <li><a href="../client-api/Easyrtc.html">Easyrtc</a></li> <li><a href="../client-api/Easyrtc_App.html">Easyrtc_App</a></li> <li><a href="../client-api/Easyrtc_ft.html">Easyrtc_ft</a></li> <li><a href="../client-api/Easyrtc_IframeCapture.html">Easyrtc_IframeCapture</a></li> <li><a href="../client-api/Easyrtc_No_IframeCapture.html">Easyrtc_No_IframeCapture</a></li> <li><a href="../client-api/Easyrtc_Rates.html">Easyrtc_Rates</a></li> <li><a href="../client-api/Easyrtc_Recorder.html">Easyrtc_Recorder</a></li> </ul> <h3>EasyRTC Server Modules</h3> <ul> <li><a href="../server-api/module-easyrtc_default_event_listeners.html">easyrtc_default_event_listeners</a></li> <li><a href="../server-api/module-easyrtc_default_options.html">easyrtc_default_options</a></li> <li><a href="../server-api/module-easyrtc_private_obj.html">easyrtc_private_obj</a></li> <li><a href="../server-api/module-easyrtc_public_obj.html">easyrtc_public_obj</a></li> <li><a href="../server-api/module-easyrtc_util.html">easyrtc_util</a></li> <li><a href="../server-api/module-general_util.html">general_util</a></li> </ul> <h3>EasyRTC Server Classes</h3> <ul> <li><a href="../server-api/module-easyrtc_default_event_listeners-eventListener.html">eventListener</a></li> <li><a href="../server-api/module-easyrtc_public_obj-pub.html">pub</a></li> <li><a href="../server-api/module-easyrtc_public_obj-pub.events.html">events</a></li> <li><a href="../server-api/module-easyrtc_public_obj-pub.util.html">util</a></li> <li><a href="../server-api/module-easyrtc_util-eu.html">eu</a></li> <li><a href="../server-api/module-general_util-g.html">g</a></li> <li><a href="../server-api/pub.appObj.html">appObj</a></li> <li><a href="../server-api/pub.appObj.connectionObj.html">connectionObj</a></li> <li><a href="../server-api/pub.appObj.connectionObj.connectionRoomObj.html">connectionRoomObj</a></li> <li><a href="../server-api/pub.appObj.roomObj.html">roomObj</a></li> <li><a href="../server-api/pub.appObj.sessionObj.html">sessionObj</a></li> </ul> </nav> <div class="easyrtc-docs-content"> <div id="main"> <h1 class="page-title">Class: Easyrtc_No_IframeCapture</h1> <section> <header> <h2>Easyrtc_No_IframeCapture</h2> </header> <article> <div class="container-overview"> <h4 class="name" id="Easyrtc_No_IframeCapture"><span class="type-signature"></span>new Easyrtc_No_IframeCapture<span class="signature">()</span><span class="type-signature"></span></h4> <div class="description"> Provides a method for window/screen capture using an iframe. Please read the comments in the source code about setting the chrome extension that this requires to be installed in each browser. </div> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="labs_desktop_capture_no_iframe_version.js.html">labs/desktop_capture_no_iframe_version.js</a>, <a href="labs_desktop_capture_no_iframe_version.js.html#line17">line 17</a> </li></ul></dd> </dl> </div> <h3 class="subsection-title">Methods</h3> <h4 class="name" id=".easyrtc.chromeInstaller"><span class="type-signature">(static) </span>easyrtc.chromeInstaller<span class="signature">(extensionId, successCallback, failureCallback)</span><span class="type-signature"></span></h4> <div class="description"> This method builds a function that can be attached to a button to install an extension. The install will only work on a <a href="https://support.google.com/webmasters/answer/34592?hl=en">Google Verified Website</a> with a `link` tag pointing to the extension, which is required by chrome for <a href="https://developer.chrome.com/webstore/inline_installation">Inline Installations</a>. </div> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>extensionId</code></td> <td class="type"> <span class="param-type">String</span> </td> <td class="description last">The id of the `link` tag pointing to your extension.</td> </tr> <tr> <td class="name"><code>successCallback</code></td> <td class="type"> <span class="param-type">function</span> </td> <td class="description last">Function to call on success.</td> </tr> <tr> <td class="name"><code>failureCallback</code></td> <td class="type"> <span class="param-type">function</span> </td> <td class="description last">Function to call on failure. Will pass argument `errorCode` and `errorMessage`.</td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="labs_desktop_capture_no_iframe_version.js.html">labs/desktop_capture_no_iframe_version.js</a>, <a href="labs_desktop_capture_no_iframe_version.js.html#line174">line 174</a> </li></ul></dd> </dl> <h5>Example</h5> <pre class="prettyprint"><code>&lt;link rel="chrome-webstore-item" href="https://chrome.google.com/webstore/detail/bemabaogbdfpbkkganibcmhbgjogabfj" id="custom-app-id" /> easyrtc.chromeInstall("custom-app_id", function() { // success }, function(errorCode, errorText) { // failure });</code></pre> <h4 class="name" id=".easyrtc.initDesktopStream"><span class="type-signature">(static) </span>easyrtc.initDesktopStream<span class="signature">(successCallback, errorCallback, streamName, iframeUrl)</span><span class="type-signature"></span></h4> <div class="description"> Create a local media stream for desktop capture. This will fail if a desktop capture extension is not installed. not granting permission. </div> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>successCallback</code></td> <td class="type"> <span class="param-type">function</span> </td> <td class="description last">will be called with localmedia stream on success.</td> </tr> <tr> <td class="name"><code>errorCallback</code></td> <td class="type"> <span class="param-type">function</span> </td> <td class="description last">is called with an error code and error description.</td> </tr> <tr> <td class="name"><code>streamName</code></td> <td class="type"> <span class="param-type">String</span> </td> <td class="description last">an optional name for the media source so you can use multiple cameras and screen share simultaneously.</td> </tr> <tr> <td class="name"><code>iframeUrl</code></td> <td class="type"> <span class="param-type">String</span> </td> <td class="description last">an optional url for the iframe. The default is to use Muaz Khan's.</td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="labs_desktop_capture_no_iframe_version.js.html">labs/desktop_capture_no_iframe_version.js</a>, <a href="labs_desktop_capture_no_iframe_version.js.html#line120">line 120</a> </li></ul></dd> </dl> <h5>Example</h5> <pre class="prettyprint"><code>easyrtc.initDesktopStream( function(mediastream){ easyrtc.setVideoObjectSrc( document.getElementById("mirrorVideo"), mediastream); }, function(errorCode, errorText){ easyrtc.showError(errorCode, errorText); });</code></pre> <h4 class="name" id=".easyrtc.isDesktopCaptureInstalled"><span class="type-signature">(static) </span>easyrtc.isDesktopCaptureInstalled<span class="signature">()</span><span class="type-signature"></span></h4> <div class="description"> Check if desktop capture installed </div> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="labs_desktop_capture_no_iframe_version.js.html">labs/desktop_capture_no_iframe_version.js</a>, <a href="labs_desktop_capture_no_iframe_version.js.html#line97">line 97</a> </li></ul></dd> </dl> <h5>Returns:</h5> <div class="param-desc"> boolean </div> </article> </section> </div> <nav class="hide"><h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="Easyrtc.html">Easyrtc</a></li><li><a href="Easyrtc_App.html">Easyrtc_App</a></li><li><a href="Easyrtc_ft.html">Easyrtc_ft</a></li><li><a href="Easyrtc_IframeCapture.html">Easyrtc_IframeCapture</a></li><li><a href="Easyrtc_No_IframeCapture.html">Easyrtc_No_IframeCapture</a></li><li><a href="Easyrtc_Rates.html">Easyrtc_Rates</a></li><li><a href="Easyrtc_Recorder.html">Easyrtc_Recorder</a></li></ul></nav> </div> </div> <footer class="template"> <div class="wrapper-content"> <p>Copyright &copy;2016 EasyRTC</p> </div> </footer> <!-- <script>prettyPrint();</script> --> <!-- <script src="scripts/linenumber.js"></script> --> </body> </html>