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: Namespace: Stream</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">Namespace: Stream</h1>
<section>
<header>
<h2>Stream</h2>
</header>
<article>
<div class="container-overview">
<div class="description">Represents media stream.</div>
<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#line1590">line 1590</a>
</li></ul></dd>
<dt class="tag-see">See:</dt>
<dd class="tag-see">
<ul>
<li><a href="Session.html#~createStream">Session~createStream</a></li>
</ul>
</dd>
</dl>
</div>
<h3 class="subsection-title">Methods</h3>
<h4 class="name" id="~available"><span class="type-signature">(inner) </span>available<span class="signature">()</span><span class="type-signature"> → {Promise}</span></h4>
<div class="description">
Сhecks the availability of stream on the server
</div>
<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#line2409">line 2409</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
Resolves if is stream available, otherwise rejects
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Promise</span>
</dd>
</dl>
<h4 class="name" id="~fullScreen"><span class="type-signature">(inner) </span>fullScreen<span class="signature">()</span><span class="type-signature"></span></h4>
<div class="description">
Request full screen for player stream
</div>
<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#line2364">line 2364</a>
</li></ul></dd>
</dl>
<h4 class="name" id="~getAudioState"><span class="type-signature">(inner) </span>getAudioState<span class="signature">()</span><span class="type-signature"></span></h4>
<div class="description">
Get audio state (muted)
</div>
<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#line2345">line 2345</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
AudioState
</div>
<h4 class="name" id="~getErrorInfo"><span class="type-signature">(inner) </span>getErrorInfo<span class="signature">()</span><span class="type-signature"> → {string}</span></h4>
<div class="description">
Get stream error info
</div>
<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#line1400">line 1400</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
Error info
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">string</span>
</dd>
</dl>
<h4 class="name" id="~getErrorInfo"><span class="type-signature">(inner) </span>getErrorInfo<span class="signature">()</span><span class="type-signature"> → {string}</span></h4>
<div class="description">
Get stream error info
</div>
<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#line2149">line 2149</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
Error info
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">string</span>
</dd>
</dl>
<h4 class="name" id="~getInfo"><span class="type-signature">(inner) </span>getInfo<span class="signature">()</span><span class="type-signature"> → {string}</span></h4>
<div class="description">
Get call info
</div>
<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#line1390">line 1390</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
Info
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">string</span>
</dd>
</dl>
<h4 class="name" id="~getInfo"><span class="type-signature">(inner) </span>getInfo<span class="signature">()</span><span class="type-signature"> → {string}</span></h4>
<div class="description">
Get stream info
</div>
<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#line2139">line 2139</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
Info
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">string</span>
</dd>
</dl>
<h4 class="name" id="~getNetworkBandwidth"><span class="type-signature">(inner) </span>getNetworkBandwidth<span class="signature">()</span><span class="type-signature"> → {number}</span></h4>
<div class="description">
Get network bandwidth reported by server, works only for subscribe Stream
</div>
<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#line2334">line 2334</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
Network bandwidth in bps or -1
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">number</span>
</dd>
</dl>
<h4 class="name" id="~getRecordInfo"><span class="type-signature">(inner) </span>getRecordInfo<span class="signature">()</span><span class="type-signature"> → {string}</span></h4>
<div class="description">
Get record file name
</div>
<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#line2129">line 2129</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
File name
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">string</span>
</dd>
</dl>
<h4 class="name" id="~getRemoteBitrate"><span class="type-signature">(inner) </span>getRemoteBitrate<span class="signature">()</span><span class="type-signature"> → {number}</span></h4>
<div class="description">
Get remote bitrate reported by server, works only for subscribe Stream
</div>
<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#line2323">line 2323</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
Remote bitrate in bps or -1
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">number</span>
</dd>
</dl>
<h4 class="name" id="~getStats"><span class="type-signature">(inner) </span>getStats<span class="signature">(callbackFn, nativeStats)</span><span class="type-signature"> → {Object}</span></h4>
<div class="description">
Get statistics
</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>callbackFn</code></td>
<td class="type">
<span class="param-type"><a href="global.html#callbackFn">callbackFn</a></span>
</td>
<td class="description last">The callback that handles response</td>
</tr>
<tr>
<td class="name"><code>nativeStats</code></td>
<td class="type">
<span class="param-type">Boolean</span>
</td>
<td class="description last">If true, use native browser statistics</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#line2310">line 2310</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
Stream audio\video statistics
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Object</span>
</dd>
</dl>
<h4 class="name" id="~getVideoState"><span class="type-signature">(inner) </span>getVideoState<span class="signature">()</span><span class="type-signature"></span></h4>
<div class="description">
Get video state (muted)
</div>
<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#line2356">line 2356</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
VideoState
</div>
<h4 class="name" id="~getVolume"><span class="type-signature">(inner) </span>getVolume<span class="signature">()</span><span class="type-signature"> → {number}</span></h4>
<div class="description">
Get current volume
</div>
<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#line2205">line 2205</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
Volume or -1 if audio is not available
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">number</span>
</dd>
</dl>
<h4 class="name" id="~id"><span class="type-signature">(inner) </span>id<span class="signature">()</span><span class="type-signature"> → {string}</span></h4>
<div class="description">
Get stream id.
</div>
<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#line2097">line 2097</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
Stream id
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">string</span>
</dd>
</dl>
<h4 class="name" id="~isAudioMuted"><span class="type-signature">(inner) </span>isAudioMuted<span class="signature">()</span><span class="type-signature"> → {boolean}</span></h4>
<div class="description">
Check outgoing audio mute state
</div>
<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#line2253">line 2253</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
True if audio is muted or not available
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">boolean</span>
</dd>
</dl>
<h4 class="name" id="~isRemoteAudioMuted"><span class="type-signature">(inner) </span>isRemoteAudioMuted<span class="signature">()</span><span class="type-signature"></span></h4>
<div class="description">
Is remote audio muted
</div>
<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#line1994">line 1994</a>
</li></ul></dd>
</dl>
<h4 class="name" id="~isVideoMuted"><span class="type-signature">(inner) </span>isVideoMuted<span class="signature">()</span><span class="type-signature"> → {boolean}</span></h4>
<div class="description">
Check outgoing video mute state
</div>
<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#line2294">line 2294</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
True if video is muted or not available
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">boolean</span>
</dd>
</dl>
<h4 class="name" id="~muteAudio"><span class="type-signature">(inner) </span>muteAudio<span class="signature">()</span><span class="type-signature"></span></h4>
<div class="description">
Mute outgoing audio
</div>
<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#line2226">line 2226</a>
</li></ul></dd>
</dl>
<h4 class="name" id="~muteRemoteAudio"><span class="type-signature">(inner) </span>muteRemoteAudio<span class="signature">()</span><span class="type-signature"></span></h4>
<div class="description">
Mute remote audio
</div>
<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#line1982">line 1982</a>
</li></ul></dd>
</dl>
<h4 class="name" id="~muteVideo"><span class="type-signature">(inner) </span>muteVideo<span class="signature">()</span><span class="type-signature"></span></h4>
<div class="description">
Mute outgoing video
</div>
<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#line2266">line 2266</a>
</li></ul></dd>
</dl>
<h4 class="name" id="~name"><span class="type-signature">(inner) </span>name<span class="signature">()</span><span class="type-signature"> → {string}</span></h4>
<div class="description">
Get stream name.
</div>
<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#line2108">line 2108</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
Stream name
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">string</span>
</dd>
</dl>
<h4 class="name" id="~on"><span class="type-signature">(inner) </span>on<span class="signature">(event, callback)</span><span class="type-signature"> → {<a href="Stream.html">Stream</a>}</span></h4>
<div class="description">
Add stream status event callback.
</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>event</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">One of <a href="Flashphoner.constants.STREAM_STATUS.html">Flashphoner.constants.STREAM_STATUS</a> events</td>
</tr>
<tr>
<td class="name"><code>callback</code></td>
<td class="type">
<span class="param-type"><a href="Stream.html#~eventCallback">Stream~eventCallback</a></span>
</td>
<td class="description last">Callback function</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#line2391">line 2391</a>
</li></ul></dd>
</dl>
<h5>Throws:</h5>
<ul>
<li>
<dl>
<dt>
<div class="param-desc">
Error if event is not specified
</div>
</dt>
<dd></dd>
<dt>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">TypeError</span>
</dd>
</dl>
</dt>
<dd></dd>
</dl>
</li>
<li>
<dl>
<dt>
<div class="param-desc">
Error if callback is not a valid function
</div>
</dt>
<dd></dd>
<dt>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Error</span>
</dd>
</dl>
</dt>
<dd></dd>
</dl>
</li>
</ul>
<h5>Returns:</h5>
<div class="param-desc">
Stream callback was attached to
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type"><a href="Stream.html">Stream</a></span>
</dd>
</dl>
<h4 class="name" id="~play"><span class="type-signature">(inner) </span>play<span class="signature">()</span><span class="type-signature"></span></h4>
<div class="description">
Play stream.
</div>
<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#line1736">line 1736</a>
</li></ul></dd>
</dl>
<h5>Throws:</h5>
<dl>
<dt>
<div class="param-desc">
Error if stream status is not Flashphoner.constants.STREAM_STATUS.NEW
</div>
</dt>
<dd></dd>
<dt>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Error</span>
</dd>
</dl>
</dt>
<dd></dd>
</dl>
<h4 class="name" id="~publish"><span class="type-signature">(inner) </span>publish<span class="signature">()</span><span class="type-signature"></span></h4>
<div class="description">
Publish stream.
</div>
<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#line1810">line 1810</a>
</li></ul></dd>
</dl>
<h5>Throws:</h5>
<dl>
<dt>
<div class="param-desc">
Error if stream status is not Flashphoner.constants.STREAM_STATUS.NEW
</div>
</dt>
<dd></dd>
<dt>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Error</span>
</dd>
</dl>
</dt>
<dd></dd>
</dl>
<h4 class="name" id="~published"><span class="type-signature">(inner) </span>published<span class="signature">()</span><span class="type-signature"> → {Boolean}</span></h4>
<div class="description">
Is stream published.
</div>
<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#line2119">line 2119</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
True if stream published, otherwise false
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Boolean</span>
</dd>
</dl>
<h4 class="name" id="~sendData"><span class="type-signature">(inner) </span>sendData<span class="signature">(payload)</span><span class="type-signature"></span></h4>
<div class="description">
Send data from published stream.
</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>payload</code></td>
<td class="type">
<span class="param-type">Object</span>
</td>
<td class="description last">Any object</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#line1956">line 1956</a>
</li></ul></dd>
</dl>
<h5>Throws:</h5>
<dl>
<dt>
<div class="param-desc">
Error if stream status is not Flashphoner.constants.STREAM_STATUS.PUBLISHING
</div>
</dt>
<dd></dd>
<dt>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Error</span>
</dd>
</dl>
</dt>
<dd></dd>
</dl>
<h4 class="name" id="~setMicrophoneGain"><span class="type-signature">(inner) </span>setMicrophoneGain<span class="signature">()</span><span class="type-signature"></span></h4>
<div class="description">
Set Microphone Gain
</div>
<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#line2008">line 2008</a>
</li></ul></dd>
</dl>
<h5>Throws:</h5>
<dl>
<dt>
<div class="param-desc">
Error if stream status is not Flashphoner.constants.STREAM_STATUS.PUBLISHING
</div>
</dt>
<dd></dd>
<dt>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Error</span>
</dd>
</dl>
</dt>
<dd></dd>
</dl>
<h4 class="name" id="~setVolume"><span class="type-signature">(inner) </span>setVolume<span class="signature">(volume)</span><span class="type-signature"></span></h4>
<div class="description">
Set volume of remote media
</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>volume</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last">Volume between 0 and 100</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#line2192">line 2192</a>
</li></ul></dd>
</dl>
<h4 class="name" id="~snapshot"><span class="type-signature">(inner) </span>snapshot<span class="signature">()</span><span class="type-signature"></span></h4>
<div class="description">
Request remote stream snapshot.
</div>
<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#line2068">line 2068</a>
</li></ul></dd>
</dl>
<h5>Throws:</h5>
<dl>
<dt>
<div class="param-desc">
Error if stream status is not Flashphoner.constants.STREAM_STATUS.NEW
</div>
</dt>
<dd></dd>
<dt>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Error</span>
</dd>
</dl>
</dt>
<dd></dd>
</dl>
<h4 class="name" id="~status"><span class="type-signature">(inner) </span>status<span class="signature">()</span><span class="type-signature"> → {string}</span></h4>
<div class="description">
Get stream status.
</div>
<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#line2086">line 2086</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
One of <a href="Flashphoner.constants.STREAM_STATUS.html">Flashphoner.constants.STREAM_STATUS</a>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">string</span>
</dd>
</dl>
<h4 class="name" id="~stop"><span class="type-signature">(inner) </span>stop<span class="signature">()</span><span class="type-signature"></span></h4>
<div class="description">
Stop stream.
</div>
<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#line2021">line 2021</a>
</li></ul></dd>
</dl>
<h4 class="name" id="~switchCam"><span class="type-signature">(inner) </span>switchCam<span class="signature">()</span><span class="type-signature"></span></h4>
<div class="description">
Switch camera in real-time.
Works only with WebRTC
</div>
<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#line1892">line 1892</a>
</li></ul></dd>
</dl>
<h5>Throws:</h5>
<dl>
<dt>
<div class="param-desc">
Error if stream status is not Flashphoner.constants.STREAM_STATUS.PUBLISHING
</div>
</dt>
<dd></dd>
<dt>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Error</span>
</dd>
</dl>
</dt>
<dd></dd>
</dl>
<h4 class="name" id="~switchMic"><span class="type-signature">(inner) </span>switchMic<span class="signature">()</span><span class="type-signature"></span></h4>
<div class="description">
Switch microphone in real-time.
Works only with WebRTC
</div>
<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#line1907">line 1907</a>
</li></ul></dd>
</dl>
<h5>Throws:</h5>
<dl>
<dt>
<div class="param-desc">
Error if stream status is not Flashphoner.constants.STREAM_STATUS.PUBLISHING
</div>
</dt>
<dd></dd>
<dt>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Error</span>
</dd>
</dl>
</dt>
<dd></dd>
</dl>
<h4 class="name" id="~switchToCam"><span class="type-signature">(inner) </span>switchToCam<span class="signature">()</span><span class="type-signature"></span></h4>
<div class="description">
Switch to cam in real-time.
Works only with WebRTC
</div>
<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#line1940">line 1940</a>
</li></ul></dd>
</dl>
<h5>Throws:</h5>
<dl>
<dt>
<div class="param-desc">
Error if stream status is not Flashphoner.constants.STREAM_STATUS.PUBLISHING
</div>
</dt>
<dd></dd>
<dt>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Error</span>
</dd>
</dl>
</dt>
<dd></dd>
</dl>
<h4 class="name" id="~switchToScreen"><span class="type-signature">(inner) </span>switchToScreen<span class="signature">(source, woExtension)</span><span class="type-signature"></span></h4>
<div class="description">
Switch to screen in real-time.
Works only with WebRTC
</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>source</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last">Screen sharing source (for firefox)</td>
</tr>
<tr>
<td class="name"><code>woExtension</code></td>
<td class="type">
<span class="param-type">Boolean</span>
</td>
<td class="description last">Screen sharing without extension (for chrome)</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#line1925">line 1925</a>
</li></ul></dd>
</dl>
<h5>Throws:</h5>
<dl>
<dt>
<div class="param-desc">
Error if stream status is not Flashphoner.constants.STREAM_STATUS.PUBLISHING
</div>
</dt>
<dd></dd>
<dt>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Error</span>
</dd>
</dl>
</dt>
<dd></dd>
</dl>
<h4 class="name" id="~unmuteAudio"><span class="type-signature">(inner) </span>unmuteAudio<span class="signature">()</span><span class="type-signature"></span></h4>
<div class="description">
Unmute outgoing audio
</div>
<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#line2239">line 2239</a>
</li></ul></dd>
</dl>
<h4 class="name" id="~unmuteRemoteAudio"><span class="type-signature">(inner) </span>unmuteRemoteAudio<span class="signature">()</span><span class="type-signature"></span></h4>
<div class="description">
Unmute remote audio
</div>
<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#line1970">line 1970</a>
</li></ul></dd>
</dl>
<h4 class="name" id="~unmuteVideo"><span class="type-signature">(inner) </span>unmuteVideo<span class="signature">()</span><span class="type-signature"></span></h4>
<div class="description">
Unmute outgoing video
</div>
<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#line2279">line 2279</a>
</li></ul></dd>
</dl>
<h4 class="name" id="~videoResolution"><span class="type-signature">(inner) </span>videoResolution<span class="signature">()</span><span class="type-signature"> → {Object}</span></h4>
<div class="description">
Get stream video size
</div>
<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#line2159">line 2159</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
Video size
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Object</span>
</dd>
</dl>
<h3 class="subsection-title">Type Definitions</h3>
<h4 class="name" id="~eventCallback"><span class="type-signature"></span>eventCallback<span class="signature">(stream)</span><span class="type-signature"></span></h4>
<div class="description">
Stream status event callback.
</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>stream</code></td>
<td class="type">
<span class="param-type"><a href="Stream.html">Stream</a></span>
</td>
<td class="description last">Stream that corresponds to the event</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#line2373">line 2373</a>
</li></ul></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>