Skip to content

Commit 6fc5d63

Browse files
aoberoiaoberoi
committed
Merge branch 'aoberoi-issue-40'
2 parents f1b5e8d + c42ad4e commit 6fc5d63

35 files changed

+119
-109
lines changed

‎README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -82,20 +82,20 @@ the `getSessionId()` method, is useful to get an identifier that can be saved to
8282
import com.opentok.Session;
8383
import com.opentok.SessionProperties;
8484

85-
// Just a plain Session
85+
// A session that attempts to stream media directly between clients:
8686
Session session = opentok.createSession();
8787

88-
// A session that attempts to use peer-to-peer streaming
88+
// A session that uses the OpenTok Media Router:
8989
Session session = opentok.createSession(new SessionProperties.Builder()
90-
.mediaMode(MediaMode.RELAYED)
90+
.mediaMode(MediaMode.ROUTED)
9191
.build());
9292

93-
// A Session with a location hint
93+
// A Session with a location hint:
9494
Session session = opentok.createSession(new SessionProperties.Builder()
9595
.location("12.34.56.78")
9696
.build());
9797

98-
// Store this sessionId in the database for later use
98+
// Store this sessionId in the database for later use:
9999
String sessionId = session.getSessionId();
100100
```
101101

‎docs/allclasses-frame.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,9 @@
22
<!-- NewPage -->
33
<html lang="en">
44
<head>
5-
<!-- Generated by javadoc (version 1.7.0_40) on Thu May 22 18:08:42 PDT 2014 -->
5+
<!-- Generated by javadoc (version 1.7.0_40) on Mon Jun 16 22:23:30 PDT 2014 -->
66
<title>All Classes (OpenTok Java SDK Reference)</title>
7-
<meta name="date" content="2014-05-22">
7+
<meta name="date" content="2014-06-16">
88
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
99
</head>
1010
<body>

‎docs/allclasses-noframe.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,9 @@
22
<!-- NewPage -->
33
<html lang="en">
44
<head>
5-
<!-- Generated by javadoc (version 1.7.0_40) on Thu May 22 18:08:42 PDT 2014 -->
5+
<!-- Generated by javadoc (version 1.7.0_40) on Mon Jun 16 22:23:30 PDT 2014 -->
66
<title>All Classes (OpenTok Java SDK Reference)</title>
7-
<meta name="date" content="2014-05-22">
7+
<meta name="date" content="2014-06-16">
88
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
99
</head>
1010
<body>

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,9 @@
22
<!-- NewPage -->
33
<html lang="en">
44
<head>
5-
<!-- Generated by javadoc (version 1.7.0_40) on Thu May 22 18:08:41 PDT 2014 -->
5+
<!-- Generated by javadoc (version 1.7.0_40) on Mon Jun 16 22:23:29 PDT 2014 -->
66
<title>Archive.Status (OpenTok Java SDK Reference)</title>
7-
<meta name="date" content="2014-05-22">
7+
<meta name="date" content="2014-06-16">
88
<link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style">
99
</head>
1010
<body>

‎docs/com/opentok/Archive.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,9 @@
22
<!-- NewPage -->
33
<html lang="en">
44
<head>
5-
<!-- Generated by javadoc (version 1.7.0_40) on Thu May 22 18:08:41 PDT 2014 -->
5+
<!-- Generated by javadoc (version 1.7.0_40) on Mon Jun 16 22:23:29 PDT 2014 -->
66
<title>Archive (OpenTok Java SDK Reference)</title>
7-
<meta name="date" content="2014-05-22">
7+
<meta name="date" content="2014-06-16">
88
<link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style">
99
</head>
1010
<body>

‎docs/com/opentok/MediaMode.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,9 @@
22
<!-- NewPage -->
33
<html lang="en">
44
<head>
5-
<!-- Generated by javadoc (version 1.7.0_40) on Thu May 22 18:08:41 PDT 2014 -->
5+
<!-- Generated by javadoc (version 1.7.0_40) on Mon Jun 16 22:23:29 PDT 2014 -->
66
<title>MediaMode (OpenTok Java SDK Reference)</title>
7-
<meta name="date" content="2014-05-22">
7+
<meta name="date" content="2014-06-16">
88
<link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style">
99
</head>
1010
<body>

‎docs/com/opentok/OpenTok.html

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,9 @@
22
<!-- NewPage -->
33
<html lang="en">
44
<head>
5-
<!-- Generated by javadoc (version 1.7.0_40) on Thu May 22 18:08:41 PDT 2014 -->
5+
<!-- Generated by javadoc (version 1.7.0_40) on Mon Jun 16 22:23:29 PDT 2014 -->
66
<title>OpenTok (OpenTok Java SDK Reference)</title>
7-
<meta name="date" content="2014-05-22">
7+
<meta name="date" content="2014-06-16">
88
<link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style">
99
</head>
1010
<body>
@@ -151,10 +151,7 @@ <h3>Method Summary</h3>
151151
<tr class="altColor">
152152
<td class="colFirst"><code><a href="../../com/opentok/Session.html" title="class in com.opentok">Session</a></code></td>
153153
<td class="colLast"><code><strong><a href="../../com/opentok/OpenTok.html#createSession()">createSession</a></strong>()</code>
154-
<div class="block">Creates an OpenTok session with the default settings:
155-
156-
157-
The session uses the OpenTok media server.</div>
154+
<div class="block">Creates an OpenTok session with the default settings:</div>
158155
</td>
159156
</tr>
160157
<tr class="rowColor">
@@ -446,10 +443,14 @@ <h4>createSession</h4>
446443
throws <a href="../../com/opentok/exception/OpenTokException.html" title="class in com.opentok.exception">OpenTokException</a></pre>
447444
<div class="block">Creates an OpenTok session with the default settings:
448445

446+
<p>
449447
<ul>
450-
<li>The session uses the OpenTok media server.
448+
<li>The media mode is "relayed". The session will attempt to transmit streams
449+
directly between clients. If two clients cannot send and receive each others'
450+
streams, due to firewalls on the clients' networks, their streams will be
451+
relayed using the OpenTok TURN Server.</li>
451452
<li>The session uses the first client connecting to determine the location of the
452-
OpenTok server to use.</li>
453+
OpenTok server to use.</li>
453454
</ul>
454455

455456
<p>

‎docs/com/opentok/Role.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,9 @@
22
<!-- NewPage -->
33
<html lang="en">
44
<head>
5-
<!-- Generated by javadoc (version 1.7.0_40) on Thu May 22 18:08:41 PDT 2014 -->
5+
<!-- Generated by javadoc (version 1.7.0_40) on Mon Jun 16 22:23:29 PDT 2014 -->
66
<title>Role (OpenTok Java SDK Reference)</title>
7-
<meta name="date" content="2014-05-22">
7+
<meta name="date" content="2014-06-16">
88
<link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style">
99
</head>
1010
<body>

‎docs/com/opentok/Session.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,9 @@
22
<!-- NewPage -->
33
<html lang="en">
44
<head>
5-
<!-- Generated by javadoc (version 1.7.0_40) on Thu May 22 18:08:41 PDT 2014 -->
5+
<!-- Generated by javadoc (version 1.7.0_40) on Mon Jun 16 22:23:29 PDT 2014 -->
66
<title>Session (OpenTok Java SDK Reference)</title>
7-
<meta name="date" content="2014-05-22">
7+
<meta name="date" content="2014-06-16">
88
<link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style">
99
</head>
1010
<body>

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

Lines changed: 15 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,9 @@
22
<!-- NewPage -->
33
<html lang="en">
44
<head>
5-
<!-- Generated by javadoc (version 1.7.0_40) on Thu May 22 18:08:42 PDT 2014 -->
5+
<!-- Generated by javadoc (version 1.7.0_40) on Mon Jun 16 22:23:30 PDT 2014 -->
66
<title>SessionProperties.Builder (OpenTok Java SDK Reference)</title>
7-
<meta name="date" content="2014-05-22">
7+
<meta name="date" content="2014-06-16">
88
<link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style">
99
</head>
1010
<body>
@@ -155,7 +155,8 @@ <h3>Method Summary</h3>
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>
157157
<div class="block">Call this method to determine whether the session will transmit streams using the
158-
OpenTok Media Router (MediaMode.ROUTED) or not (MediaMode.RELAYED).</div>
158+
OpenTok Media Router (<code>MediaMode.ROUTED</code>) or not
159+
(<code>MediaMode.RELAYED</code>).</div>
159160
</td>
160161
</tr>
161162
</table>
@@ -222,10 +223,18 @@ <h4>location</h4>
222223
<h4>mediaMode</h4>
223224
<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>
224225
<div class="block">Call this method to determine whether the session will transmit streams using the
225-
OpenTok Media Router (MediaMode.ROUTED) or not (MediaMode.RELAYED). By default, sessions
226-
use the OpenTok Media Router.
226+
OpenTok Media Router (<code>MediaMode.ROUTED</code>) or not
227+
(<code>MediaMode.RELAYED</code>). By default, the <code>mediaMode</code> property
228+
is set to <code>MediaMode.RELAYED</code>.
229+
230+
<p>
231+
With the <code>mediaMode</code> property set to <code>MediaMode.RELAYED</code>, the session
232+
will attempt to transmit streams directly between clients. If clients cannot connect due to
233+
firewall restrictions, the session uses the OpenTok TURN server to relay audio-video
234+
streams.
235+
227236
<p>
228-
The <a href="http://tokbox.com/#multiparty" target="_top"> OpenTok Media Router</a>
237+
The <a href="http://tokbox.com/#multiparty" target="_top">OpenTok Media Router</a>
229238
provides the following benefits:
230239

231240
<ul>
@@ -244,11 +253,6 @@ <h4>mediaMode</h4>
244253
feature, which lets you record, save, and retrieve OpenTok sessions.</li>
245254
</ul>
246255

247-
<p>
248-
With the <code>mediaMode</code> property set to <code>MediaMode.RELAYED</code>, the session
249-
will attempt to transmit streams directly between clients. If clients cannot connect due to
250-
firewall restrictions, the session uses the OpenTok TURN server to relay audio-video
251-
streams.
252256
<p>
253257
You will be billed for streamed minutes if you use the OpenTok Media Router or if the
254258
session uses the OpenTok TURN server to relay streams. For information on pricing, see the

0 commit comments

Comments
 (0)