Skip to content

Commit 2ccf166

Browse files
jeffswartzjeffswartz
committed
Docs edits.
1 parent 99840e2 commit 2ccf166

File tree

10 files changed

+90
-6
lines changed

10 files changed

+90
-6
lines changed

‎docs/_sources/docs/opentok.txt‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,14 @@ opentok.session module
3636
:undoc-members:
3737
:show-inheritance:
3838

39+
opentok.version module
40+
----------------------
41+
42+
.. automodule:: opentok.version
43+
:members:
44+
:undoc-members:
45+
:show-inheritance:
46+
3947

4048
Module contents
4149
---------------

‎docs/docs/modules.html‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -54,6 +54,7 @@ <h1>opentok<a class="headerlink" href="#opentok" title="Permalink to this headli
5454
<li class="toctree-l2"><a class="reference internal" href="opentok.html#module-opentok.exceptions">opentok.exceptions module</a></li>
5555
<li class="toctree-l2"><a class="reference internal" href="opentok.html#module-opentok.opentok">opentok.opentok module</a></li>
5656
<li class="toctree-l2"><a class="reference internal" href="opentok.html#module-opentok.session">opentok.session module</a></li>
57+
<li class="toctree-l2"><a class="reference internal" href="opentok.html#module-opentok.version">opentok.version module</a></li>
5758
<li class="toctree-l2"><a class="reference internal" href="opentok.html#module-opentok">Module contents</a></li>
5859
</ul>
5960
</li>

