Skip to content

Commit 65d201a

Browse files
jeffswartzjeffswartz
committed
Generated JavaDocs
1 parent 9650a64 commit 65d201a

31 files changed

+201
-108
lines changed

‎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:09:08 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:09:08 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:09:08 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:09:07 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 an 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 an 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:09:08 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:09:08 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>

‎docs/com/opentok/OpenTok.html

Lines changed: 58 additions & 14 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:09:08 PST 2015 -->
66
<title>OpenTok (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>
@@ -123,13 +123,13 @@ <h3>Constructor Summary</h3>
123123
<th class="colOne" scope="col">Constructor and Description</th>
124124
</tr>
125125
<tr class="altColor">
126-
<td class="colOne"><code><strong><a href="../../com/opentok/OpenTok.html#OpenTok(int,%20java.lang.String)">OpenTok</a></strong>(int&nbsp;apiKey,
126+
<td class="colOne"><code><strong><a href="../../com/opentok/OpenTok.html#OpenTok(int, java.lang.String)">OpenTok</a></strong>(int&nbsp;apiKey,
127127
java.lang.String&nbsp;apiSecret)</code>
128128
<div class="block">Creates an OpenTok object.</div>
129129
</td>
130130
</tr>
131131
<tr class="rowColor">
132-
<td class="colOne"><code><strong><a href="../../com/opentok/OpenTok.html#OpenTok(int,%20java.lang.String,%20java.lang.String)">OpenTok</a></strong>(int&nbsp;apiKey,
132+
<td class="colOne"><code><strong><a href="../../com/opentok/OpenTok.html#OpenTok(int, java.lang.String, java.lang.String)">OpenTok</a></strong>(int&nbsp;apiKey,
133133
java.lang.String&nbsp;apiSecret,
134134
java.lang.String&nbsp;apiUrl)</code>&nbsp;</td>
135135
</tr>
@@ -174,7 +174,7 @@ <h3>Method Summary</h3>
174174
</tr>
175175
<tr class="altColor">
176176
<td class="colFirst"><code>java.lang.String</code></td>
177-
<td class="colLast"><code><strong><a href="../../com/opentok/OpenTok.html#generateToken(java.lang.String,%20com.opentok.TokenOptions)">generateToken</a></strong>(java.lang.String&nbsp;sessionId,
177+
<td class="colLast"><code><strong><a href="../../com/opentok/OpenTok.html#generateToken(java.lang.String, com.opentok.TokenOptions)">generateToken</a></strong>(java.lang.String&nbsp;sessionId,
178178
<a href="../../com/opentok/TokenOptions.html" title="class in com.opentok">TokenOptions</a>&nbsp;tokenOptions)</code>
179179
<div class="block">Creates a token for connecting to an OpenTok session.</div>
180180
</td>
@@ -194,21 +194,30 @@ <h3>Method Summary</h3>
194194
</tr>
195195
<tr class="rowColor">
196196
<td class="colFirst"><code><a href="../../com/opentok/ArchiveList.html" title="class in com.opentok">ArchiveList</a></code></td>
197-
<td class="colLast"><code><strong><a href="../../com/opentok/OpenTok.html#listArchives(int,%20int)">listArchives</a></strong>(int&nbsp;offset,
197+
<td class="colLast"><code><strong><a href="../../com/opentok/OpenTok.html#listArchives(int, int)">listArchives</a></strong>(int&nbsp;offset,
198198
int&nbsp;count)</code>
199199
<div class="block">Returns a List of <a href="../../com/opentok/Archive.html" title="class in com.opentok"><code>Archive</code></a> objects, representing archives that are both
200200
both completed and in-progress, for your API key.</div>
201201
</td>
202202
</tr>
203203
<tr class="altColor">
204204
<td class="colFirst"><code><a href="../../com/opentok/Archive.html" title="class in com.opentok">Archive</a></code></td>
205-
<td class="colLast"><code><strong><a href="../../com/opentok/OpenTok.html#startArchive(java.lang.String,%20java.lang.String)">startArchive</a></strong>(java.lang.String&nbsp;sessionId,
205+
<td class="colLast"><code><strong><a href="../../com/opentok/OpenTok.html#startArchive(java.lang.String, java.lang.String)">startArchive</a></strong>(java.lang.String&nbsp;sessionId,
206206
java.lang.String&nbsp;name)</code>
207-
<div class="block">Starts archiving an OpenTok 2.0 session.</div>
207+
<div class="block">Starts archiving an OpenTok session.</div>
208208
</td>
209209
</tr>
210210
<tr class="rowColor">
211211
<td class="colFirst"><code><a href="../../com/opentok/Archive.html" title="class in com.opentok">Archive</a></code></td>
212+
<td class="colLast"><code><strong><a href="../../com/opentok/OpenTok.html#startArchive(java.lang.String, java.lang.String, boolean, boolean)">startArchive</a></strong>(java.lang.String&nbsp;sessionId,
213+
java.lang.String&nbsp;name,
214+
boolean&nbsp;hasVideo,
215+
boolean&nbsp;hasAudio)</code>
216+
<div class="block">Starts archiving an OpenTok session.</div>
217+
</td>
218+
</tr>
219+
<tr class="altColor">
220+
<td class="colFirst"><code><a href="../../com/opentok/Archive.html" title="class in com.opentok">Archive</a></code></td>
212221
<td class="colLast"><code><strong><a href="../../com/opentok/OpenTok.html#stopArchive(java.lang.String)">stopArchive</a></strong>(java.lang.String&nbsp;archiveId)</code>
213222
<div class="block">Stops an OpenTok archive that is being recorded.</div>
214223
</td>
@@ -365,7 +374,7 @@ <h4>generateToken</h4>
365374
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>sessionId</code> - The session ID corresponding to the session to which the user will connect.</dd>
366375
<dt><span class="strong">Returns:</span></dt><dd>The token string.</dd>
367376
<dt><span class="strong">Throws:</span></dt>
368-
<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#generateToken(java.lang.String,%20com.opentok.TokenOptions)"><code>generateToken(String, TokenOptions)</code></a></dd></dl>
377+
<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#generateToken(java.lang.String, com.opentok.TokenOptions)"><code>generateToken(String, TokenOptions)</code></a></dd></dl>
369378
</li>
370379
</ul>
371380
<a name="createSession(com.opentok.SessionProperties)">
@@ -383,7 +392,7 @@ <h4>createSession</h4>
383392
OT.initSession()</a> method (to initialize an OpenTok session).
384393
<p>
385394
OpenTok sessions do not expire. However, authentication tokens do expire (see the
386-
<a href="../../com/opentok/OpenTok.html#generateToken(java.lang.String,%20com.opentok.TokenOptions)"><code>generateToken(String, TokenOptions)</code></a> method). Also note that sessions cannot
395+
<a href="../../com/opentok/OpenTok.html#generateToken(java.lang.String, com.opentok.TokenOptions)"><code>generateToken(String, TokenOptions)</code></a> method). Also note that sessions cannot
387396
explicitly be destroyed.
388397
<p>
389398
A session ID string can be up to 255 characters long.
@@ -504,7 +513,7 @@ <h4>listArchives</h4>
504513
<div class="block">Returns a List of <a href="../../com/opentok/Archive.html" title="class in com.opentok"><code>Archive</code></a> objects, representing archives that are both
505514
both completed and in-progress, for your API key. This list is limited to 1000 archives
506515
starting with the first archive recorded. For a specific range of archives, call
507-
<a href="../../com/opentok/OpenTok.html#listArchives(int,%20int)"><code>listArchives(int offset, int count)</code></a>.</div>
516+
<a href="../../com/opentok/OpenTok.html#listArchives(int, int)"><code>listArchives(int offset, int count)</code></a>.</div>
508517
<dl><dt><span class="strong">Returns:</span></dt><dd>A List of <a href="../../com/opentok/Archive.html" title="class in com.opentok"><code>Archive</code></a> objects.</dd>
509518
<dt><span class="strong">Throws:</span></dt>
510519
<dd><code><a href="../../com/opentok/exception/OpenTokException.html" title="class in com.opentok.exception">OpenTokException</a></code></dd></dl>
@@ -539,7 +548,36 @@ <h4>startArchive</h4>
539548
<pre>public&nbsp;<a href="../../com/opentok/Archive.html" title="class in com.opentok">Archive</a>&nbsp;startArchive(java.lang.String&nbsp;sessionId,
540549
java.lang.String&nbsp;name)
541550
throws <a href="../../com/opentok/exception/OpenTokException.html" title="class in com.opentok.exception">OpenTokException</a></pre>
542-
<div class="block">Starts archiving an OpenTok 2.0 session.
551+
<div class="block">Starts archiving an OpenTok session. This version of the <code>startArchive()</code> method
552+
lets you disable audio or video recording.
553+
554+
<p>
555+
Clients must be actively connected to the OpenTok session for you to successfully start recording an archive.
556+
<p>
557+
You can only record one archive at a time for a given session. You can only record archives
558+
of sessions that use the OpenTok Media Router (sessions with the
559+
<a href="http://tokbox.com/opentok/tutorials/create-session/#media-mode">media mode</a>
560+
set to routed); you cannot archive sessions with the media mode set to relayed.</div>
561+
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>sessionId</code> - The session ID of the OpenTok session to archive.</dd><dd><code>name</code> - The name of the archive. You can use this name to identify the archive. It is a property
562+
of the Archive object, and it is a property of archive-related events in the OpenTok client libraries.</dd>
563+
<dt><span class="strong">Returns:</span></dt><dd>The Archive object. This object includes properties defining the archive, including the archive ID.</dd>
564+
<dt><span class="strong">Throws:</span></dt>
565+
<dd><code><a href="../../com/opentok/exception/OpenTokException.html" title="class in com.opentok.exception">OpenTokException</a></code></dd></dl>
566+
</li>
567+
</ul>
568+
<a name="startArchive(java.lang.String, java.lang.String, boolean, boolean)">
569+
<!-- -->
570+
</a>
571+
<ul class="blockList">
572+
<li class="blockList">
573+
<h4>startArchive</h4>
574+
<pre>public&nbsp;<a href="../../com/opentok/Archive.html" title="class in com.opentok">Archive</a>&nbsp;startArchive(java.lang.String&nbsp;sessionId,
575+
java.lang.String&nbsp;name,
576+
boolean&nbsp;hasVideo,
577+
boolean&nbsp;hasAudio)
578+
throws <a href="../../com/opentok/exception/OpenTokException.html" title="class in com.opentok.exception">OpenTokException</a></pre>
579+
<div class="block">Starts archiving an OpenTok session. This version of the <code>startArchive()</code> method
580+
lets you disable audio or video recording.
543581

544582
<p>
545583
Clients must be actively connected to the OpenTok session for you to successfully start recording an archive.
@@ -549,7 +587,13 @@ <h4>startArchive</h4>
549587
<a href="http://tokbox.com/opentok/tutorials/create-session/#media-mode">media mode</a>
550588
set to routed); you cannot archive sessions with the media mode set to relayed.</div>
551589
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>sessionId</code> - The session ID of the OpenTok session to archive.</dd><dd><code>name</code> - The name of the archive. You can use this name to identify the archive. It is a property
552-
of the Archive object, and it is a property of archive-related events in the OpenTok JavaScript SDK.</dd>
590+
of the Archive object, and it is a property of archive-related events in the OpenTok client libraries.</dd><dd><code>hasVideo</code> - Whether the archive will include an audio track (<code>true</code>) or not
591+
<code>false</code>). The default value is <code>true</code> (an audio track is included). If you set
592+
both <code>hasAudio</code> and <code>hasAudio</code> to <code>false</code>, the call to the
593+
<code>startArchive()</code> method results in an error.</dd><dd><code>hasAudio</code> - Whether the archive will include a video track (<code>true</code>) or not
594+
<code>false</code>). The default value is <code>true</code> (a video track is included). If you set
595+
both <code>hasAudio</code> and <code>hasAudio</code> to <code>false</code>, the call to the
596+
<code>startArchive()</code> method results in an error.</dd>
553597
<dt><span class="strong">Returns:</span></dt><dd>The Archive object. This object includes properties defining the archive, including the archive ID.</dd>
554598
<dt><span class="strong">Throws:</span></dt>
555599
<dd><code><a href="../../com/opentok/exception/OpenTokException.html" title="class in com.opentok.exception">OpenTokException</a></code></dd></dl>
@@ -568,7 +612,7 @@ <h4>stopArchive</h4>
568612
Archives automatically stop recording after 90 minutes or when all clients have disconnected from the
569613
session being archived.</div>
570614
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>archiveId</code> - The archive ID of the archive you want to stop recording.</dd>
571-
<dt><span class="strong">Returns:</span></dt><dd>The Archive object corresponding to the archive being STOPPED.</dd>
615+
<dt><span class="strong">Returns:</span></dt><dd>The Archive object corresponding to the archive being stopped.</dd>
572616
<dt><span class="strong">Throws:</span></dt>
573617
<dd><code><a href="../../com/opentok/exception/OpenTokException.html" title="class in com.opentok.exception">OpenTokException</a></code></dd></dl>
574618
</li>

0 commit comments

Comments
 (0)