@zoom/probesdk
Version:
Zoom ProbeSDK tests the end user device and network capabilities, and the Zoom server connection.
184 lines (56 loc) • 4.2 kB
HTML
<html lang="en">
<head>
<meta charset="utf-8">
<title>JSDoc: Class: Prober</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">
</head>
<body>
<div id="main">
<h1 class="page-title">Class: Prober</h1>
<section>
<header>
<h2><span class="attribs"><span class="type-signature"></span></span>Prober<span class="signature">()</span><span class="type-signature"></span></h2>
<div class="class-description"><p>Prober provides the capabilities of requesting the media permissions and devices,
diagnosing the devices and network, and reporting the diagnostic result, etc. It's easy
to create an instance of Prober class and use it to implement your own probing requirements.</p></div>
</header>
<article>
<div class="container-overview">
<h2>Constructor</h2>
<h4 class="name" id="Prober"><span class="type-signature"></span>new Prober<span class="signature">()</span><span class="type-signature"></span></h4>
<dl class="details">
<dt class="tag-since">Since:</dt>
<dd class="tag-since"><ul class="dummy"><li>1.0.0</li></ul></dd>
<dt class="tag-author">Author:</dt>
<dd class="tag-author">
<ul>
<li>clever.su@zoom.us</li>
</ul>
</dd>
</dl>
<h5>Example</h5>
<pre class="prettyprint"><code>import { Prober } from "@zoom/probesdk";
const prober = new Prober();
prober.diagnoseVideo(constraints, options);</code></pre>
</div>
</article>
</section>
</div>
<nav>
<h2><a href="index.html">Probe SDK Reference</a></h2><h3>Classes</h3><ul><li><a href="Prober.html">Prober</a></li><li><a href="Reporter.html">Reporter</a></li></ul><h3>Global</h3><ul><li><a href="global.html#BANDWIDTH_QUALITY_LEVEL">BANDWIDTH_QUALITY_LEVEL</a></li><li><a href="global.html#BASIC_INFO_ATTR_INDEX">BASIC_INFO_ATTR_INDEX</a></li><li><a href="global.html#DEF_CONNECT_TIMEOUT">DEF_CONNECT_TIMEOUT</a></li><li><a href="global.html#DEF_PROBE_DURATION">DEF_PROBE_DURATION</a></li><li><a href="global.html#ERR_CODE">ERR_CODE</a></li><li><a href="global.html#NETWORK_QUALITY_LEVEL">NETWORK_QUALITY_LEVEL</a></li><li><a href="global.html#NET_PROBING_DATA_TYPE">NET_PROBING_DATA_TYPE</a></li><li><a href="global.html#PROTOCOL_TYPE">PROTOCOL_TYPE</a></li><li><a href="global.html#RENDERER_TYPE">RENDERER_TYPE</a></li><li><a href="global.html#SUPPORTED_FEATURE_INDEX">SUPPORTED_FEATURE_INDEX</a></li><li><a href="global.html#canSupportStringLength">canSupportStringLength</a></li><li><a href="global.html#cleanup">cleanup</a></li><li><a href="global.html#diagnoseAudio">diagnoseAudio</a></li><li><a href="global.html#diagnoseVideo">diagnoseVideo</a></li><li><a href="global.html#queryRid">queryRid</a></li><li><a href="global.html#releaseMediaStream">releaseMediaStream</a></li><li><a href="global.html#reportBasicInfo">reportBasicInfo</a></li><li><a href="global.html#reportFeatures">reportFeatures</a></li><li><a href="global.html#requestMediaDevicePermission">requestMediaDevicePermission</a></li><li><a href="global.html#requestMediaDevices">requestMediaDevices</a></li><li><a href="global.html#startToDiagnose">startToDiagnose</a></li><li><a href="global.html#stopToDiagnose">stopToDiagnose</a></li><li><a href="global.html#stopToDiagnoseVideo">stopToDiagnoseVideo</a></li></ul>
</nav>
<br class="clear">
<footer>
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 4.0.4</a> on Sat Jun 14 2025 17:40:33 GMT+0800 (China Standard Time)
</footer>
<script> prettyPrint(); </script>
<script src="scripts/linenumber.js"> </script>
</body>
</html>