Skip to content

Commit 91d6f4b

Browse files
jeffswartzjeffswartz
committed
Docs edits.
1 parent 4218d6d commit 91d6f4b

32 files changed

+139
-123
lines changed

‎docs/allclasses-frame.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,8 @@
22
<!-- NewPage -->
33
<html lang="en">
44
<head>
5-
<!-- Generated by javadoc (version 1.7.0_40) on Mon May 19 16:30:33 PDT 2014 -->
6-
<title>All Classes (OpenTok 2.2 Java SDK)</title>
5+
<!-- Generated by javadoc (version 1.7.0_40) on Mon May 19 17:34:31 PDT 2014 -->
6+
<title>All Classes (OpenTok Java SDK)</title>
77
<meta name="date" content="2014-05-19">
88
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
99
</head>

‎docs/allclasses-noframe.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,8 @@
22
<!-- NewPage -->
33
<html lang="en">
44
<head>
5-
<!-- Generated by javadoc (version 1.7.0_40) on Mon May 19 16:30:33 PDT 2014 -->
6-
<title>All Classes (OpenTok 2.2 Java SDK)</title>
5+
<!-- Generated by javadoc (version 1.7.0_40) on Mon May 19 17:34:31 PDT 2014 -->
6+
<title>All Classes (OpenTok Java SDK)</title>
77
<meta name="date" content="2014-05-19">
88
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
99
</head>

‎docs/com/opentok/Archive.Status.html

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,15 +2,15 @@
22
<!-- NewPage -->
33
<html lang="en">
44
<head>
5-
<!-- Generated by javadoc (version 1.7.0_40) on Mon May 19 16:30:33 PDT 2014 -->
6-
<title>Archive.Status (OpenTok 2.2 Java SDK)</title>
5+
<!-- Generated by javadoc (version 1.7.0_40) on Mon May 19 17:34:31 PDT 2014 -->
6+
<title>Archive.Status (OpenTok Java SDK)</title>
77
<meta name="date" content="2014-05-19">
88
<link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style">
99
</head>
1010
<body>
1111
<script type="text/javascript"><!--
1212
if (location.href.indexOf('is-external=true') == -1) {
13-
parent.document.title="Archive.Status (OpenTok 2.2 Java SDK)";
13+
parent.document.title="Archive.Status (OpenTok Java SDK)";
1414
}
1515
//-->
1616
</script>

‎docs/com/opentok/Archive.html

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,15 +2,15 @@
22
<!-- NewPage -->
33
<html lang="en">
44
<head>
5-
<!-- Generated by javadoc (version 1.7.0_40) on Mon May 19 16:30:33 PDT 2014 -->
6-
<title>Archive (OpenTok 2.2 Java SDK)</title>
5+
<!-- Generated by javadoc (version 1.7.0_40) on Mon May 19 17:34:30 PDT 2014 -->
6+
<title>Archive (OpenTok Java SDK)</title>
77
<meta name="date" content="2014-05-19">
88
<link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style">
99
</head>
1010
<body>
1111
<script type="text/javascript"><!--
1212
if (location.href.indexOf('is-external=true') == -1) {
13-
parent.document.title="Archive (OpenTok 2.2 Java SDK)";
13+
parent.document.title="Archive (OpenTok Java SDK)";
1414
}
1515
//-->
1616
</script>

‎docs/com/opentok/MediaMode.html

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,15 +2,15 @@
22
<!-- NewPage -->
33
<html lang="en">
44
<head>
5-
<!-- Generated by javadoc (version 1.7.0_40) on Mon May 19 16:30:33 PDT 2014 -->
6-
<title>MediaMode (OpenTok 2.2 Java SDK)</title>
5+
<!-- Generated by javadoc (version 1.7.0_40) on Mon May 19 17:34:31 PDT 2014 -->
6+
<title>MediaMode (OpenTok Java SDK)</title>
77
<meta name="date" content="2014-05-19">
88
<link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style">
99
</head>
1010
<body>
1111
<script type="text/javascript"><!--
1212
if (location.href.indexOf('is-external=true') == -1) {
13-
parent.document.title="MediaMode (OpenTok 2.2 Java SDK)";
13+
parent.document.title="MediaMode (OpenTok Java SDK)";
1414
}
1515
//-->
1616
</script>
@@ -107,7 +107,7 @@ <h2 title="Enum MediaMode" class="title">Enum MediaMode</h2>
107107
<pre>public enum <span class="strong">MediaMode</span>
108108
extends java.lang.Enum&lt;<a href="../../com/opentok/MediaMode.html" title="enum in com.opentok">MediaMode</a>&gt;</pre>
109109
<div class="block">Defines values for the mediaMode parameter of the
110-
<code>SessionProperties.Builder#role(MediaMode mediaMode)</code> method.</div>
110+
<a href="../../com/opentok/SessionProperties.Builder.html#mediaMode(com.opentok.MediaMode)"><code>SessionProperties.Builder.mediaMode(MediaMode mediaMode)</code></a> method.</div>
111111
</li>
112112
</ul>
113113
</div>