‎docs/docs/opentok.html‎

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -253,7 +253,7 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this
253253
<col class="field-body" />
254254
<tbody valign="top">
255255
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
256-
<li><strong>mediaMode</strong> (<em>String</em>) &#8211; <p>determine whether the session will transmit streams using the
256+
<li><strong>mediaMode</strong> (<em>String</em>) &#8211; <p>Determines whether the session will transmit streams using the
257257
OpenTok Media Router (MediaMode.ROUTED) or not (MediaMode.RELAYED). By default,
258258
sessions use the OpenTok Media Router.</p>
259259
<p>The OpenTok Media Router (see <a class="reference external" href="http://www.tokbox.com/#multiparty">http://www.tokbox.com/#multiparty</a>)
@@ -262,7 +262,7 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this
262262
<div><ul>
263263
<li><dl class="first docutils">
264264
<dt>The OpenTok Media Router can decrease bandwidth usage in multiparty sessions.</dt>
265-
<dd>(When the mediaMode property is set to MediaMode.ROUTED, each client must send
265+
<dd>(When the mediaMode property is set to MediaMode.RELAYED, each client must send
266266
a separate audio-video stream to each client subscribing to it.)</dd>
267267
</dl>
268268
</li>
@@ -539,6 +539,9 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this
539539

540540
</dd></dl>
541541

542+
</div>
543+
<div class="section" id="module-opentok.version">
544+
<span id="opentok-version-module"></span><h2>opentok.version module<a class="headerlink" href="#module-opentok.version" title="Permalink to this headline"></a></h2>
542545
</div>
543546
<div class="section" id="module-opentok">
544547
<span id="module-contents"></span><h2>Module contents<a class="headerlink" href="#module-opentok" title="Permalink to this headline"></a></h2>
@@ -559,6 +562,7 @@ <h3><a href="../index.html">Table Of Contents</a></h3>
559562
<li><a class="reference internal" href="#module-opentok.exceptions">opentok.exceptions module</a></li>
560563
<li><a class="reference internal" href="#module-opentok.opentok">opentok.opentok module</a></li>
561564
<li><a class="reference internal" href="#module-opentok.session">opentok.session module</a></li>
565+
<li><a class="reference internal" href="#module-opentok.version">opentok.version module</a></li>
562566
<li><a class="reference internal" href="#module-opentok">Module contents</a></li>
563567
</ul>
564568
</li>

‎docs/genindex.html‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -244,6 +244,10 @@ <h2 id="O">O</h2>
244244
</dt>
245245

246246

247+
<dt><a href="docs/opentok.html#module-opentok.version">opentok.version (module)</a>
248+
</dt>
249+
250+
247251
<dt><a href="docs/opentok.html#opentok.exceptions.OpenTokException">OpenTokException</a>
248252
</dt>
249253

‎docs/modules.rst‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
opentok
2+
=======
3+
4+
.. toctree::
5+
:maxdepth: 4
6+
7+
opentok

‎docs/objects.inv‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,4 +2,5 @@
22
# Project: OpenTok Python SDK 2.2
33
# Version: 2.2
44
# The remainder of this file is compressed using zlib.
5-
xڭVMO�0 ��+*�u��q(�v��Ƭ�,)���ߓ.�V�K�S����~�h6Z�J�g�$���@f����l��h#ϳG-���=:[�:�N›"pSV?�Y0[x�g��3݀"��ೄ�j��E2�x�W��%^v6[���\d��!�m�Ļ�w� � ���n)7F��hw�]�:�=���}�@EH~P���,s-�f����By�b_�Ӏ��N22�� �����XU�$�~����Vj�� '_uNd�%��U]�4P�KP ��� yp&0=���[0.9���K���5k�R�@�^Q�!x�g ��i��V��;Խ�F(27C�Ddz|��g�"�-�f��e����QB���y��Y:TG7CJ/�ӷB�]B��I�:�k�ؕ�����M�&�wf�v@������_��a�C��}v�I�/�[��v�h�ރД�h�ƿ���� 
5+
xڭVMO�0 ��+*�u��q(�v��Ƭ�,)���ߓ.�V�K�S����~�h7Z�J�g�$���@f����l��h#ϳG-��쮽:[�:�n›"pSV?�]0[x�g��3݀"��ೄ�j��E2�x�W��%^v6[��\d��!�m�$� g<�LR�����9�[@ʍѦ%�=e�G���ɞܹt���m#��8�e�����_X�+[��{�W��@&@AB�]g1AWB�V��ʓd��o���2�J�\[���ΉL���»���
6+
�*��!�����G5w��%g@�/q��V��Fb-S�H�+j5��,��7�3M��*1�t����EF�fȖ�x�O���X���,�̑U�9JhWX:�9K���f�B�%t�V�K�#�5IR�xM��5V���� �$��� ���qV�v��t5,UcH��3I�dv+~����a�4��6�����D��M}

‎docs/opentok.rst‎

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
opentok package
2+
===============
3+
4+
Submodules
5+
----------
6+
7+
opentok.archives module
8+
-----------------------
9+
10+
.. automodule:: opentok.archives
11+
:members:
12+
:undoc-members:
13+
:show-inheritance:
14+
15+
opentok.exceptions module
16+
-------------------------
17+
18+
.. automodule:: opentok.exceptions
19+
:members:
20+
:undoc-members:
21+
:show-inheritance:
22+
23+
opentok.opentok module
24+
----------------------
25+
26+
.. automodule:: opentok.opentok
27+
:members:
28+
:undoc-members:
29+
:show-inheritance:
30+
31+
opentok.session module
32+
----------------------
33+
34+
.. automodule:: opentok.session
35+
:members:
36+
:undoc-members:
37+
:show-inheritance:
38+
39+
opentok.version module
40+
----------------------
41+
42+
.. automodule:: opentok.version
43+
:members:
44+
:undoc-members:
45+
:show-inheritance:
46+
47+
48+
Module contents
49+
---------------
50+
51+
.. automodule:: opentok
52+
:members:
53+
:undoc-members:
54+
:show-inheritance:

‎docs/py-modindex.html‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -84,6 +84,11 @@ <h1>Python Module Index</h1>
8484
<td>&nbsp;&nbsp;&nbsp;
8585
<a href="docs/opentok.html#module-opentok.session"><tt class="xref">opentok.session</tt></a></td><td>
8686
<em></em></td></tr>
87+
<tr class="cg-1">
88+
<td></td>
89+
<td>&nbsp;&nbsp;&nbsp;
90+
<a href="docs/opentok.html#module-opentok.version"><tt class="xref">opentok.version</tt></a></td><td>
91+
<em></em></td></tr>
8792
</table>
8893

8994

‎docs/searchindex.js‎

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎opentok/opentok.py‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -169,15 +169,15 @@ def create_session(self, location=None, media_mode=MediaModes.routed):
169169
http://www.tokbox.com/opentok/api/#session_id_production) or the OpenTok dashboard
170170
(see https://dashboard.tokbox.com/projects).
171171
172-
:param String mediaMode: determine whether the session will transmit streams using the
172+
:param String mediaMode: Determines whether the session will transmit streams using the
173173
OpenTok Media Router (MediaMode.ROUTED) or not (MediaMode.RELAYED). By default,
174174
sessions use the OpenTok Media Router.
175175
176176
The OpenTok Media Router (see http://www.tokbox.com/#multiparty)
177177
provides the following benefits:
178178
179179
* The OpenTok Media Router can decrease bandwidth usage in multiparty sessions.
180-
(When the mediaMode property is set to MediaMode.ROUTED, each client must send
180+
(When the mediaMode property is set to MediaMode.RELAYED, each client must send
181181
a separate audio-video stream to each client subscribing to it.)
182182
183183
* The OpenTok Media Router can improve the quality of the user experience through

0 commit comments

Comments
 (0)