Skip to content

Commit 9e8032b

Browse files
jeffswartzaiham
authored andcommitted
Docs corrections (#80)
* Better docs for archiving requiring routed sessions * Minor docs edit and sample code correction. Fixes #71. * Cleaning up README merge * Removing unneeded files * Removing untracked files * Change sample to use the Session.connect() completion handler * Minor hello world edits * Corrections to the docs for Archive property names * Another corrections to the docs for Archive property names * Correction to archiving docs * Reverting sample app changes and removing unused file * whitespace correction
1 parent f6cf761 commit 9e8032b

File tree

2 files changed

+8
-5
lines changed

2 files changed

+8
-5
lines changed

README.rst

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@ store (such as a database).
6868
session = opentok.create_session()
6969
7070
from opentok import MediaModes
71-
# A session that uses the OpenTok Media Router:
71+
# A session that uses the OpenTok Media Router, which is required for archiving:
7272
session = opentok.create_session(media_mode=MediaModes.routed)
7373
7474
# An automatically archived session:
@@ -106,6 +106,9 @@ have a set of optional keyword parameters: ``role``, ``expire_time``, ``data``,
106106
Working with Archives
107107
~~~~~~~~~~~~~~~~~~~~~
108108

109+
You can only archive sessions that use the OpenTok Media
110+
Router (sessions with the media mode set to routed).
111+
109112
You can start the recording of an OpenTok Session using the ``opentok.start_archive(session_id)``
110113
method. This method takes an optional keyword argument ``name`` to assign a name to the archive.
111114
This method will return an ``Archive`` instance. Note that you can only start an Archive on

opentok/archives.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -47,14 +47,14 @@ class Archive(object):
4747
Whether all streams in the archive are recorded to a single file
4848
(OutputModes.composed) or to individual files (OutputModes.individual).
4949
50-
:ivar partnerId:
50+
:ivar partner_id:
5151
The API key associated with the archive.
5252
5353
:ivar reason:
5454
For archives with the status "stopped" or "failed", this string describes the
5555
reason the archive stopped (such as "maximum duration exceeded") or failed.
5656
57-
:ivar sessionId:
57+
:ivar session_id:
5858
The session ID of the OpenTok session associated with this archive.
5959
6060
:ivar size:
@@ -107,8 +107,8 @@ def stop(self):
107107
"""
108108
Stops an OpenTok archive that is being recorded.
109109
110-
Archives automatically stop recording after 90 minutes or when all clients have disconnected
111-
from the session being archived.
110+
Archives automatically stop recording after 120 minutes or when all clients have
111+
disconnected from the session being archived.
112112
"""
113113
temp_archive = self.sdk.stop_archive(self.id)
114114
for k,v in iteritems(temp_archive.attrs()):

0 commit comments

Comments
 (0)