‎docs/com/opentok/OpenTok.html

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,15 +2,15 @@
22
<!-- NewPage -->
33
<html lang="en">
44
<head>
5-
<!-- Generated by javadoc (version 1.7.0_40) on Mon May 19 16:30:33 PDT 2014 -->
6-
<title>OpenTok (OpenTok 2.2 Java SDK)</title>
5+
<!-- Generated by javadoc (version 1.7.0_40) on Mon May 19 17:34:31 PDT 2014 -->
6+
<title>OpenTok (OpenTok Java SDK)</title>
77
<meta name="date" content="2014-05-19">
88
<link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style">
99
</head>
1010
<body>
1111
<script type="text/javascript"><!--
1212
if (location.href.indexOf('is-external=true') == -1) {
13-
parent.document.title="OpenTok (OpenTok 2.2 Java SDK)";
13+
parent.document.title="OpenTok (OpenTok Java SDK)";
1414
}
1515
//-->
1616
</script>

‎docs/com/opentok/Role.html

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,15 +2,15 @@
22
<!-- NewPage -->
33
<html lang="en">
44
<head>
5-
<!-- Generated by javadoc (version 1.7.0_40) on Mon May 19 16:30:33 PDT 2014 -->
6-
<title>Role (OpenTok 2.2 Java SDK)</title>
5+
<!-- Generated by javadoc (version 1.7.0_40) on Mon May 19 17:34:31 PDT 2014 -->
6+
<title>Role (OpenTok Java SDK)</title>
77
<meta name="date" content="2014-05-19">
88
<link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style">
99
</head>
1010
<body>
1111
<script type="text/javascript"><!--
1212
if (location.href.indexOf('is-external=true') == -1) {
13-
parent.document.title="Role (OpenTok 2.2 Java SDK)";
13+
parent.document.title="Role (OpenTok Java SDK)";
1414
}
1515
//-->
1616
</script>

‎docs/com/opentok/Session.html

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,15 +2,15 @@
22
<!-- NewPage -->
33
<html lang="en">
44
<head>
5-
<!-- Generated by javadoc (version 1.7.0_40) on Mon May 19 16:30:33 PDT 2014 -->
6-
<title>Session (OpenTok 2.2 Java SDK)</title>
5+
<!-- Generated by javadoc (version 1.7.0_40) on Mon May 19 17:34:31 PDT 2014 -->
6+
<title>Session (OpenTok Java SDK)</title>
77
<meta name="date" content="2014-05-19">
88
<link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style">
99
</head>
1010
<body>
1111
<script type="text/javascript"><!--
1212
if (location.href.indexOf('is-external=true') == -1) {
13-
parent.document.title="Session (OpenTok 2.2 Java SDK)";
13+
parent.document.title="Session (OpenTok Java SDK)";
1414
}
1515
//-->
1616
</script>

‎docs/com/opentok/SessionProperties.Builder.html

