Skip to content

Commit db5d386

Browse files
authored
Minor docs corrections
1 parent ed85869 commit db5d386

File tree

1 file changed

+15
-5
lines changed

1 file changed

+15
-5
lines changed

README.rst

Lines changed: 15 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -44,10 +44,20 @@ Import the package at the top of any file where you will use it. At the very lea
4444
Creating Sessions
4545
~~~~~~~~~~~~~~~~~
4646

47-
The create an OpenTok Session, use the ``opentok.create_session()`` method. There are three optional
48-
keyword parameters for this method: ``location`` which can be set to a string containing an IP
49-
address, ``media_mode`` which is a String (defined by the MediaModes class) and ``archive_mode`` which
50-
specifies whether the session will be automatically archived (``always``) or not (``manual``).
47+
To create an OpenTok Session, use the ``opentok.create_session()`` method. There are three optional
48+
keyword parameters for this method:
49+
50+
* ``location`` which can be set to a string containing an IP address.
51+
52+
* ``media_mode`` which is a String (defined by the MediaModes class).
53+
This determines whether the session will use the
54+
`OpenTok Media Router <https://tokbox.com/developer/guides/create-session/#media-mode>`_
55+
or attempt to send streams directly between clients. A routed session is required for some
56+
OpenTok features (such as archiving).
57+
58+
* ``archive_mode`` which specifies whether the session will be automatically archived (``always``)
59+
or not (``manual``).
60+
5161
This method returns a ``Session`` object. Its ``session_id`` attribute is useful when saving to a persistent
5262
store (such as a database).
5363

@@ -97,7 +107,7 @@ Working with Archives
97107
You can start the recording of an OpenTok Session using the ``opentok.start_archive(session_id)``
98108
method. This method takes an optional keyword argument ``name`` to assign a name to the archive.
99109
This method will return an ``Archive`` instance. Note that you can only start an Archive on
100-
a Session that has clients connection.
110+
a Session that has clients connected.
101111

102112
.. code:: python
103113

0 commit comments

Comments
 (0)