Skip to content

Commit 71ad0ce

Browse files
jeffswartzjeffswartz
committed
Documentation edits.
1 parent 27b425d commit 71ad0ce

34 files changed

+173
-174
lines changed

‎README.md

Lines changed: 6 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,7 @@ The OpenTok Java SDK lets you generate
88
applications that run on the JVM. This version of the SDK also includes support for working with OpenTok
99
2.0 archives.
1010

11-
# Installation
12-
13-
## Maven Central (recommended):
11+
# Installation using Maven Central (recommended):
1412

1513
The [Maven Central](http://central.sonatype.org/) repository helps manage dependencies for JVM
1614
based projects. It can be used via several build tools, including Maven and Gradle.
@@ -37,14 +35,6 @@ dependencies {
3735
}
3836
```
3937

40-
## Manually:
41-
42-
Download the zip file for the latest release from the
43-
[Releases](https://github.com/opentok/opentok-java-sdk/releases) page. This zip contains a jars for
44-
the OpenTok Java SDK and its dependencies. Include these in the classpath for your own project by
45-
[using the JDK directly](http://docs.oracle.com/javase/7/docs/technotes/tools/windows/classpath.html)
46-
or in your IDE of choice.
47-
4838
# Usage
4939

5040
## Initializing
@@ -72,7 +62,7 @@ method. The `properties` parameter is optional and it is used to specify two thi
7262
An instance can be initialized using the `com.opentok.SessionProperties.Builder` class.
7363
The `sessionId` property of the returned `com.opentok.Session` instance, which you can read using
7464
the `getSessionId()` method, is useful to get a sessionId that can be saved to a persistent store
75-
(e.g. database).
65+
(such as a database).
7666

7767
```java
7868
import com.opentok.Session;
@@ -106,7 +96,7 @@ instance can be initialized using the `TokenOptions.Builder` class.
10696

10797
```java
10898
import com.opentok.TokenOptions;
109-
import com.opentok.Roles;
99+
import com.opentok.Role;
110100

111101
// Generate a token from just a sessionId (fetched from a database)
112102
String token = opentok.generateToken(sessionId);
@@ -115,8 +105,8 @@ String token = session.generateToken();
115105

116106
// Set some options in a token
117107
String token = session.generateToken(new TokenOptions.Builder()
118-
.role(Roles.MODERATOR)
119-
.expireTime((System.currentTimeMillis() / 1000L) + (7 * 24 * 60 * 60)) // in one week
108+
.role(Role.MODERATOR)
109+
.expireTime((System.currentTimeMillis() / 1000) + (7 * 24 * 60 * 60)) // in one week
120110
.data("name=Johnny")
121111
.build());
122112
```
@@ -197,12 +187,8 @@ You need an OpenTok API key and API secret, which you can obtain at <https://das
197187
The OpenTok Java SDK requires JDK 6 or greater to compile. Runtime requires Java SE 6 or greater.
198188
This project is tested on both OpenJDK and Oracle implementations.
199189

200-
# Release Notes
201-
202-
See the [Releases](https://github.com/opentok/opentok-java-sdk/releases) page for details
203-
about each release.
204190

205-
## Important changes in v2.2
191+
# Important changes in v2.2
206192

207193
This version of the SDK includes support for working with OpenTok 2.0 archives. (This API does not
208194
work with OpenTok 1.0 archives.)

‎docs/allclasses-frame.html

Lines changed: 3 additions & 3 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 Tue May 20 12:24:31 PDT 2014 -->
6-
<title>All Classes (OpenTok Java SDK)</title>
7-
<meta name="date" content="2014-05-20">
5+
<!-- Generated by javadoc (version 1.7.0_40) on Wed May 21 15:38:06 PDT 2014 -->
6+
<title>All Classes (OpenTok Java SDK Reference)</title>
7+
<meta name="date" content="2014-05-21">
88
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
99
</head>
1010
<body>

‎docs/allclasses-noframe.html

Lines changed: 3 additions & 3 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 Tue May 20 12:24:31 PDT 2014 -->
6-
<title>All Classes (OpenTok Java SDK)</title>
7-
<meta name="date" content="2014-05-20">
5+
<!-- Generated by javadoc (version 1.7.0_40) on Wed May 21 15:38:06 PDT 2014 -->
6+
<title>All Classes (OpenTok Java SDK Reference)</title>
7+
<meta name="date" content="2014-05-21">
88
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
99
</head>
1010
<body>

‎docs/com/opentok/Archive.Status.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 Tue May 20 12:24:31 PDT 2014 -->
6-
<title>Archive.Status (OpenTok Java SDK)</title>
7-
<meta name="date" content="2014-05-20">
5+
<!-- Generated by javadoc (version 1.7.0_40) on Wed May 21 15:38:05 PDT 2014 -->
6+
<title>Archive.Status (OpenTok Java SDK Reference)</title>
7+
<meta name="date" content="2014-05-21">
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 Java SDK)";
13+
parent.document.title="Archive.Status (OpenTok Java SDK Reference)";
1414
}
1515
//-->
1616
</script>

‎docs/com/opentok/Archive.html

Lines changed: 18 additions & 15 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 Tue May 20 12:24:31 PDT 2014 -->
6-
<title>Archive (OpenTok Java SDK)</title>
7-
<meta name="date" content="2014-05-20">
5+
<!-- Generated by javadoc (version 1.7.0_40) on Wed May 21 15:38:05 PDT 2014 -->
6+
<title>Archive (OpenTok Java SDK Reference)</title>
7+
<meta name="date" content="2014-05-21">
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 Java SDK)";
13+
parent.document.title="Archive (OpenTok Java SDK Reference)";
1414
}
1515
//-->
1616
</script>
@@ -140,7 +140,7 @@ <h3>Method Summary</h3>
140140
<tr class="altColor">
141141
<td class="colFirst"><code>long</code></td>
142142
<td class="colLast"><code><strong><a href="../../com/opentok/Archive.html#getCreatedAt()">getCreatedAt</a></strong>()</code>
143-
<div class="block">The time at which the archive was created, in milliseconds since the UNIX epoch.</div>
143+
<div class="block">The time at which the archive was created, in milliseconds since the Unix epoch.</div>
144144
</td>
145145
</tr>
146146
<tr class="rowColor">
@@ -170,8 +170,8 @@ <h3>Method Summary</h3>
170170
<tr class="rowColor">
171171
<td class="colFirst"><code>java.lang.String</code></td>
172172
<td class="colLast"><code><strong><a href="../../com/opentok/Archive.html#getReason()">getReason</a></strong>()</code>
173-
<div class="block">For archives with the status "STOPPED", this can be set to "90 mins exceeded", "failure", "session ended",
174-
or "user initiated".</div>
173+
<div class="block">For archives with the status of Status.STOPPED, this can be set to "90 mins exceeded",
174+
"failure", "session ended", or "user initiated".</div>
175175
</td>
176176
</tr>
177177
<tr class="altColor">
@@ -195,7 +195,7 @@ <h3>Method Summary</h3>
195195
<tr class="rowColor">
196196
<td class="colFirst"><code>java.lang.String</code></td>
197197
<td class="colLast"><code><strong><a href="../../com/opentok/Archive.html#getUrl()">getUrl</a></strong>()</code>
198-
<div class="block">The download URL of the AVAILABLE MP4 file.</div>
198+
<div class="block">The download URL of the available MP4 file.</div>
199199
</td>
200200
</tr>
201201
<tr class="altColor">
@@ -244,7 +244,7 @@ <h4>makeArchive</h4>
244244
<li class="blockList">
245245
<h4>getCreatedAt</h4>
246246
<pre>public&nbsp;long&nbsp;getCreatedAt()</pre>
247-
<div class="block">The time at which the archive was created, in milliseconds since the UNIX epoch.</div>
247+
<div class="block">The time at which the archive was created, in milliseconds since the Unix epoch.</div>
248248
</li>
249249
</ul>
250250
<a name="getDuration()">
@@ -294,8 +294,9 @@ <h4>getPartnerId</h4>
294294
<li class="blockList">
295295
<h4>getReason</h4>
296296
<pre>public&nbsp;java.lang.String&nbsp;getReason()</pre>
297-
<div class="block">For archives with the status "STOPPED", this can be set to "90 mins exceeded", "failure", "session ended",
298-
or "user initiated". For archives with the status "FAILED", this can be set to "system failure".</div>
297+
<div class="block">For archives with the status of Status.STOPPED, this can be set to "90 mins exceeded",
298+
"failure", "session ended", or "user initiated". For archives with the status of
299+
Status.FAILED, this can be set to "system failure".</div>
299300
</li>
300301
</ul>
301302
<a name="getSessionId()">
@@ -335,10 +336,12 @@ <h4>getStatus</h4>
335336
<li class="blockList">
336337
<h4>getUrl</h4>
337338
<pre>public&nbsp;java.lang.String&nbsp;getUrl()</pre>
338-
<div class="block">The download URL of the AVAILABLE MP4 file. This is only set for an archive with the status set to "AVAILABLE";
339-
for other archives, (including archives wit the status "UPLOADED") this method returns null. The download URL is
340-
obfuscated, and the file is only AVAILABLE from the URL for 10 minutes. To generate a new URL, call
341-
the <a href="../../com/opentok/OpenTok.html#listArchives()"><code>OpenTok.listArchives()</code></a> or <a href="../../com/opentok/OpenTok.html#getArchive(java.lang.String)"><code>OpenTok.getArchive(String)</code></a> method.</div>
339+
<div class="block">The download URL of the available MP4 file. This is only set for an archive with the status
340+
set to Status.AVAILABLE; for other archives, (including archives with the status of
341+
Status.UPLOADED) this method returns null. The download URL is obfuscated, and the file
342+
is only available from the URL for 10 minutes. To generate a new URL, call the
343+
<a href="../../com/opentok/OpenTok.html#listArchives()"><code>OpenTok.listArchives()</code></a> or <a href="../../com/opentok/OpenTok.html#getArchive(java.lang.String)"><code>OpenTok.getArchive(String)</code></a>
344+
method.</div>
342345
</li>
343346
</ul>
344347
<a name="toString()">

‎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 Tue May 20 12:24:31 PDT 2014 -->
6-
<title>MediaMode (OpenTok Java SDK)</title>
7-
<meta name="date" content="2014-05-20">
5+
<!-- Generated by javadoc (version 1.7.0_40) on Wed May 21 15:38:06 PDT 2014 -->
6+
<title>MediaMode (OpenTok Java SDK Reference)</title>
7+
<meta name="date" content="2014-05-21">
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 Java SDK)";
13+
parent.document.title="MediaMode (OpenTok Java SDK Reference)";
1414
}
1515
//-->
1616
</script>

‎docs/com/opentok/OpenTok.html

Lines changed: 16 additions & 13 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 Tue May 20 12:24:31 PDT 2014 -->
6-
<title>OpenTok (OpenTok Java SDK)</title>
7-
<meta name="date" content="2014-05-20">
5+
<!-- Generated by javadoc (version 1.7.0_40) on Wed May 21 15:38:06 PDT 2014 -->
6+
<title>OpenTok (OpenTok Java SDK Reference)</title>
7+
<meta name="date" content="2014-05-21">
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 Java SDK)";
13+
parent.document.title="OpenTok (OpenTok Java SDK Reference)";
1414
}
1515
//-->
1616
</script>
@@ -160,8 +160,7 @@ <h3>Method Summary</h3>
160160
<tr class="rowColor">
161161
<td class="colFirst"><code><a href="../../com/opentok/Session.html" title="class in com.opentok">Session</a></code></td>
162162
<td class="colLast"><code><strong><a href="../../com/opentok/OpenTok.html#createSession(com.opentok.SessionProperties)">createSession</a></strong>(<a href="../../com/opentok/SessionProperties.html" title="class in com.opentok">SessionProperties</a>&nbsp;properties)</code>
163-
<div class="block">Creates a new OpenTok session and returns the session ID, which uniquely identifies
164-
the session.</div>
163+
<div class="block">Creates a new OpenTok session.</div>
165164
</td>
166165
</tr>
167166
<tr class="altColor">
@@ -250,7 +249,7 @@ <h4>OpenTok</h4>
250249
<div class="block">Creates an OpenTok object.</div>
251250
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>apiKey</code> - Your OpenTok API key. (See the <a href="https://dashboard.tokbox.com">OpenTok
252251
dashboard</a> page.)</dd><dd><code>apiSecret</code> - Your OpenTok API secret. (See the <a href="https://dashboard.tokbox.com">OpenTok dashboard</a>
253-
page)</dd></dl>
252+
page.)</dd></dl>
254253
</li>
255254
</ul>
256255
<a name="OpenTok(int, java.lang.String, java.lang.String)">
@@ -380,8 +379,7 @@ <h4>generateToken</h4>
380379
<h4>createSession</h4>
381380
<pre>public&nbsp;<a href="../../com/opentok/Session.html" title="class in com.opentok">Session</a>&nbsp;createSession(<a href="../../com/opentok/SessionProperties.html" title="class in com.opentok">SessionProperties</a>&nbsp;properties)
382381
throws <a href="../../com/opentok/exception/OpenTokException.html" title="class in com.opentok.exception">OpenTokException</a></pre>
383-
<div class="block">Creates a new OpenTok session and returns the session ID, which uniquely identifies
384-
the session.
382+
<div class="block">Creates a new OpenTok session.
385383
<p>
386384
For example, when using the OpenTok.js library, use the session ID when calling the
387385
<a href="http://tokbox.com/opentok/libraries/client/js/reference/OT.html#initSession">
@@ -396,7 +394,8 @@ <h4>createSession</h4>
396394
Calling this method results in an <a href="../../com/opentok/exception/OpenTokException.html" title="class in com.opentok.exception"><code>OpenTokException</code></a> in
397395
the event of an error. Check the error message for details.
398396
<p>
399-
The following code creates a peer-to-peer session:
397+
The following code creates a session that attempts to send streams directly between clients
398+
(falling back to use the OpenTok TURN server to relay streams if the clients cannot connect):
400399

401400
<pre>
402401
import com.opentok.MediaMode;
@@ -430,8 +429,9 @@ <h4>createSession</h4>
430429

431430
<li>A location hint for the location of the OpenTok server to use for the session.</li>
432431
</ul></dd>
433-
<dt><span class="strong">Returns:</span></dt><dd>A session ID for the new session. For example, when using the OpenTok.js library, use
434-
this session ID when calling the <code>OT.initSession()</code> method.</dd>
432+
<dt><span class="strong">Returns:</span></dt><dd>A Session object representing the new session. Call the <code>getSessionId()</code>
433+
method of the Session object to get the session ID, which uniquely identifies the
434+
session. You will use this session ID in the client SDKs to identify the session.</dd>
435435
<dt><span class="strong">Throws:</span></dt>
436436
<dd><code><a href="../../com/opentok/exception/OpenTokException.html" title="class in com.opentok.exception">OpenTokException</a></code></dd></dl>
437437
</li>
@@ -470,7 +470,10 @@ <h4>createSession</h4>
470470
}
471471
}
472472
</pre></div>
473-
<dl><dt><span class="strong">Throws:</span></dt>
473+
<dl><dt><span class="strong">Returns:</span></dt><dd>A Session object representing the new session. Call the <code>getSessionId()</code>
474+
method of the Session object to get the session ID, which uniquely identifies the
475+
session. You will use this session ID in the client SDKs to identify the session.</dd>
476+
<dt><span class="strong">Throws:</span></dt>
474477
<dd><code><a href="../../com/opentok/exception/OpenTokException.html" title="class in com.opentok.exception">OpenTokException</a></code></dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../com/opentok/OpenTok.html#createSession(com.opentok.SessionProperties)"><code>createSession(SessionProperties)</code></a></dd></dl>
475478
</li>
476479
</ul>

‎docs/com/opentok/Role.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 Tue May 20 12:24:31 PDT 2014 -->
6-
<title>Role (OpenTok Java SDK)</title>
7-
<meta name="date" content="2014-05-20">
5+
<!-- Generated by javadoc (version 1.7.0_40) on Wed May 21 15:38:06 PDT 2014 -->
6+
<title>Role (OpenTok Java SDK Reference)</title>
7+
<meta name="date" content="2014-05-21">
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 Java SDK)";
13+
parent.document.title="Role (OpenTok Java SDK Reference)";
1414
}
1515
//-->
1616
</script>

‎docs/com/opentok/Session.html

Lines changed: 5 additions & 5 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 Tue May 20 12:24:31 PDT 2014 -->
6-
<title>Session (OpenTok Java SDK)</title>
7-
<meta name="date" content="2014-05-20">
5+
<!-- Generated by javadoc (version 1.7.0_40) on Wed May 21 15:38:06 PDT 2014 -->
6+
<title>Session (OpenTok Java SDK Reference)</title>
7+
<meta name="date" content="2014-05-21">
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 Java SDK)";
13+
parent.document.title="Session (OpenTok Java SDK Reference)";
1414
}
1515
//-->
1616
</script>
@@ -98,7 +98,7 @@ <h2 title="Class Session" class="title">Class Session</h2>
9898
<pre>public class <span class="strong">Session</span>
9999
extends java.lang.Object</pre>
100100
<div class="block">Represents an OpenTok session. Use the <a href="../../com/opentok/OpenTok.html#createSession(com.opentok.SessionProperties)"><code>OpenTok.createSession(SessionProperties properties)</code></a>
101-
method to create an OpenTok session. Use the <a href="../../com/opentok/Session.html#getSessionId()"><code>getSessionId()</code></a> method of the session object
101+
method to create an OpenTok session. Use the <a href="../../com/opentok/Session.html#getSessionId()"><code>getSessionId()</code></a> method of the Session object
102102
to get the session ID.</div>
103103
</li>
104104
</ul>

‎docs/com/opentok/SessionProperties.Builder.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 Tue May 20 12:24:31 PDT 2014 -->
6-
<title>SessionProperties.Builder (OpenTok Java SDK)</title>
7-
<meta name="date" content="2014-05-20">
5+
<!-- Generated by javadoc (version 1.7.0_40) on Wed May 21 15:38:06 PDT 2014 -->
6+
<title>SessionProperties.Builder (OpenTok Java SDK Reference)</title>
7+
<meta name="date" content="2014-05-21">
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 Java SDK)";
13+
parent.document.title="SessionProperties.Builder (OpenTok Java SDK Reference)";
1414
}
1515
//-->
1616
</script>

0 commit comments

Comments
 (0)