Lines changed: 28 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -2,15 +2,15 @@
22
<!-- NewPage -->
33
<html lang="en">
44
<head>
5-
<!-- Generated by javadoc (version 1.7.0_40) on Mon May 19 16:30:33 PDT 2014 -->
6-
<title>SessionProperties.Builder (OpenTok 2.2 Java SDK)</title>
5+
<!-- Generated by javadoc (version 1.7.0_40) on Mon May 19 17:34:31 PDT 2014 -->
6+
<title>SessionProperties.Builder (OpenTok Java SDK)</title>
77
<meta name="date" content="2014-05-19">
88
<link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style">
99
</head>
1010
<body>
1111
<script type="text/javascript"><!--
1212
if (location.href.indexOf('is-external=true') == -1) {
13-
parent.document.title="SessionProperties.Builder (OpenTok 2.2 Java SDK)";
13+
parent.document.title="SessionProperties.Builder (OpenTok Java SDK)";
1414
}
1515
//-->
1616
</script>
@@ -154,7 +154,7 @@ <h3>Method Summary</h3>
154154
<tr class="altColor">
155155
<td class="colFirst"><code><a href="../../com/opentok/SessionProperties.Builder.html" title="class in com.opentok">SessionProperties.Builder</a></code></td>
156156
<td class="colLast"><code><strong><a href="../../com/opentok/SessionProperties.Builder.html#mediaMode(com.opentok.MediaMode)">mediaMode</a></strong>(<a href="../../com/opentok/MediaMode.html" title="enum in com.opentok">MediaMode</a>&nbsp;mediaMode)</code>
157-
<div class="block">Call this method to determine whether the session will transmit streams between using the
157+
<div class="block">Call this method to determine whether the session will transmit streams using the
158158
OpenTok Media Router (MediaMode.ROUTED) or not (MediaMode.RELAYED).</div>
159159
</td>
160160
</tr>
@@ -221,28 +221,36 @@ <h4>location</h4>
221221
<li class="blockList">
222222
<h4>mediaMode</h4>
223223
<pre>public&nbsp;<a href="../../com/opentok/SessionProperties.Builder.html" title="class in com.opentok">SessionProperties.Builder</a>&nbsp;mediaMode(<a href="../../com/opentok/MediaMode.html" title="enum in com.opentok">MediaMode</a>&nbsp;mediaMode)</pre>
224-
<div class="block">Call this method to determine whether the session will transmit streams between using the
224+
<div class="block">Call this method to determine whether the session will transmit streams using the
225225
OpenTok Media Router (MediaMode.ROUTED) or not (MediaMode.RELAYED). By default, sessions
226-
use the OpenTok Media Router (false). If a session does not use the OpenTok Media Router,
227-
clients will attempt to transmit streams directly to each other. If two clients cannot send
228-
and receive each others' streams, due to firewalls on the clients' networks, their
229-
streams will be relayed using the OpenTok TURN Server.
226+
use the OpenTok Media Router.
230227
<p>
231-
The <a href="http://www.tokbox.com/blog/mantis-next-generation-cloud-technology-for-webrtc/">
232-
OpenTok Media Router</a> provides a number of benefits. For example, the OpenTok Media
233-
Router can decrease bandwidth usage in multiparty sessions. Also, the OpenTok Media Router
234-
can improve the quality of the user experience through
235-
<a href="http://www.tokbox.com/blog/quality-of-experience-and-traffic-shaping-the-next-step-with-mantis/">dynamic
236-
traffic shaping</a>.
228+
The <a href="http://tokbox.com/#multiparty" target="_top"> OpenTok Media Router</a>
229+
provides the following benefits:
230+
231+
<ul>
232+
<li>The OpenTok Media Router can decrease bandwidth usage in multiparty sessions.
233+
(When the <code>mediaMode</code> property is set to <code>MediaMode.ROUTED</code>,
234+
each client must send a separate audio-video stream to each client subscribing to
235+
it.)</li>
236+
<li>The OpenTok Media Router can improve the quality of the user experience through
237+
<a href="http://tokbox.com/#iqc" target="_top">Intellegent Quality Control</a>. With
238+
Intellegent Quality Control, if a client's connectivity degrades to a degree that
239+
it does not support video for a stream it's subscribing to, the video is dropped on
240+
that client (without affecting other clients), and the client receives audio only.
241+
If the client's connectivity improves, the video returns.</li>
242+
</ul>
243+
237244
<p>
238-
With the mediaMode set to MediaMode.RELAYED, the session will attempt to transmit streams
239-
directly between clients. If clients cannot connect due to firewall restrictions, the
240-
session uses the OpenTok TURN server to relay audio-video streams.
245+
With the <code>mediaMode</code> property set to <code>MediaMode.ROUTED</code>, the session
246+
will attempt to transmit streams directly between clients. If clients cannot connect due to
247+
firewall restrictions,the session uses the OpenTok TURN server to relay audio-video
248+
streams.
241249
<p>
242250
You will be billed for streamed minutes if you use the OpenTok Media Router or if the
243251
session uses the OpenTok TURN server to relay streams. For information on pricing, see the
244-
<a href="http://www.tokbox.com/pricing">OpenTok pricing page</a>.</div>
245-
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>mediaMode</code> - Set to a value defined in the MediaMode enum.</dd>
252+
<a href="http://www.tokbox.com/pricing" target="_top">OpenTok pricing page</a>.</div>
253+
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>mediaMode</code> - Set to a value defined in the <a href="../../com/opentok/MediaMode.html" title="enum in com.opentok"><code>MediaMode</code></a> enum.</dd>
246254
<dt><span class="strong">Returns:</span></dt><dd>The SessionProperties.Builder object with the peer-to-peer setting.</dd></dl>
247255
</li>
248256
</ul>

‎docs/com/opentok/SessionProperties.html

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,15 +2,15 @@
22
<!-- NewPage -->
33
<html lang="en">
44
<head>
5-
<!-- Generated by javadoc (version 1.7.0_40) on Mon May 19 16:30:33 PDT 2014 -->
6-
<title>SessionProperties (OpenTok 2.2 Java SDK)</title>
5+
<!-- Generated by javadoc (version 1.7.0_40) on Mon May 19 17:34:31 PDT 2014 -->
6+
<title>SessionProperties (OpenTok Java SDK)</title>
77
<meta name="date" content="2014-05-19">
88
<link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style">
99
</head>
1010
<body>
1111
<script type="text/javascript"><!--
1212
if (location.href.indexOf('is-external=true') == -1) {
13-
parent.document.title="SessionProperties (OpenTok 2.2 Java SDK)";
13+
parent.document.title="SessionProperties (OpenTok Java SDK)";
1414
}
1515
//-->
1616
</script>

0 commit comments

Comments
 (0)