sysadmin/ct-dtv-hx0100-002kwos
1
0
Fork 0
Code Issues 5 Pull Requests Actions Packages Projects Releases Wiki Activity
Files
master
ct-dtv-hx0100-002kwos/procentric/application/referece/hcap_js_extension-1.24.6.5901/doc/symbols/hcap.webrtc.html
sysadmin ff2a3c305b issue #1 
Add 1st PTC Hotel APP codes
2022-04-21 10:46:16 +09:00

1686 lines
57 KiB
HTML
Executable File
Raw Permalink Blame History

<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8" />
<meta name="generator" content="JsDoc Toolkit" />
<title>hcap.webrtc | JsDoc Reference</title>
<meta name="viewport" content="width=device-width, initial-scale=1.0, maximum-scale=1.0" />
<meta name="mobileoptimized" content="0" />
<link rel="stylesheet" href="../css/all.css" media="all" />
<link rel="stylesheet" href="../css/handheld.css" media="only screen and (max-width: 660px)" />
<link rel="stylesheet" href="../css/handheld.css" media="handheld" />
<link rel="stylesheet" href="../css/screen.css" media="screen and (min-width: 661px)" />
<link rel="stylesheet" href="../javascript/highlighter/dessert.css" />
<script src="../javascript/all.js"></script>
<!--[if lt IE 9]>
<script src="../javascript/html5.js"></script>
<![endif]-->
</head>
<body>
<div class="index">
<div class="menu">
<div class="indexLinks">
<a href="../index.html">Classes</a>
<a href="../files.html">Files</a>
</div>
<table width=100% class=confidential><tr><td><b>LGE Confidential</b></td></tr></table>
<h2 class="heading1">Library</h2>
<table>
<tr>
<td align=left class=confidential><a href="../../js/hcap.js">&middot;hcap.js (1.24.6.5901)</li></a></td>
</tr>
</table>
<h2 class="heading1">Classes</h2>
<input type="text" name="classFilter" class="classFilter" id="ClassFilter" placeholder="Filter"></input>
<nav>
<ul class="classList" id="ClassList">
<li><a href="../symbols/_global_.html">_global_</a></li>
<li><a href="../symbols/hcap.html">hcap</a></li>
<li><a href="../symbols/hcap.application.html">hcap<span class='break'> </span>.<span class='break'> </span>application</a></li>
<li><a href="../symbols/hcap.beacon.html">hcap<span class='break'> </span>.<span class='break'> </span>beacon</a></li>
<li><a href="../symbols/hcap.bluetooth.html">hcap<span class='break'> </span>.<span class='break'> </span>bluetooth</a></li>
<li><a href="../symbols/hcap.bluetooth.audio.html">hcap<span class='break'> </span>.<span class='break'> </span>bluetooth<span class='break'> </span>.<span class='break'> </span>audio</a></li>
<li><a href="../symbols/hcap.camera.html">hcap<span class='break'> </span>.<span class='break'> </span>camera</a></li>
<li><a href="../symbols/hcap.carousel.html">hcap<span class='break'> </span>.<span class='break'> </span>carousel</a></li>
<li><a href="../symbols/hcap.channel.html">hcap<span class='break'> </span>.<span class='break'> </span>channel</a></li>
<li><a href="../symbols/hcap.channel.AudioStreamType.html">hcap<span class='break'> </span>.<span class='break'> </span>channel<span class='break'> </span>.<span class='break'> </span>AudioStreamType</a></li>
<li><a href="../symbols/hcap.channel.ChannelStatus.html">hcap<span class='break'> </span>.<span class='break'> </span>channel<span class='break'> </span>.<span class='break'> </span>ChannelStatus</a></li>
<li><a href="../symbols/hcap.channel.ChannelType.html">hcap<span class='break'> </span>.<span class='break'> </span>channel<span class='break'> </span>.<span class='break'> </span>ChannelType</a></li>
<li><a href="../symbols/hcap.channel.InbandDataServiceType.html">hcap<span class='break'> </span>.<span class='break'> </span>channel<span class='break'> </span>.<span class='break'> </span>InbandDataServiceType</a></li>
<li><a href="../symbols/hcap.channel.IpBroadcastType.html">hcap<span class='break'> </span>.<span class='break'> </span>channel<span class='break'> </span>.<span class='break'> </span>IpBroadcastType</a></li>
<li><a href="../symbols/hcap.channel.Polarization.html">hcap<span class='break'> </span>.<span class='break'> </span>channel<span class='break'> </span>.<span class='break'> </span>Polarization</a></li>
<li><a href="../symbols/hcap.channel.RfBroadcastType.html">hcap<span class='break'> </span>.<span class='break'> </span>channel<span class='break'> </span>.<span class='break'> </span>RfBroadcastType</a></li>
<li><a href="../symbols/hcap.channel.VideoStreamType.html">hcap<span class='break'> </span>.<span class='break'> </span>channel<span class='break'> </span>.<span class='break'> </span>VideoStreamType</a></li>
<li><a href="../symbols/hcap.checkout.html">hcap<span class='break'> </span>.<span class='break'> </span>checkout</a></li>
<li><a href="../symbols/hcap.externalinput.html">hcap<span class='break'> </span>.<span class='break'> </span>externalinput</a></li>
<li><a href="../symbols/hcap.externalinput.ExternalInputType.html">hcap<span class='break'> </span>.<span class='break'> </span>externalinput<span class='break'> </span>.<span class='break'> </span>ExternalInputType</a></li>
<li><a href="../symbols/hcap.file.html">hcap<span class='break'> </span>.<span class='break'> </span>file</a></li>
<li><a href="../symbols/hcap.iot.html">hcap<span class='break'> </span>.<span class='break'> </span>iot</a></li>
<li><a href="../symbols/hcap.key.html">hcap<span class='break'> </span>.<span class='break'> </span>key</a></li>
<li><a href="../symbols/hcap.key.Code.html">hcap<span class='break'> </span>.<span class='break'> </span>key<span class='break'> </span>.<span class='break'> </span>Code</a></li>
<li><a href="../symbols/hcap.Media.html">hcap<span class='break'> </span>.<span class='break'> </span>Media</a></li>
<li><a href="../symbols/hcap.Media.SubtitleType.html">hcap<span class='break'> </span>.<span class='break'> </span>Media<span class='break'> </span>.<span class='break'> </span>SubtitleType</a></li>
<li><a href="../symbols/hcap.mode.html">hcap<span class='break'> </span>.<span class='break'> </span>mode</a></li>
<li><a href="../symbols/hcap.mouse.html">hcap<span class='break'> </span>.<span class='break'> </span>mouse</a></li>
<li><a href="../symbols/hcap.mpi.html">hcap<span class='break'> </span>.<span class='break'> </span>mpi</a></li>
<li><a href="../symbols/hcap.network.html">hcap<span class='break'> </span>.<span class='break'> </span>network</a></li>
<li><a href="../symbols/hcap.network.DhcpState.html">hcap<span class='break'> </span>.<span class='break'> </span>network<span class='break'> </span>.<span class='break'> </span>DhcpState</a></li>
<li><a href="../symbols/hcap.network.NetworkEventType.html">hcap<span class='break'> </span>.<span class='break'> </span>network<span class='break'> </span>.<span class='break'> </span>NetworkEventType</a></li>
<li><a href="../symbols/hcap.network.NetworkMode.html">hcap<span class='break'> </span>.<span class='break'> </span>network<span class='break'> </span>.<span class='break'> </span>NetworkMode</a></li>
<li><a href="../symbols/hcap.network.WifiSecurityType.html">hcap<span class='break'> </span>.<span class='break'> </span>network<span class='break'> </span>.<span class='break'> </span>WifiSecurityType</a></li>
<li><a href="../symbols/hcap.network.WirelessMode.html">hcap<span class='break'> </span>.<span class='break'> </span>network<span class='break'> </span>.<span class='break'> </span>WirelessMode</a></li>
<li><a href="../symbols/hcap.power.html">hcap<span class='break'> </span>.<span class='break'> </span>power</a></li>
<li><a href="../symbols/hcap.power.PowerMode.html">hcap<span class='break'> </span>.<span class='break'> </span>power<span class='break'> </span>.<span class='break'> </span>PowerMode</a></li>
<li><a href="../symbols/hcap.preloadedApplication.html">hcap<span class='break'> </span>.<span class='break'> </span>preloadedApplication</a></li>
<li><a href="../symbols/hcap.property.html">hcap<span class='break'> </span>.<span class='break'> </span>property</a></li>
<li><a href="../symbols/hcap.property.InstallerMenuItem.html">hcap<span class='break'> </span>.<span class='break'> </span>property<span class='break'> </span>.<span class='break'> </span>InstallerMenuItem</a></li>
<li><a href="../symbols/hcap.property.PictureMode.html">hcap<span class='break'> </span>.<span class='break'> </span>property<span class='break'> </span>.<span class='break'> </span>PictureMode</a></li>
<li><a href="../symbols/hcap.property.PicturePropertyKey.html">hcap<span class='break'> </span>.<span class='break'> </span>property<span class='break'> </span>.<span class='break'> </span>PicturePropertyKey</a></li>
<li><a href="../symbols/hcap.rms.html">hcap<span class='break'> </span>.<span class='break'> </span>rms</a></li>
<li><a href="../symbols/hcap.rs232c.html">hcap<span class='break'> </span>.<span class='break'> </span>rs232c</a></li>
<li><a href="../symbols/hcap.rs232c.BaudRate.html">hcap<span class='break'> </span>.<span class='break'> </span>rs232c<span class='break'> </span>.<span class='break'> </span>BaudRate</a></li>
<li><a href="../symbols/hcap.rs232c.DataBit.html">hcap<span class='break'> </span>.<span class='break'> </span>rs232c<span class='break'> </span>.<span class='break'> </span>DataBit</a></li>
<li><a href="../symbols/hcap.rs232c.FlowControl.html">hcap<span class='break'> </span>.<span class='break'> </span>rs232c<span class='break'> </span>.<span class='break'> </span>FlowControl</a></li>
<li><a href="../symbols/hcap.rs232c.Parity.html">hcap<span class='break'> </span>.<span class='break'> </span>rs232c<span class='break'> </span>.<span class='break'> </span>Parity</a></li>
<li><a href="../symbols/hcap.rs232c.StopBit.html">hcap<span class='break'> </span>.<span class='break'> </span>rs232c<span class='break'> </span>.<span class='break'> </span>StopBit</a></li>
<li><a href="../symbols/hcap.security.html">hcap<span class='break'> </span>.<span class='break'> </span>security</a></li>
<li><a href="../symbols/hcap.socket.html">hcap<span class='break'> </span>.<span class='break'> </span>socket</a></li>
<li><a href="../symbols/hcap.speech.html">hcap<span class='break'> </span>.<span class='break'> </span>speech</a></li>
<li><a href="../symbols/hcap.speech.HostType.html">hcap<span class='break'> </span>.<span class='break'> </span>speech<span class='break'> </span>.<span class='break'> </span>HostType</a></li>
<li><a href="../symbols/hcap.system.html">hcap<span class='break'> </span>.<span class='break'> </span>system</a></li>
<li><a href="../symbols/hcap.system.SoundOutputType.html">hcap<span class='break'> </span>.<span class='break'> </span>system<span class='break'> </span>.<span class='break'> </span>SoundOutputType</a></li>
<li><a href="../symbols/hcap.time.html">hcap<span class='break'> </span>.<span class='break'> </span>time</a></li>
<li><a href="../symbols/hcap.video.html">hcap<span class='break'> </span>.<span class='break'> </span>video</a></li>
<li><a href="../symbols/hcap.volume.html">hcap<span class='break'> </span>.<span class='break'> </span>volume</a></li>
<li><a href="../symbols/hcap.webrtc.html">hcap<span class='break'> </span>.<span class='break'> </span>webrtc</a></li>
</ul>
</nav>
</div>
<div class="fineprint" style="clear:both">
<footer>
Documentation generator: <a href="http://code.google.com/p/jsdoc-toolkit/" target="_blank">JsDoc Toolkit</a> 2.4.0<br />
Template: <a href="http://www.thebrightlines.com/2010/05/06/new-template-for-jsdoctoolkit-codeview/" target="_blank">Codeview</a> 1.2<br />
Generated on:
<time datetime='2021-8-13' pubdate>2021-8-13 18:29</time>
</footer>
</div>
</div>
<div class="index indexStatic"></div>
<div class="content">
<div class="innerContent">
<article>
<header>
<h1 class="classTitle">
Namespace <span>hcap.webrtc</span>
</h1>
<div class="intro">
<p class="description summary">
hcap.webrtc
</p>
<ul class="summary">
<li>Defined in: <a href="../symbols/src/js_hcap-1.24.6.5901.js.html">hcap-1.24.6.5901.js</a></li>
</ul>
</div>
</header>
<section>
<div class="props">
<table class="summaryTable" cellspacing="0" summary="A summary of the constructor documented in the class hcap.webrtc.">
<caption class="sectionTitle">Namespace Summary</caption>
<thead>
<tr>
<th scope="col">Constructor Attributes</th>
<th scope="col">Constructor Name and Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="attributes">&nbsp;</td>
<td class="nameDescription" >
<div class="fixedFont">
<b><a href="../symbols/hcap.webrtc.html#constructor">hcap.webrtc</a></b>
</div>
<div class="description"></div>
</td>
</tr>
</tbody>
</table>
</div>
</section>
<!--
#### METHODS SUMMARY
-->
<section>
<div class="props">
<h2 class="sectionTitle">Method Summary</h2>
<nav>
<table class="summaryTable" id="MethodsList" cellspacing="0" summary="A summary of the methods documented in the class hcap.webrtc.">
<thead>
<tr>
<th scope="col">Method Attributes</th>
<th scope="col">Method Name and Description</th>
</tr>
</thead>
<tbody>
<tr
class='item0'
>
<td class="attributes">&lt;static&gt; &nbsp;</td>
<td class="nameDescription">
<div class="fixedFont">hcap.webrtc.<b><a href="../symbols/hcap.webrtc.html#.acceptMessage">acceptMessage</a></b>(param)
</div>
<div class="description">Sends a message to webrtc service.</div>
</td>
</tr>
<tr
class='item1'
>
<td class="attributes">&lt;static&gt; &nbsp;</td>
<td class="nameDescription">
<div class="fixedFont">hcap.webrtc.<b><a href="../symbols/hcap.webrtc.html#.endCall">endCall</a></b>(param)
</div>
<div class="description">Ends a call.</div>
</td>
</tr>
<tr
class='item2'
>
<td class="attributes">&lt;static&gt; &nbsp;</td>
<td class="nameDescription">
<div class="fixedFont">hcap.webrtc.<b><a href="../symbols/hcap.webrtc.html#.getConfiguration">getConfiguration</a></b>(param)
</div>
<div class="description">Gets WebRTC configurations.</div>
</td>
</tr>
<tr
class='item3'
>
<td class="attributes">&lt;static&gt; &nbsp;</td>
<td class="nameDescription">
<div class="fixedFont">hcap.webrtc.<b><a href="../symbols/hcap.webrtc.html#.incomingCall">incomingCall</a></b>(param)
</div>
<div class="description">Receives an incoming call.</div>
</td>
</tr>
<tr
class='item4'
>
<td class="attributes">&lt;static&gt; &nbsp;</td>
<td class="nameDescription">
<div class="fixedFont">hcap.webrtc.<b><a href="../symbols/hcap.webrtc.html#.outgoingCall">outgoingCall</a></b>(param)
</div>
<div class="description">Makes an outgoing call.</div>
</td>
</tr>
<tr
class='item5'
>
<td class="attributes">&lt;static&gt; &nbsp;</td>
<td class="nameDescription">
<div class="fixedFont">hcap.webrtc.<b><a href="../symbols/hcap.webrtc.html#.setConfiguration">setConfiguration</a></b>(param)
</div>
<div class="description">Sets WebRTC configuration.</div>
</td>
</tr>
<tr
class='item6'
>
<td class="attributes">&lt;static&gt; &nbsp;</td>
<td class="nameDescription">
<div class="fixedFont">hcap.webrtc.<b><a href="../symbols/hcap.webrtc.html#.showDiagnostics">showDiagnostics</a></b>(param)
</div>
<div class="description">Shows diagnostics.</div>
</td>
</tr>
<tr
class='item7'
>
<td class="attributes">&lt;static&gt; &nbsp;</td>
<td class="nameDescription">
<div class="fixedFont">hcap.webrtc.<b><a href="../symbols/hcap.webrtc.html#.startCheckAudio">startCheckAudio</a></b>(param)
</div>
<div class="description">Checks local audio.</div>
</td>
</tr>
<tr
class='item8'
>
<td class="attributes">&lt;static&gt; &nbsp;</td>
<td class="nameDescription">
<div class="fixedFont">hcap.webrtc.<b><a href="../symbols/hcap.webrtc.html#.startPreviewVideo">startPreviewVideo</a></b>(param)
</div>
<div class="description">Plays the video stream from local video.</div>
</td>
</tr>
<tr
class='item9'
>
<td class="attributes">&lt;static&gt; &nbsp;</td>
<td class="nameDescription">
<div class="fixedFont">hcap.webrtc.<b><a href="../symbols/hcap.webrtc.html#.stopCheckAudio">stopCheckAudio</a></b>(param)
</div>
<div class="description">Stops <a href="hcap.webrtc.html#.startCheckAudio">hcap.webrtc.startCheckAudio()</a>.</div>
</td>
</tr>
<tr
class='item10'
>
<td class="attributes">&lt;static&gt; &nbsp;</td>
<td class="nameDescription">
<div class="fixedFont">hcap.webrtc.<b><a href="../symbols/hcap.webrtc.html#.stopPreviewVideo">stopPreviewVideo</a></b>(param)
</div>
<div class="description">Stops playing local video.</div>
</td>
</tr>
</tbody>
</table>
</nav>
</div>
</section>
<!--
#### EVENTS SUMMARY
-->
<!--
#### CONSTRUCTOR DETAILS
-->
<section>
<div class="details props">
<div class="innerProps">
<h2 class="sectionTitle" id="constructor">
Namespace Detail
</h2>
<div class="fixedFont">
<b>hcap.webrtc</b>
</div>
<div class="description">
</div>
</div>
</div>
</section>
<!--
#### FIELD DETAILS
-->
<!--
#### METHOD DETAILS
-->
<section>
<div class="details props">
<div class="innerProps">
<h2 class="sectionTitle">
Method Detail
</h2>
<ul class="methodDetail" id="MethodDetail">
<li
class='item0'
>
<div class="fixedFont heading" id=".acceptMessage">
<span class='lighter'>
&lt;static&gt;
</span>
<span class="light">hcap.webrtc.</span><b>acceptMessage</b>(param)
</div>
<div class="description">
Sends a message to webrtc service. Predefined types of message can be passed to webrtc service.
<br>
</div>
<pre class="code prettyprint">hcap.webrtc.acceptMessage({
"remoteId" : 2,
"rtcMsg" : "{"type":"answer","sdp":"v=0\r\no=- 4474142502554476113 2 IN IP4 127.0.0.1\r\ns=-\r\nt=0 0\r\na=group:BUNDLE audio video..."}",
"onSuccess" : function() {
console.log("onSuccess");
},
"onFailure" : function(f) {
console.log("onFailure : errorMessage = " + f.errorMessage);
}
});</pre>
<dl class="detailList params">
<dt class="heading">Parameters:</dt>
<dt>
<span class="light fixedFont">{Object}</span> <b>param</b>
</dt>
<dd><ul>
<li>{Number} param.remoteId [Required] - peer ID
<li>{String} param.rtcMsg [Required] - message which be sent to webrtc service, such as SDP, ICE configuration, and so on.
<li>{Function} param.onSuccess [Optional] - success callback function.
<pre class="code prettyprint">
param.onSuccess = function() {
// No Parameter.
}</pre>
</li>
<li>{Function} param.onFailure [Optional] - failure callback function.
<pre class="code prettyprint">
param.onFailure = function (param) {
// {String} param.errorMessage - in case of failure, this message provides the details.
}</pre>
</li>
</ul></dd>
</dl>
<dl class="detailList nomargin">
<dl class="detailList params">
<dt class="heading">Deprecated:</dt>
<dt>
since 1.24
</dt>
</dl>
<dl class="detailList params">
<dt class="heading">See:</dt>
<dd><a href="_global_.html#event:webrtc_message_received">{Event} webrtc_message_received</a><br>
<a href="_global_.html#event:webrtc_event_received">{Event} webrtc_event_received</a><br>
<a href="hcap.webrtc.html#.startPreviewVideo">hcap.webrtc.startPreviewVideo()</a><br>
<a href="hcap.webrtc.html#.stopPreviewVideo">hcap.webrtc.stopPreviewVideo()</a><br>
<a href="hcap.webrtc.html#.incomingCall">hcap.webrtc.incomingCall()</a><br>
<a href="hcap.webrtc.html#.outgoingCall">hcap.webrtc.outgoingCall()</a><br>
<a href="hcap.webrtc.html#.endCall">hcap.webrtc.endCall()</a><br>
<a href="hcap.webrtc.html#.startCheckAudio">hcap.webrtc.startCheckAudio()</a><br>
<a href="hcap.webrtc.html#.stopCheckAudio">hcap.webrtc.stopCheckAudio()</a><br>
<a href="hcap.webrtc.html#.setConfiguration">hcap.webrtc.setConfiguration()</a><br>
<a href="hcap.webrtc.html#.getConfiguration">hcap.webrtc.getConfiguration()</a><br>
<a href="hcap.webrtc.html#.showDiagnostics">hcap.webrtc.showDiagnostics()</a><br></dd>
</dl>
</dl>
<div class="hr"></div>
</li>
<li
class='item1'
>
<div class="fixedFont heading" id=".endCall">
<span class='lighter'>
&lt;static&gt;
</span>
<span class="light">hcap.webrtc.</span><b>endCall</b>(param)
</div>
<div class="description">
Ends a call.<br>
</div>
<pre class="code prettyprint">hcap.webrtc.endCall({
"onSuccess" : function() {
console.log("onSuccess");
},
"onFailure" : function(f) {
console.log("onFailure : errorMessage = " + f.errorMessage);
}
});</pre>
<dl class="detailList params">
<dt class="heading">Parameters:</dt>
<dt>
<span class="light fixedFont">{Object}</span> <b>param</b>
</dt>
<dd><ul>
<li>{Function} param.onSuccess [Optional] - success callback function.
<pre class="code prettyprint">
param.onSuccess = function() {
// No Parameter.
}</pre>
</li>
<li>{Function} param.onFailure [Optional] - failure callback function.
<pre class="code prettyprint">
param.onFailure = function (param) {
// {String} param.errorMessage - in case of failure, this message provides the details.
}</pre>
</li>
</ul></dd>
</dl>
<dl class="detailList nomargin">
<dl class="detailList params">
<dt class="heading">Deprecated:</dt>
<dt>
since 1.24
</dt>
</dl>
<dl class="detailList params">
<dt class="heading">See:</dt>
<dd><a href="_global_.html#event:webrtc_message_received">{Event} webrtc_message_received</a><br>
<a href="_global_.html#event:webrtc_event_received">{Event} webrtc_event_received</a><br>
<a href="hcap.webrtc.html#.startPreviewVideo">hcap.webrtc.startPreviewVideo()</a><br>
<a href="hcap.webrtc.html#.stopPreviewVideo">hcap.webrtc.stopPreviewVideo()</a><br>
<a href="hcap.webrtc.html#.incomingCall">hcap.webrtc.incomingCall()</a><br>
<a href="hcap.webrtc.html#.outgoingCall">hcap.webrtc.outgoingCall()</a><br>
<a href="hcap.webrtc.html#.acceptMessage">hcap.webrtc.acceptMessage()</a><br>
<a href="hcap.webrtc.html#.startCheckAudio">hcap.webrtc.startCheckAudio()</a><br>
<a href="hcap.webrtc.html#.stopCheckAudio">hcap.webrtc.stopCheckAudio()</a><br>
<a href="hcap.webrtc.html#.setConfiguration">hcap.webrtc.setConfiguration()</a><br>
<a href="hcap.webrtc.html#.getConfiguration">hcap.webrtc.getConfiguration()</a><br>
<a href="hcap.webrtc.html#.showDiagnostics">hcap.webrtc.showDiagnostics()</a><br></dd>
</dl>
</dl>
<div class="hr"></div>
</li>
<li
class='item2'
>
<div class="fixedFont heading" id=".getConfiguration">
<span class='lighter'>
&lt;static&gt;
</span>
<span class="light">hcap.webrtc.</span><b>getConfiguration</b>(param)
</div>
<div class="description">
Gets WebRTC configurations. This return the list of configrations.<br>
</div>
<pre class="code prettyprint">hcap.webrtc.getConfiguration({
"onSuccess" : function(s) {
console.log("onSuccess : configurations = " + s.configurations);
},
"onFailure" : function(f) {
console.log("onFailure : errorMessage = " + f.errorMessage);
}
});</pre>
<dl class="detailList params">
<dt class="heading">Parameters:</dt>
<dt>
<span class="light fixedFont">{Object}</span> <b>param</b>
</dt>
<dd><ul>
<li>{Function} param.onSuccess [Optional] - success callback function.
<pre class="code prettyprint">
param.onSuccess = function (param) {
// {String} param.configurations - configurations string.
}</pre>
</li>
<li>{Function} param.onFailure [Optional] - failure callback function.
<pre class="code prettyprint">
param.onFailure = function (param) {
// {String} param.errorMessage - in case of failure, this message provides the details.
}</pre>
</li>
</ul></dd>
</dl>
<dl class="detailList nomargin">
<dl class="detailList params">
<dt class="heading">Deprecated:</dt>
<dt>
since 1.24
</dt>
</dl>
<dl class="detailList params">
<dt class="heading">See:</dt>
<dd><a href="_global_.html#event:webrtc_message_received">{Event} webrtc_message_received</a><br>
<a href="_global_.html#event:webrtc_event_received">{Event} webrtc_event_received</a><br>
<a href="hcap.webrtc.html#.startPreviewVideo">hcap.webrtc.startPreviewVideo()</a><br>
<a href="hcap.webrtc.html#.stopPreviewVideo">hcap.webrtc.stopPreviewVideo()</a><br>
<a href="hcap.webrtc.html#.incomingCall">hcap.webrtc.incomingCall()</a><br>
<a href="hcap.webrtc.html#.outgoingCall">hcap.webrtc.outgoingCall()</a><br>
<a href="hcap.webrtc.html#.endCall">hcap.webrtc.endCall()</a><br>
<a href="hcap.webrtc.html#.acceptMessage">hcap.webrtc.acceptMessage()</a><br>
<a href="hcap.webrtc.html#.startCheckAudio">hcap.webrtc.startCheckAudio()</a><br>
<a href="hcap.webrtc.html#.stopCheckAudio">hcap.webrtc.stopCheckAudio()</a><br>
<a href="hcap.webrtc.html#.setConfiguration">hcap.webrtc.setConfiguration()</a><br>
<a href="hcap.webrtc.html#.showDiagnostics">hcap.webrtc.showDiagnostics()</a><br></dd>
</dl>
</dl>
<div class="hr"></div>
</li>
<li
class='item3'
>
<div class="fixedFont heading" id=".incomingCall">
<span class='lighter'>
&lt;static&gt;
</span>
<span class="light">hcap.webrtc.</span><b>incomingCall</b>(param)
</div>
<div class="description">
Receives an incoming call. This API should be included the information of peer's SDP(Session Description Protocol).<br>
</div>
<pre class="code prettyprint">hcap.webrtc.incomingCall({
"localId" : 1,
"remoteId" : 2,
"remoteSDP" : "{"sdp" : "v=0\r\no=- 3454157150814283647 2 IN IP4 127.0.0.1\r\ns=-\r\nt=0 0\r\na=group:BUNDLE audio video\r\..."}",
"onSuccess" : function() {
console.log("onSuccess");
},
"onFailure" : function(f) {
console.log("onFailure : errorMessage = " + f.errorMessage);
}
});</pre>
<dl class="detailList params">
<dt class="heading">Parameters:</dt>
<dt>
<span class="light fixedFont">{Object}</span> <b>param</b>
</dt>
<dd><ul>
<li>{Number} param.localId [Required] - local(my) ID
<li>{Number} param.remoteId [Required] - peer(who makes a call to me) ID
<li>{String} param.remoteSDP[Required] - peer SDP
<li>{Function} param.onSuccess [Optional] - success callback function.
<pre class="code prettyprint">
param.onSuccess = function() {
// No Parameter.
}</pre>
</li>
<li>{Function} param.onFailure [Optional] - failure callback function.
<pre class="code prettyprint">
param.onFailure = function (param) {
// {String} param.errorMessage - in case of failure, this message provides the details.
}</pre>
</li>
</ul></dd>
</dl>
<dl class="detailList nomargin">
<dl class="detailList params">
<dt class="heading">Deprecated:</dt>
<dt>
since 1.24
</dt>
</dl>
<dl class="detailList params">
<dt class="heading">See:</dt>
<dd><a href="_global_.html#event:webrtc_message_received">{Event} webrtc_message_received</a><br>
<a href="_global_.html#event:webrtc_event_received">{Event} webrtc_event_received</a><br>
<a href="hcap.webrtc.html#.startPreviewVideo">hcap.webrtc.startPreviewVideo()</a><br>
<a href="hcap.webrtc.html#.stopPreviewVideo">hcap.webrtc.stopPreviewVideo()</a><br>
<a href="hcap.webrtc.html#.outgoingCall">hcap.webrtc.outgoingCall()</a><br>
<a href="hcap.webrtc.html#.endCall">hcap.webrtc.endCall()</a><br>
<a href="hcap.webrtc.html#.acceptMessage">hcap.webrtc.acceptMessage()</a><br>
<a href="hcap.webrtc.html#.startCheckAudio">hcap.webrtc.startCheckAudio()</a><br>
<a href="hcap.webrtc.html#.stopCheckAudio">hcap.webrtc.stopCheckAudio()</a><br>
<a href="hcap.webrtc.html#.setConfiguration">hcap.webrtc.setConfiguration()</a><br>
<a href="hcap.webrtc.html#.getConfiguration">hcap.webrtc.getConfiguration()</a><br>
<a href="hcap.webrtc.html#.showDiagnostics">hcap.webrtc.showDiagnostics()</a><br></dd>
</dl>
</dl>
<div class="hr"></div>
</li>
<li
class='item4'
>
<div class="fixedFont heading" id=".outgoingCall">
<span class='lighter'>
&lt;static&gt;
</span>
<span class="light">hcap.webrtc.</span><b>outgoingCall</b>(param)
</div>
<div class="description">
Makes an outgoing call. This API lead to create WebRTC object and local SDP.
The local SDP will be passed to HCAP by an event <a href="_global_.html#event:webrtc_message_received">{Event} webrtc_message_received</a>.<br>
</div>
<pre class="code prettyprint">hcap.webrtc.outgoingCall({
"localId" : 1,
"remoteId" : 2,
"onSuccess" : function() {
console.log("onSuccess");
},
"onFailure" : function(f) {
console.log("onFailure : errorMessage = " + f.errorMessage);
}
});</pre>
<dl class="detailList params">
<dt class="heading">Parameters:</dt>
<dt>
<span class="light fixedFont">{Object}</span> <b>param</b>
</dt>
<dd><ul>
<li>{Number} param.localId [Required] - local(my) ID
<li>{Number} param.remoteId [Required] - peer(who I want to call) ID
<li>{Function} param.onSuccess [Optional] - success callback function.
<pre class="code prettyprint">
param.onSuccess = function() {
// No Parameter.
}</pre>
</li>
<li>{Function} param.onFailure [Optional] - failure callback function.
<pre class="code prettyprint">
param.onFailure = function (param) {
// {String} param.errorMessage - in case of failure, this message provides the details.
}</pre>
</li>
</ul></dd>
</dl>
<dl class="detailList nomargin">
<dl class="detailList params">
<dt class="heading">Deprecated:</dt>
<dt>
since 1.24
</dt>
</dl>
<dl class="detailList params">
<dt class="heading">See:</dt>
<dd><a href="_global_.html#event:webrtc_message_received">{Event} webrtc_message_received</a><br>
<a href="_global_.html#event:webrtc_event_received">{Event} webrtc_event_received</a><br>
<a href="hcap.webrtc.html#.startPreviewVideo">hcap.webrtc.startPreviewVideo()</a><br>
<a href="hcap.webrtc.html#.stopPreviewVideo">hcap.webrtc.stopPreviewVideo()</a><br>
<a href="hcap.webrtc.html#.incomingCall">hcap.webrtc.incomingCall()</a><br>
<a href="hcap.webrtc.html#.endCall">hcap.webrtc.endCall()</a><br>
<a href="hcap.webrtc.html#.acceptMessage">hcap.webrtc.acceptMessage()</a><br>
<a href="hcap.webrtc.html#.startCheckAudio">hcap.webrtc.startCheckAudio()</a><br>
<a href="hcap.webrtc.html#.stopCheckAudio">hcap.webrtc.stopCheckAudio()</a><br>
<a href="hcap.webrtc.html#.setConfiguration">hcap.webrtc.setConfiguration()</a><br>
<a href="hcap.webrtc.html#.getConfiguration">hcap.webrtc.getConfiguration()</a><br>
<a href="hcap.webrtc.html#.showDiagnostics">hcap.webrtc.showDiagnostics()</a><br></dd>
</dl>
</dl>
<div class="hr"></div>
</li>
<li
class='item5'
>
<div class="fixedFont heading" id=".setConfiguration">
<span class='lighter'>
&lt;static&gt;
</span>
<span class="light">hcap.webrtc.</span><b>setConfiguration</b>(param)
</div>
<div class="description">
Sets WebRTC configuration.<br>
</div>
<pre class="code prettyprint">hcap.webrtc.setConfiguration({
"key" : "max_height",
"value" : "480",
"onSuccess" : function() {
console.log("onSuccess");
},
"onFailure" : function(f) {
console.log("onFailure : errorMessage = " + f.errorMessage);
}
});</pre>
<dl class="detailList params">
<dt class="heading">Parameters:</dt>
<dt>
<span class="light fixedFont">{Object}</span> <b>param</b>
</dt>
<dd><ul>
<li>{String} param.key [Required] - configuration key to be set.
<li>{String} param.value [Required] - configuration value to be set.<br>
<div>
<table class="hcap_spec">
<thead>
<tr>
<th>Key</th>
<th>Description</th>
<th>Read/Write</th>
<th>Value Format</th>
<th>Value example (default value for the predefined value set)</th>
</tr>
</thead>
<tbody>
<tr class="odd">
<td>ice_cfg</td>
<td class="left">STUN/TURN server infomation</td>
<td>Read/Write</td>
<td class="left">[version string]<br>';' '|' ':'</td>
<td>stun:stun.l.google.com:19302;turn:89.108.113.194:3478|webrtc|webrtc</td>
</tr>
<tr>
<td>peer_server_name</td>
<td class="left">IP address of peer connection server</td>
<td>Read/Write</td>
<td class="left">[version string]<br>ip address</td>
<td>192.168.0.2</td>
</tr>
<tr class="odd">
<td>peer_server_port</td>
<td class="left">Port number of peer connection server</td>
<td>Read/Write</td>
<td class="left">[version string]<br>integer</td>
<td>8888</td>
</tr>
<tr>
<td>user_name</td>
<td class="left">User name to log-in</td>
<td>Read/Write</td>
<td class="left">[version string]<br>free format string</td>
<td>Andy</td>
</tr>
<li>{Function} param.onSuccess [Optional] - success callback function.
<pre class="code prettyprint">
param.onSuccess = function() {
// No Parameter.
}</pre>
</li>
<li>{Function} param.onFailure [Optional] - failure callback function.
<pre class="code prettyprint">
param.onFailure = function (param) {
// {String} param.errorMessage - in case of failure, this message provides the details.
}</pre>
</li>
</ul></dd>
</dl>
<dl class="detailList nomargin">
<dl class="detailList params">
<dt class="heading">Deprecated:</dt>
<dt>
since 1.24
</dt>
</dl>
<dl class="detailList params">
<dt class="heading">See:</dt>
<dd><a href="_global_.html#event:webrtc_message_received">{Event} webrtc_message_received</a><br>
<a href="_global_.html#event:webrtc_event_received">{Event} webrtc_event_received</a><br>
<a href="hcap.webrtc.html#.startPreviewVideo">hcap.webrtc.startPreviewVideo()</a><br>
<a href="hcap.webrtc.html#.stopPreviewVideo">hcap.webrtc.stopPreviewVideo()</a><br>
<a href="hcap.webrtc.html#.incomingCall">hcap.webrtc.incomingCall()</a><br>
<a href="hcap.webrtc.html#.outgoingCall">hcap.webrtc.outgoingCall()</a><br>
<a href="hcap.webrtc.html#.endCall">hcap.webrtc.endCall()</a><br>
<a href="hcap.webrtc.html#.acceptMessage">hcap.webrtc.acceptMessage()</a><br>
<a href="hcap.webrtc.html#.startCheckAudio">hcap.webrtc.startCheckAudio()</a><br>
<a href="hcap.webrtc.html#.stopCheckAudio">hcap.webrtc.stopCheckAudio()</a><br>
<a href="hcap.webrtc.html#.getConfiguration">hcap.webrtc.getConfiguration()</a><br>
<a href="hcap.webrtc.html#.showDiagnostics">hcap.webrtc.showDiagnostics()</a><br></dd>
</dl>
</dl>
<div class="hr"></div>
</li>
<li
class='item6'
>
<div class="fixedFont heading" id=".showDiagnostics">
<span class='lighter'>
&lt;static&gt;
</span>
<span class="light">hcap.webrtc.</span><b>showDiagnostics</b>(param)
</div>
<div class="description">
Shows diagnostics.<br>
</div>
<pre class="code prettyprint">hcap.webrtc.showDiagnostics({
"onSuccess" : function() {
console.log("onSuccess");
},
"onFailure" : function(f) {
console.log("onFailure : errorMessage = " + f.errorMessage);
}
});</pre>
<dl class="detailList params">
<dt class="heading">Parameters:</dt>
<dt>
<span class="light fixedFont">{Object}</span> <b>param</b>
</dt>
<dd><ul>
<li>{Function} param.onSuccess [Optional] - success callback function.
<pre class="code prettyprint">
param.onSuccess = function() {
// No Parameter.
}</pre>
</li>
<li>{Function} param.onFailure [Optional] - failure callback function.
<pre class="code prettyprint">
param.onFailure = function (param) {
// {String} param.errorMessage - in case of failure, this message provides the details.
}</pre>
</li>
</ul></dd>
</dl>
<dl class="detailList nomargin">
<dl class="detailList params">
<dt class="heading">Deprecated:</dt>
<dt>
since 1.24
</dt>
</dl>
<dl class="detailList params">
<dt class="heading">See:</dt>
<dd><a href="_global_.html#event:webrtc_message_received">{Event} webrtc_message_received</a><br>
<a href="_global_.html#event:webrtc_event_received">{Event} webrtc_event_received</a><br>
<a href="hcap.webrtc.html#.startPreviewVideo">hcap.webrtc.startPreviewVideo()</a><br>
<a href="hcap.webrtc.html#.stopPreviewVideo">hcap.webrtc.stopPreviewVideo()</a><br>
<a href="hcap.webrtc.html#.incomingCall">hcap.webrtc.incomingCall()</a><br>
<a href="hcap.webrtc.html#.outgoingCall">hcap.webrtc.outgoingCall()</a><br>
<a href="hcap.webrtc.html#.endCall">hcap.webrtc.endCall()</a><br>
<a href="hcap.webrtc.html#.acceptMessage">hcap.webrtc.acceptMessage()</a><br>
<a href="hcap.webrtc.html#.startCheckAudio">hcap.webrtc.startCheckAudio()</a><br>
<a href="hcap.webrtc.html#.stopCheckAudio">hcap.webrtc.stopCheckAudio()</a><br>
<a href="hcap.webrtc.html#.setConfiguration">hcap.webrtc.setConfiguration()</a><br>
<a href="hcap.webrtc.html#.getConfiguration">hcap.webrtc.getConfiguration()</a><br></dd>
</dl>
</dl>
<div class="hr"></div>
</li>
<li
class='item7'
>
<div class="fixedFont heading" id=".startCheckAudio">
<span class='lighter'>
&lt;static&gt;
</span>
<span class="light">hcap.webrtc.</span><b>startCheckAudio</b>(param)
</div>
<div class="description">
Checks local audio. This API can test the local sound by 2-step.<br>
step1: Set the param.type as a 'microphone' to test input works well or not. It record the sound only from microphone.
step2: Set the param.type as a 'speaker' to test the output works well or not. It plays the recorded sound from 'microphone' test.
Each step will be done by <a href="hcap.webrtc.html#.stopCheckAudio">hcap.webrtc.stopCheckAudio()</a>.
</div>
<pre class="code prettyprint">hcap.webrtc.startCheckAudio({
"type" : "microphone",
"onSuccess" : function() {
console.log("onSuccess");
},
"onFailure" : function(f) {
console.log("onFailure : errorMessage = " + f.errorMessage);
}
});</pre>
<dl class="detailList params">
<dt class="heading">Parameters:</dt>
<dt>
<span class="light fixedFont">{Object}</span> <b>param</b>
</dt>
<dd><ul>
<li>{String} param.type [Required] - microphone | speaker
<li>{Function} param.onSuccess [Optional] - success callback function.
<pre class="code prettyprint">
param.onSuccess = function() {
// No Parameter.
}</pre>
</li>
<li>{Function} param.onFailure [Optional] - failure callback function.
<pre class="code prettyprint">
param.onFailure = function (param) {
// {String} param.errorMessage - in case of failure, this message provides the details.
}</pre>
</li>
</ul></dd>
</dl>
<dl class="detailList nomargin">
<dl class="detailList params">
<dt class="heading">Deprecated:</dt>
<dt>
since 1.24
</dt>
</dl>
<dl class="detailList params">
<dt class="heading">See:</dt>
<dd><a href="_global_.html#event:webrtc_message_received">{Event} webrtc_message_received</a><br>
<a href="_global_.html#event:webrtc_event_received">{Event} webrtc_event_received</a><br>
<a href="hcap.webrtc.html#.startPreviewVideo">hcap.webrtc.startPreviewVideo()</a><br>
<a href="hcap.webrtc.html#.stopPreviewVideo">hcap.webrtc.stopPreviewVideo()</a><br>
<a href="hcap.webrtc.html#.incomingCall">hcap.webrtc.incomingCall()</a><br>
<a href="hcap.webrtc.html#.outgoingCall">hcap.webrtc.outgoingCall()</a><br>
<a href="hcap.webrtc.html#.endCall">hcap.webrtc.endCall()</a><br>
<a href="hcap.webrtc.html#.acceptMessage">hcap.webrtc.acceptMessage()</a><br>
<a href="hcap.webrtc.html#.stopCheckAudio">hcap.webrtc.stopCheckAudio()</a><br>
<a href="hcap.webrtc.html#.setConfiguration">hcap.webrtc.setConfiguration()</a><br>
<a href="hcap.webrtc.html#.getConfiguration">hcap.webrtc.getConfiguration()</a><br>
<a href="hcap.webrtc.html#.showDiagnostics">hcap.webrtc.showDiagnostics()</a><br></dd>
</dl>
</dl>
<div class="hr"></div>
</li>
<li
class='item8'
>
<div class="fixedFont heading" id=".startPreviewVideo">
<span class='lighter'>
&lt;static&gt;
</span>
<span class="light">hcap.webrtc.</span><b>startPreviewVideo</b>(param)
</div>
<div class="description">
Plays the video stream from local video. This is for checking local video works well or not.<br>
</div>
<pre class="code prettyprint">hcap.webrtc.startPreviewVideo({
"onSuccess" : function() {
console.log("onSuccess");
},
"onFailure" : function(f) {
console.log("onFailure : errorMessage = " + f.errorMessage);
}
});</pre>
<dl class="detailList params">
<dt class="heading">Parameters:</dt>
<dt>
<span class="light fixedFont">{Object}</span> <b>param</b>
</dt>
<dd><ul>
<li>{Function} param.onSuccess [Optional] - success callback function.
<pre class="code prettyprint">
param.onSuccess = function() {
// No Parameter.
}</pre>
</li>
<li>{Function} param.onFailure [Optional] - failure callback function.
<pre class="code prettyprint">
param.onFailure = function (param) {
// {String} param.errorMessage - in case of failure, this message provides the details.
}</pre>
</li>
</ul></dd>
</dl>
<dl class="detailList nomargin">
<dl class="detailList params">
<dt class="heading">Deprecated:</dt>
<dt>
since 1.24
</dt>
</dl>
<dl class="detailList params">
<dt class="heading">See:</dt>
<dd><a href="_global_.html#event:webrtc_message_received">{Event} webrtc_message_received</a><br>
<a href="_global_.html#event:webrtc_event_received">{Event} webrtc_event_received</a><br>
<a href="hcap.webrtc.html#.stopPreviewVideo">hcap.webrtc.stopPreviewVideo()</a><br>
<a href="hcap.webrtc.html#.incomingCall">hcap.webrtc.incomingCall()</a><br>
<a href="hcap.webrtc.html#.outgoingCall">hcap.webrtc.outgoingCall()</a><br>
<a href="hcap.webrtc.html#.endCall">hcap.webrtc.endCall()</a><br>
<a href="hcap.webrtc.html#.acceptMessage">hcap.webrtc.acceptMessage()</a><br>
<a href="hcap.webrtc.html#.startCheckAudio">hcap.webrtc.startCheckAudio()</a><br>
<a href="hcap.webrtc.html#.stopCheckAudio">hcap.webrtc.stopCheckAudio()</a><br>
<a href="hcap.webrtc.html#.setConfiguration">hcap.webrtc.setConfiguration()</a><br>
<a href="hcap.webrtc.html#.getConfiguration">hcap.webrtc.getConfiguration()</a><br>
<a href="hcap.webrtc.html#.showDiagnostics">hcap.webrtc.showDiagnostics()</a><br></dd>
</dl>
</dl>
<div class="hr"></div>
</li>
<li
class='item9'
>
<div class="fixedFont heading" id=".stopCheckAudio">
<span class='lighter'>
&lt;static&gt;
</span>
<span class="light">hcap.webrtc.</span><b>stopCheckAudio</b>(param)
</div>
<div class="description">
Stops <a href="hcap.webrtc.html#.startCheckAudio">hcap.webrtc.startCheckAudio()</a>.<br>
</div>
<pre class="code prettyprint">hcap.webrtc.stopCheckAudio({
"onSuccess" : function() {
console.log("onSuccess");
},
"onFailure" : function(f) {
console.log("onFailure : errorMessage = " + f.errorMessage);
}
});</pre>
<dl class="detailList params">
<dt class="heading">Parameters:</dt>
<dt>
<span class="light fixedFont">{Object}</span> <b>param</b>
</dt>
<dd><ul>
<li>{Function} param.onSuccess [Optional] - success callback function.
<pre class="code prettyprint">
param.onSuccess = function() {
// No Parameter.
}</pre>
</li>
<li>{Function} param.onFailure [Optional] - failure callback function.
<pre class="code prettyprint">
param.onFailure = function (param) {
// {String} param.errorMessage - in case of failure, this message provides the details.
}</pre>
</li>
</ul></dd>
</dl>
<dl class="detailList nomargin">
<dl class="detailList params">
<dt class="heading">Deprecated:</dt>
<dt>
since 1.24
</dt>
</dl>
<dl class="detailList params">
<dt class="heading">See:</dt>
<dd><a href="_global_.html#event:webrtc_message_received">{Event} webrtc_message_received</a><br>
<a href="_global_.html#event:webrtc_event_received">{Event} webrtc_event_received</a><br>
<a href="hcap.webrtc.html#.startPreviewVideo">hcap.webrtc.startPreviewVideo()</a><br>
<a href="hcap.webrtc.html#.stopPreviewVideo">hcap.webrtc.stopPreviewVideo()</a><br>
<a href="hcap.webrtc.html#.incomingCall">hcap.webrtc.incomingCall()</a><br>
<a href="hcap.webrtc.html#.outgoingCall">hcap.webrtc.outgoingCall()</a><br>
<a href="hcap.webrtc.html#.endCall">hcap.webrtc.endCall()</a><br>
<a href="hcap.webrtc.html#.acceptMessage">hcap.webrtc.acceptMessage()</a><br>
<a href="hcap.webrtc.html#.startCheckAudio">hcap.webrtc.startCheckAudio()</a><br>
<a href="hcap.webrtc.html#.setConfiguration">hcap.webrtc.setConfiguration()</a><br>
<a href="hcap.webrtc.html#.getConfiguration">hcap.webrtc.getConfiguration()</a><br>
<a href="hcap.webrtc.html#.showDiagnostics">hcap.webrtc.showDiagnostics()</a><br></dd>
</dl>
</dl>
<div class="hr"></div>
</li>
<li
class='item10'
>
<div class="fixedFont heading" id=".stopPreviewVideo">
<span class='lighter'>
&lt;static&gt;
</span>
<span class="light">hcap.webrtc.</span><b>stopPreviewVideo</b>(param)
</div>
<div class="description">
Stops playing local video.<br>
</div>
<pre class="code prettyprint">hcap.webrtc.stopPreviewVideo({
"onSuccess" : function() {
console.log("onSuccess");
},
"onFailure" : function(f) {
console.log("onFailure : errorMessage = " + f.errorMessage);
}
});</pre>
<dl class="detailList params">
<dt class="heading">Parameters:</dt>
<dt>
<span class="light fixedFont">{Object}</span> <b>param</b>
</dt>
<dd><ul>
<li>{Function} param.onSuccess [Optional] - success callback function.
<pre class="code prettyprint">
param.onSuccess = function() {
// No Parameter.
}</pre>
</li>
<li>{Function} param.onFailure [Optional] - failure callback function.
<pre class="code prettyprint">
param.onFailure = function (param) {
// {String} param.errorMessage - in case of failure, this message provides the details.
}</pre>
</li>
</ul></dd>
</dl>
<dl class="detailList nomargin">
<dl class="detailList params">
<dt class="heading">Deprecated:</dt>
<dt>
since 1.24
</dt>
</dl>
<dl class="detailList params">
<dt class="heading">See:</dt>
<dd><a href="_global_.html#event:webrtc_message_received">{Event} webrtc_message_received</a><br>
<a href="_global_.html#event:webrtc_event_received">{Event} webrtc_event_received</a><br>
<a href="hcap.webrtc.html#.startPreviewVideo">hcap.webrtc.startPreviewVideo()</a><br>
<a href="hcap.webrtc.html#.incomingCall">hcap.webrtc.incomingCall()</a><br>
<a href="hcap.webrtc.html#.outgoingCall">hcap.webrtc.outgoingCall()</a><br>
<a href="hcap.webrtc.html#.endCall">hcap.webrtc.endCall()</a><br>
<a href="hcap.webrtc.html#.acceptMessage">hcap.webrtc.acceptMessage()</a><br>
<a href="hcap.webrtc.html#.startCheckAudio">hcap.webrtc.startCheckAudio()</a><br>
<a href="hcap.webrtc.html#.stopCheckAudio">hcap.webrtc.stopCheckAudio()</a><br>
<a href="hcap.webrtc.html#.setConfiguration">hcap.webrtc.setConfiguration()</a><br>
<a href="hcap.webrtc.html#.getConfiguration">hcap.webrtc.getConfiguration()</a><br>
<a href="hcap.webrtc.html#.showDiagnostics">hcap.webrtc.showDiagnostics()</a><br></dd>
</dl>
</dl>
</li>
</ul>
</div>
</div>
</section>
<!--
#### EVENT DETAILS
-->
</article>
</div>
</div>
<script type="text/javascript">
wbos.CssTools.MediaQueryFallBack.LoadCss('../css/screen.css', '../css/handheld.css', 660)
codeview.classFilter.Init()
</script>
<script src="../javascript/highlighter/prettify.js"></script>
<script>prettyPrint();</script>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink