Server : Apache/2.4.6 (CentOS) OpenSSL/1.0.2k-fips PHP/7.4.20 System : Linux st2.domain.com 3.10.0-1127.10.1.el7.x86_64 #1 SMP Wed Jun 3 14:28:03 UTC 2020 x86_64 User : apache ( 48) PHP Version : 7.4.20 Disable Function : NONE Directory : /proc/self/root/usr/local/FlashphonerWebCallServer/client2/doc/ |
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>JSDoc: Global</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">Global</h1>
<section>
<header>
<h2></h2>
</header>
<article>
<div class="container-overview">
<dl class="details">
</dl>
</div>
<h3 class="subsection-title">Type Definitions</h3>
<h4 class="name" id="callbackFn"><span class="type-signature"></span>callbackFn<span class="signature">(result)</span><span class="type-signature"></span></h4>
<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>result</code></td>
<td class="type">
<span class="param-type">Object</span>
</td>
<td class="description last"></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="flashphoner-core.js.html">flashphoner-core.js</a>, <a href="flashphoner-core.js.html#line1223">line 1223</a>
</li></ul></dd>
</dl>
<h4 class="name" id="sdpHook"><span class="type-signature"></span>sdpHook<span class="signature">(sdp)</span><span class="type-signature"> → {String}</span></h4>
<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>sdp</code></td>
<td class="type">
<span class="param-type">Object</span>
</td>
<td class="description last">Callback options
<h6>Properties</h6>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>sdpString</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last">Sdp from the server</td>
</tr>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="flashphoner-core.js.html">flashphoner-core.js</a>, <a href="flashphoner-core.js.html#line944">line 944</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
sdp New sdp
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">String</span>
</dd>
</dl>
<h4 class="name" id="sdpHook"><span class="type-signature"></span>sdpHook<span class="signature">(sdp)</span><span class="type-signature"> → {String}</span></h4>
<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>sdp</code></td>
<td class="type">
<span class="param-type">Object</span>
</td>
<td class="description last">Callback options
<h6>Properties</h6>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>sdpString</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last">Sdp from the server</td>
</tr>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="flashphoner-core.js.html">flashphoner-core.js</a>, <a href="flashphoner-core.js.html#line701">line 701</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
sdp New sdp
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">String</span>
</dd>
</dl>
<h4 class="name" id="sdpHook"><span class="type-signature"></span>sdpHook<span class="signature">(sdp)</span><span class="type-signature"> → {String}</span></h4>
<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>sdp</code></td>
<td class="type">
<span class="param-type">Object</span>
</td>
<td class="description last">Callback options
<h6>Properties</h6>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>sdpString</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last">Sdp from the server</td>
</tr>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="flashphoner-core.js.html">flashphoner-core.js</a>, <a href="flashphoner-core.js.html#line1439">line 1439</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
sdp New sdp
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">String</span>
</dd>
</dl>
</article>
</section>
</div>
<nav>
<h2><a href="index.html">Web SDK</a></h2><h3>Events</h3><ul><li><a href="Flashphoner.constants.CALL_STATUS_INFO.html#.event:FAILED_BY_DTLS_ERROR">FAILED_BY_DTLS_ERROR</a></li><li><a href="Flashphoner.constants.CALL_STATUS_INFO.html#.event:FAILED_BY_DTLS_FINGERPRINT_ERROR">FAILED_BY_DTLS_FINGERPRINT_ERROR</a></li><li><a href="Flashphoner.constants.CALL_STATUS_INFO.html#.event:FAILED_BY_ERROR">FAILED_BY_ERROR</a></li><li><a href="Flashphoner.constants.CALL_STATUS_INFO.html#.event:FAILED_BY_ICE_ERROR">FAILED_BY_ICE_ERROR</a></li><li><a href="Flashphoner.constants.CALL_STATUS_INFO.html#.event:FAILED_BY_REQUEST_TIMEOUT">FAILED_BY_REQUEST_TIMEOUT</a></li><li><a href="Flashphoner.constants.CALL_STATUS_INFO.html#.event:FAILED_BY_RTMP_WRITER_ERROR">FAILED_BY_RTMP_WRITER_ERROR</a></li><li><a href="Flashphoner.constants.CALL_STATUS_INFO.html#.event:FAILED_BY_RTP_ACTIVITY">FAILED_BY_RTP_ACTIVITY</a></li><li><a href="Flashphoner.constants.CALL_STATUS_INFO.html#.event:FAILED_BY_SESSION_CREATION">FAILED_BY_SESSION_CREATION</a></li><li><a href="Flashphoner.constants.CALL_STATUS_INFO.html#.event:NO_COMMON_CODECS">NO_COMMON_CODECS</a></li><li><a href="Flashphoner.constants.CALL_STATUS_INFO.html#.event:NORMAL_CALL_CLEARING">NORMAL_CALL_CLEARING</a></li><li><a href="Flashphoner.constants.CALL_STATUS_INFO.html#.event:TRANSCODING_REQUIRED_BUT_DISABLED">TRANSCODING_REQUIRED_BUT_DISABLED</a></li><li><a href="Flashphoner.constants.ERROR_INFO.html#.event:CALLBACK_NEEDS_TO_BE_A_VALID_FUNCTION">CALLBACK_NEEDS_TO_BE_A_VALID_FUNCTION</a></li><li><a href="Flashphoner.constants.ERROR_INFO.html#.event:CAN_NOT_SWITCH_CAM">CAN_NOT_SWITCH_CAM</a></li><li><a href="Flashphoner.constants.ERROR_INFO.html#.event:CAN_NOT_SWITCH_MIC">CAN_NOT_SWITCH_MIC</a></li><li><a href="Flashphoner.constants.ERROR_INFO.html#.event:EVENT_CANT_BE_NULL">EVENT_CANT_BE_NULL</a></li><li><a href="Flashphoner.constants.ERROR_INFO.html#.event:FLASHPHONER_API_NOT_INITIALIZED">FLASHPHONER_API_NOT_INITIALIZED</a></li><li><a href="Flashphoner.constants.ERROR_INFO.html#.event:INVALID_CALL_STATE">INVALID_CALL_STATE</a></li><li><a href="Flashphoner.constants.ERROR_INFO.html#.event:INVALID_SESSION_STATE">INVALID_SESSION_STATE</a></li><li><a href="Flashphoner.constants.ERROR_INFO.html#.event:NONE_OF_MEDIAPROVIDERS_AVAILABLE">NONE_OF_MEDIAPROVIDERS_AVAILABLE</a></li><li><a href="Flashphoner.constants.ERROR_INFO.html#.event:NONE_OF_PREFERRED_MEDIAPROVIDERS_AVAILABLE">NONE_OF_PREFERRED_MEDIAPROVIDERS_AVAILABLE</a></li><li><a href="Flashphoner.constants.ERROR_INFO.html#.event:OPTIONS_MUST_BE_PROVIDED">OPTIONS_MUST_BE_PROVIDED</a></li><li><a href="Flashphoner.constants.ERROR_INFO.html#.event:OPTIONS_NAME_MUST_BE_PROVIDED">OPTIONS_NAME_MUST_BE_PROVIDED</a></li><li><a href="Flashphoner.constants.ERROR_INFO.html#.event:OPTIONS_URLSERVER_MUST_BE_PROVIDED">OPTIONS_URLSERVER_MUST_BE_PROVIDED</a></li><li><a href="Flashphoner.constants.NOT_ENOUGH_BANDWIDTH.html#.event:NOT_ENOUGH_BANDWIDTH">NOT_ENOUGH_BANDWIDTH</a></li><li><a href="Flashphoner.constants.SESSION_STATUS.html#.event:APP_DATA">APP_DATA</a></li><li><a href="Flashphoner.constants.SESSION_STATUS.html#.event:CONNECTED">CONNECTED</a></li><li><a href="Flashphoner.constants.SESSION_STATUS.html#.event:DEBUG">DEBUG</a></li><li><a href="Flashphoner.constants.SESSION_STATUS.html#.event:DISCONNECTED">DISCONNECTED</a></li><li><a href="Flashphoner.constants.SESSION_STATUS.html#.event:ESTABLISHED">ESTABLISHED</a></li><li><a href="Flashphoner.constants.SESSION_STATUS.html#.event:FAILED">FAILED</a></li><li><a href="Flashphoner.constants.SESSION_STATUS.html#.event:SEND_DATA_STATUS">SEND_DATA_STATUS</a></li><li><a href="Flashphoner.constants.SESSION_STATUS.html#.event:WARN">WARN</a></li><li><a href="Flashphoner.constants.STREAM_STATUS.html#.event:FAILED">FAILED</a></li><li><a href="Flashphoner.constants.STREAM_STATUS.html#.event:PAUSED">PAUSED</a></li><li><a href="Flashphoner.constants.STREAM_STATUS.html#.event:PLAYBACK_PROBLEM">PLAYBACK_PROBLEM</a></li><li><a href="Flashphoner.constants.STREAM_STATUS.html#.event:PLAYING">PLAYING</a></li><li><a href="Flashphoner.constants.STREAM_STATUS.html#.event:PUBLISHING">PUBLISHING</a></li><li><a href="Flashphoner.constants.STREAM_STATUS.html#.event:RESIZE">RESIZE</a></li><li><a href="Flashphoner.constants.STREAM_STATUS.html#.event:SNAPSHOT_COMPLETE">SNAPSHOT_COMPLETE</a></li><li><a href="Flashphoner.constants.STREAM_STATUS.html#.event:STOPPED">STOPPED</a></li><li><a href="Flashphoner.constants.STREAM_STATUS.html#.event:UNPUBLISHING">UNPUBLISHING</a></li><li><a href="Flashphoner.constants.STREAM_STATUS_INFO.html#.event:AGENT_SERVICING_ORIGIN_STREAM_IS_SHUTTING_DOWN">AGENT_SERVICING_ORIGIN_STREAM_IS_SHUTTING_DOWN</a></li><li><a href="Flashphoner.constants.STREAM_STATUS_INFO.html#.event:BAD_URI">BAD_URI</a></li><li><a href="Flashphoner.constants.STREAM_STATUS_INFO.html#.event:CDN_STREAM_NOT_FOUND">CDN_STREAM_NOT_FOUND</a></li><li><a href="Flashphoner.constants.STREAM_STATUS_INFO.html#.event:DISTRIBUTOR_STOPPED">DISTRIBUTOR_STOPPED</a></li><li><a href="Flashphoner.constants.STREAM_STATUS_INFO.html#.event:FAILED_BY_DTLS_ERROR">FAILED_BY_DTLS_ERROR</a></li><li><a href="Flashphoner.constants.STREAM_STATUS_INFO.html#.event:FAILED_BY_DTLS_FINGERPRINT_ERROR">FAILED_BY_DTLS_FINGERPRINT_ERROR</a></li><li><a href="Flashphoner.constants.STREAM_STATUS_INFO.html#.event:FAILED_BY_ERROR">FAILED_BY_ERROR</a></li><li><a href="Flashphoner.constants.STREAM_STATUS_INFO.html#.event:FAILED_BY_HLS_WRITER_ERROR">FAILED_BY_HLS_WRITER_ERROR</a></li><li><a href="Flashphoner.constants.STREAM_STATUS_INFO.html#.event:FAILED_BY_ICE_ERROR">FAILED_BY_ICE_ERROR</a></li><li><a href="Flashphoner.constants.STREAM_STATUS_INFO.html#.event:FAILED_BY_ICE_TIMEOUT">FAILED_BY_ICE_TIMEOUT</a></li><li><a href="Flashphoner.constants.STREAM_STATUS_INFO.html#.event:FAILED_BY_KEEP_ALIVE">FAILED_BY_KEEP_ALIVE</a></li><li><a href="Flashphoner.constants.STREAM_STATUS_INFO.html#.event:FAILED_BY_RTMP_WRITER_ERROR">FAILED_BY_RTMP_WRITER_ERROR</a></li><li><a href="Flashphoner.constants.STREAM_STATUS_INFO.html#.event:FAILED_BY_RTP_ACTIVITY">FAILED_BY_RTP_ACTIVITY</a></li><li><a href="Flashphoner.constants.STREAM_STATUS_INFO.html#.event:FAILED_TO_ADD_STREAM_TO_PROXY">FAILED_TO_ADD_STREAM_TO_PROXY</a></li><li><a href="Flashphoner.constants.STREAM_STATUS_INFO.html#.event:FAILED_TO_CONNECT_TO_ORIGIN_STREAM">FAILED_TO_CONNECT_TO_ORIGIN_STREAM</a></li><li><a href="Flashphoner.constants.STREAM_STATUS_INFO.html#.event:FAILED_TO_CONNECT_TO_RTSP_STREAM">FAILED_TO_CONNECT_TO_RTSP_STREAM</a></li><li><a href="Flashphoner.constants.STREAM_STATUS_INFO.html#.event:FAILED_TO_GET_AGENT_STORAGE">FAILED_TO_GET_AGENT_STORAGE</a></li><li><a href="Flashphoner.constants.STREAM_STATUS_INFO.html#.event:FAILED_TO_READ_FILE">FAILED_TO_READ_FILE</a></li><li><a href="Flashphoner.constants.STREAM_STATUS_INFO.html#.event:FILE_HAS_WRONG_FORMAT">FILE_HAS_WRONG_FORMAT</a></li><li><a href="Flashphoner.constants.STREAM_STATUS_INFO.html#.event:FILE_NOT_FOUND">FILE_NOT_FOUND</a></li><li><a href="Flashphoner.constants.STREAM_STATUS_INFO.html#.event:GOT_EXCEPTION_WHILE_STREAMING_FILE">GOT_EXCEPTION_WHILE_STREAMING_FILE</a></li><li><a href="Flashphoner.constants.STREAM_STATUS_INFO.html#.event:MEDIASESSION_ID_ALREADY_IN_USE">MEDIASESSION_ID_ALREADY_IN_USE</a></li><li><a href="Flashphoner.constants.STREAM_STATUS_INFO.html#.event:MEDIASESSION_ID_NULL">MEDIASESSION_ID_NULL</a></li><li><a href="Flashphoner.constants.STREAM_STATUS_INFO.html#.event:NO_COMMON_CODECS">NO_COMMON_CODECS</a></li><li><a href="Flashphoner.constants.STREAM_STATUS_INFO.html#.event:PUBLISH_STREAM_IS_NOT_READY">PUBLISH_STREAM_IS_NOT_READY</a></li><li><a href="Flashphoner.constants.STREAM_STATUS_INFO.html#.event:REQUESTED_STREAM_SHUTDOWN">REQUESTED_STREAM_SHUTDOWN</a></li><li><a href="Flashphoner.constants.STREAM_STATUS_INFO.html#.event:RESTRICTED_ACCESS">RESTRICTED_ACCESS</a></li><li><a href="Flashphoner.constants.STREAM_STATUS_INFO.html#.event:RTSP_HAS_WRONG_FORMAT">RTSP_HAS_WRONG_FORMAT</a></li><li><a href="Flashphoner.constants.STREAM_STATUS_INFO.html#.event:RTSP_STREAM_NOT_FOUND">RTSP_STREAM_NOT_FOUND</a></li><li><a href="Flashphoner.constants.STREAM_STATUS_INFO.html#.event:RTSPAGENT_SHUTDOWN">RTSPAGENT_SHUTDOWN</a></li><li><a href="Flashphoner.constants.STREAM_STATUS_INFO.html#.event:SESSION_DOES_NOT_EXIST">SESSION_DOES_NOT_EXIST</a></li><li><a href="Flashphoner.constants.STREAM_STATUS_INFO.html#.event:SESSION_NOT_READY">SESSION_NOT_READY</a></li><li><a href="Flashphoner.constants.STREAM_STATUS_INFO.html#.event:STOPPED_BY_PUBLISHER_STOP">STOPPED_BY_PUBLISHER_STOP</a></li><li><a href="Flashphoner.constants.STREAM_STATUS_INFO.html#.event:STOPPED_BY_REST_TERMINATE">STOPPED_BY_REST_TERMINATE</a></li><li><a href="Flashphoner.constants.STREAM_STATUS_INFO.html#.event:STOPPED_BY_SESSION_DISCONNECT">STOPPED_BY_SESSION_DISCONNECT</a></li><li><a href="Flashphoner.constants.STREAM_STATUS_INFO.html#.event:STOPPED_BY_USER">STOPPED_BY_USER</a></li><li><a href="Flashphoner.constants.STREAM_STATUS_INFO.html#.event:STREAM_FAILED">STREAM_FAILED</a></li><li><a href="Flashphoner.constants.STREAM_STATUS_INFO.html#.event:STREAM_NAME_ALREADY_IN_USE">STREAM_NAME_ALREADY_IN_USE</a></li><li><a href="Flashphoner.constants.STREAM_STATUS_INFO.html#.event:STREAM_NOT_FOUND">STREAM_NOT_FOUND</a></li><li><a href="Flashphoner.constants.STREAM_STATUS_INFO.html#.event:TERMINATED_BY_KEEP_ALIVE">TERMINATED_BY_KEEP_ALIVE</a></li><li><a href="Flashphoner.constants.STREAM_STATUS_INFO.html#.event:TRANSCODING_REQUIRED_BUT_DISABLED">TRANSCODING_REQUIRED_BUT_DISABLED</a></li></ul><h3>Namespaces</h3><ul><li><a href="Call.html">Call</a></li><li><a href="Flashphoner.html">Flashphoner</a></li><li><a href="Flashphoner.constants.CALL_STATUS.html">CALL_STATUS</a></li><li><a href="Flashphoner.constants.CALL_STATUS_INFO.html">CALL_STATUS_INFO</a></li><li><a href="Flashphoner.constants.ERROR_INFO.html">ERROR_INFO</a></li><li><a href="Flashphoner.constants.SESSION_STATUS.html">SESSION_STATUS</a></li><li><a href="Flashphoner.constants.STREAM_STATUS.html">STREAM_STATUS</a></li><li><a href="Flashphoner.constants.STREAM_STATUS_INFO.html">STREAM_STATUS_INFO</a></li><li><a href="roomApi.html">roomApi</a></li><li><a href="roomApi.Room.html">Room</a></li><li><a href="roomApi.Room.Participant.html">Participant</a></li><li><a href="roomApi.Session.html">Session</a></li><li><a href="Session.html">Session</a></li><li><a href="Stream.html">Stream</a></li></ul><h3><a href="global.html">Global</a></h3>
</nav>
<br class="clear">
<footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.7</a> on Mon May 24 2021 14:25:08 GMT+0700 (+07)
</footer>
<script> prettyPrint(); </script>
<script src="scripts/linenumber.js"> </script>
</body>
</html>