@@ -369,12 +369,32 @@ public ArchiveList listArchives(int offset, int count) throws OpenTokException {
369
369
}
370
370
}
371
371
372
+ /**
373
+ * Starts archiving an OpenTok session. This version of the <code>startArchive()</code> method
374
+ * lets you disable audio or video recording.
375
+ *
376
+ * <p>
377
+ * Clients must be actively connected to the OpenTok session for you to successfully start recording an archive.
378
+ * <p>
379
+ * You can only record one archive at a time for a given session. You can only record archives
380
+ * of sessions that use the OpenTok Media Router (sessions with the
381
+ * <a href="http://tokbox.com/opentok/tutorials/create-session/#media-mode">media mode</a>
382
+ * set to routed); you cannot archive sessions with the media mode set to relayed.
383
+ *
384
+ * @param sessionId The session ID of the OpenTok session to archive.
385
+ *
386
+ * @param name The name of the archive. You can use this name to identify the archive. It is a property
387
+ * of the Archive object, and it is a property of archive-related events in the OpenTok client libraries.
388
+ *
389
+ * @return The Archive object. This object includes properties defining the archive, including the archive ID.
390
+ */
372
391
public Archive startArchive (String sessionId , String name ) throws OpenTokException {
373
392
return startArchive (sessionId , name , true , true );
374
393
}
375
394
376
395
/**
377
- * Starts archiving an OpenTok 2.0 session.
396
+ * Starts archiving an OpenTok session. This version of the <code>startArchive()</code> method
397
+ * lets you disable audio or video recording.
378
398
*
379
399
* <p>
380
400
* Clients must be actively connected to the OpenTok session for you to successfully start recording an archive.
@@ -385,8 +405,19 @@ public Archive startArchive(String sessionId, String name) throws OpenTokExcepti
385
405
* set to routed); you cannot archive sessions with the media mode set to relayed.
386
406
*
387
407
* @param sessionId The session ID of the OpenTok session to archive.
408
+ *
388
409
* @param name The name of the archive. You can use this name to identify the archive. It is a property
389
- * of the Archive object, and it is a property of archive-related events in the OpenTok JavaScript SDK.
410
+ * of the Archive object, and it is a property of archive-related events in the OpenTok client libraries.
411
+ *
412
+ * @param hasVideo Whether the archive will include an audio track (<code>true</code>) or not
413
+ * <code>false</code>). The default value is <code>true</code> (an audio track is included). If you set
414
+ * both <code>hasAudio</code> and <code>hasAudio</code> to <code>false</code>, the call to the
415
+ * <code>startArchive()</code> method results in an error.
416
+ *
417
+ * @param hasAudio Whether the archive will include a video track (<code>true</code>) or not
418
+ * <code>false</code>). The default value is <code>true</code> (a video track is included). If you set
419
+ * both <code>hasAudio</code> and <code>hasAudio</code> to <code>false</code>, the call to the
420
+ * <code>startArchive()</code> method results in an error.
390
421
*
391
422
* @return The Archive object. This object includes properties defining the archive, including the archive ID.
392
423
*/
@@ -410,7 +441,7 @@ public Archive startArchive(String sessionId, String name, boolean hasVideo, boo
410
441
* session being archived.
411
442
*
412
443
* @param archiveId The archive ID of the archive you want to stop recording.
413
- * @return The Archive object corresponding to the archive being STOPPED .
444
+ * @return The Archive object corresponding to the archive being stopped .
414
445
*/
415
446
public Archive stopArchive (String archiveId ) throws OpenTokException {
416
447
0 commit comments