Skip to content

Commit 90dc591

Browse files
aoberoiaoberoi
committed
Merge branch 'archiving-updates-docs' of https://github.com/jeffswartz/Opentok-Java-SDK into jeffswartz-archiving-updates-docs
2 parents b3d1934 + 7c57726 commit 90dc591

35 files changed

+241
-133
lines changed

‎README.md

Lines changed: 16 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,8 @@
55
The OpenTok Java SDK lets you generate
66
[sessions](http://tokbox.com/opentok/tutorials/create-session/) and
77
[tokens](http://tokbox.com/opentok/tutorials/create-token/) for [OpenTok](http://www.tokbox.com/)
8-
applications that run on the JVM. This version of the SDK also includes support for working
9-
with [OpenTok 2.0 archives](http://tokbox.com/#archiving).
8+
applications that run on the JVM. The SDK also includes support for working with
9+
[OpenTok archives](http://tokbox.com/opentok/tutorials/archiving).
1010

1111
If you are updating from a previous version of this SDK, see
1212
[Important changes since v2.2.0](#important-changes-since-v220).
@@ -143,6 +143,19 @@ Archive archive = opentok.startArchive(sessionId, null);
143143
String archiveId = archive.getId();
144144
```
145145

146+
You can also disable audio or video recording by setting the `hasAudio` or `hasVideo` parameters of
147+
the `startArchive(String sessionId, String name, boolean hasVideo, boolean hasAudio` method to `false`:
148+
149+
```java
150+
import com.opentok.Archive;
151+
152+
// Start an audio-only archive
153+
Archive archive = opentok.startArchive(sessionId, null, false, true);
154+
155+
// Store this archiveId in the database for later use
156+
String archiveId = archive.getId();
157+
```
158+
146159
You can stop the recording of a started Archive using a `com.opentok.Archive` instance's
147160
`stopArchive(String archiveId)` method.
148161

@@ -221,8 +234,7 @@ OpenTok TURN server to relay audio-video streams.
221234

222235
**Changes in v2.2.0:**
223236

224-
This version of the SDK includes support for working with OpenTok 2.0 archives. (This API does not
225-
work with OpenTok 1.0 archives.)
237+
This version of the SDK includes support for working with OpenTok archives.
226238

227239
This version of the SDK includes a number of improvements in the API design. These include a number
228240
of API changes. See the OpenTok 2.2 SDK Reference for details on the new API.

‎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_71) on Thu Feb 19 05:51:07 EST 2015 -->
5+
<!-- Generated by javadoc (version 1.7.0_40) on Wed Feb 25 17:35:04 PST 2015 -->
66
<title>All Classes (OpenTok Java SDK Reference)</title>
7-
<meta name="date" content="2015-02-19">
7+
<meta name="date" content="2015-02-25">
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_71) on Thu Feb 19 05:51:07 EST 2015 -->
5+
<!-- Generated by javadoc (version 1.7.0_40) on Wed Feb 25 17:35:04 PST 2015 -->
66
<title>All Classes (OpenTok Java SDK Reference)</title>
7-
<meta name="date" content="2015-02-19">
7+
<meta name="date" content="2015-02-25">
88
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
99
</head>
1010
<body>

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

Lines changed: 6 additions & 4 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_71) on Thu Feb 19 05:51:07 EST 2015 -->
5+
<!-- Generated by javadoc (version 1.7.0_40) on Wed Feb 25 17:35:03 PST 2015 -->
66
<title>Archive.Status (OpenTok Java SDK Reference)</title>
7-
<meta name="date" content="2015-02-19">
7+
<meta name="date" content="2015-02-25">
88
<link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style">
99
</head>
1010
<body>
@@ -321,7 +321,8 @@ <h4>values</h4>
321321
for (Archive.Status c : Archive.Status.values())
322322
&nbsp; System.out.println(c);
323323
</pre></div>
324-
<dl><dt><span class="strong">Returns:</span></dt><dd>an array containing the constants of this enum type, in the order they are declared</dd></dl>
324+
<dl><dt><span class="strong">Returns:</span></dt><dd>an array containing the constants of this enum type, in
325+
the order they are declared</dd></dl>
325326
</li>
326327
</ul>
327328
<a name="valueOf(java.lang.String)">
@@ -338,7 +339,8 @@ <h4>valueOf</h4>
338339
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - the name of the enum constant to be returned.</dd>
339340
<dt><span class="strong">Returns:</span></dt><dd>the enum constant with the specified name</dd>
340341
<dt><span class="strong">Throws:</span></dt>
341-
<dd><code>java.lang.IllegalArgumentException</code> - if this enum type has no constant with the specified name</dd>
342+
<dd><code>java.lang.IllegalArgumentException</code> - if this enum type has no constant
343+
with the specified name</dd>
342344
<dd><code>java.lang.NullPointerException</code> - if the argument is null</dd></dl>
343345
</li>
344346
</ul>

‎docs/com/opentok/Archive.html

Lines changed: 34 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_71) on Thu Feb 19 05:51:07 EST 2015 -->
5+
<!-- Generated by javadoc (version 1.7.0_40) on Wed Feb 25 17:35:03 PST 2015 -->
66
<title>Archive (OpenTok Java SDK Reference)</title>
7-
<meta name="date" content="2015-02-19">
7+
<meta name="date" content="2015-02-25">
88
<link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style">
99
</head>
1010
<body>
@@ -199,6 +199,18 @@ <h3>Method Summary</h3>
199199
</td>
200200
</tr>
201201
<tr class="altColor">
202+
<td class="colFirst"><code>boolean</code></td>
203+
<td class="colLast"><code><strong><a href="../../com/opentok/Archive.html#hasAudio()">hasAudio</a></strong>()</code>
204+
<div class="block">Whether the archive has an audio track (<code>true</code>) or not (<code>false</code>).</div>
205+
</td>
206+
</tr>
207+
<tr class="rowColor">
208+
<td class="colFirst"><code>boolean</code></td>
209+
<td class="colLast"><code><strong><a href="../../com/opentok/Archive.html#hasVideo()">hasVideo</a></strong>()</code>
210+
<div class="block">Whether the archive has a video track (<code>true</code>) or not (<code>false</code>).</div>
211+
</td>
212+
</tr>
213+
<tr class="altColor">
202214
<td class="colFirst"><code>static <a href="../../com/opentok/Archive.html" title="class in com.opentok">Archive</a></code></td>
203215
<td class="colLast"><code><strong><a href="../../com/opentok/Archive.html#makeArchive()">makeArchive</a></strong>()</code>&nbsp;</td>
204216
</tr>
@@ -344,6 +356,26 @@ <h4>getUrl</h4>
344356
method.</div>
345357
</li>
346358
</ul>
359+
<a name="hasVideo()">
360+
<!-- -->
361+
</a>
362+
<ul class="blockList">
363+
<li class="blockList">
364+
<h4>hasVideo</h4>
365+
<pre>public&nbsp;boolean&nbsp;hasVideo()</pre>
366+
<div class="block">Whether the archive has a video track (<code>true</code>) or not (<code>false</code>).</div>
367+
</li>
368+
</ul>
369+
<a name="hasAudio()">
370+
<!-- -->
371+
</a>
372+
<ul class="blockList">
373+
<li class="blockList">
374+
<h4>hasAudio</h4>
375+
<pre>public&nbsp;boolean&nbsp;hasAudio()</pre>
376+
<div class="block">Whether the archive has an audio track (<code>true</code>) or not (<code>false</code>).</div>
377+
</li>
378+
</ul>
347379
<a name="toString()">
348380
<!-- -->
349381
</a>

‎docs/com/opentok/ArchiveList.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_71) on Thu Feb 19 05:51:07 EST 2015 -->
5+
<!-- Generated by javadoc (version 1.7.0_40) on Wed Feb 25 17:35:03 PST 2015 -->
66
<title>ArchiveList (OpenTok Java SDK Reference)</title>
7-
<meta name="date" content="2015-02-19">
7+
<meta name="date" content="2015-02-25">
88
<link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style">
99
</head>
1010
<body>

‎docs/com/opentok/MediaMode.html

Lines changed: 6 additions & 4 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_71) on Thu Feb 19 05:51:07 EST 2015 -->
5+
<!-- Generated by javadoc (version 1.7.0_40) on Wed Feb 25 17:35:03 PST 2015 -->
66
<title>MediaMode (OpenTok Java SDK Reference)</title>
7-
<meta name="date" content="2015-02-19">
7+
<meta name="date" content="2015-02-25">
88
<link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style">
99
</head>
1010
<body>
@@ -240,7 +240,8 @@ <h4>values</h4>
240240
for (MediaMode c : MediaMode.values())
241241
&nbsp; System.out.println(c);
242242
</pre></div>
243-
<dl><dt><span class="strong">Returns:</span></dt><dd>an array containing the constants of this enum type, in the order they are declared</dd></dl>
243+
<dl><dt><span class="strong">Returns:</span></dt><dd>an array containing the constants of this enum type, in
244+
the order they are declared</dd></dl>
244245
</li>
245246
</ul>
246247
<a name="valueOf(java.lang.String)">
@@ -257,7 +258,8 @@ <h4>valueOf</h4>
257258
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - the name of the enum constant to be returned.</dd>
258259
<dt><span class="strong">Returns:</span></dt><dd>the enum constant with the specified name</dd>
259260
<dt><span class="strong">Throws:</span></dt>
260-
<dd><code>java.lang.IllegalArgumentException</code> - if this enum type has no constant with the specified name</dd>
261+
<dd><code>java.lang.IllegalArgumentException</code> - if this enum type has no constant
262+
with the specified name</dd>
261263
<dd><code>java.lang.NullPointerException</code> - if the argument is null</dd></dl>
262264
</li>
263265
</ul>

0 commit comments

Comments
 (0)