New generated reference docs.

Author: jeffswartz

docs/README.html

@@ -51,15 +51,14 @@ <h1>OpenTok Python SDK<a class="headerlink" href="#opentok-python-sdk" title="Pe
 <a class="reference external" href="http://tokbox.com/opentok/tutorials/create-session/">sessions</a> and
 <a class="reference external" href="http://tokbox.com/opentok/tutorials/create-token/">tokens</a> for <a class="reference external" href="http://www.tokbox.com/">OpenTok</a>
 applications, and <a class="reference external" href="http://www.tokbox.com/platform/archiving">archive</a> Opentok 2.0 sessions.</p>
-<p>If you are updating from a previous version of this SDK, see
-<a class="reference external" href="#important-changes-in-v22">Important changes in v2.2</a>.</p>
+<p>If you are updating from a previous version of this SDK, see &#8220;Important changes since v2.2.0&#8221; below.</p>
 <div class="section" id="installation-using-pip-recommended">
 <h2>Installation using Pip (recommended):<a class="headerlink" href="#installation-using-pip-recommended" title="Permalink to this headline">¶</a></h2>
 <p>Pip helps manage dependencies for Python projects using the PyPI index. Find more info here:
 <a class="reference external" href="http://www.pip-installer.org/en/latest/">http://www.pip-installer.org/en/latest/</a></p>
 <p>Add the <tt class="docutils literal"><span class="pre">opentok</span></tt> package as a dependency in your project. The most common way is to add it to your
 <tt class="docutils literal"><span class="pre">requirements.txt</span></tt> file:</p>
-<div class="highlight-python"><div class="highlight"><pre>opentok&gt;=2.2.0
+<div class="highlight-python"><div class="highlight"><pre>opentok&gt;=2.2.1
 </pre></div>
 </div>
 <p>Next, install the dependencies:</p>
@@ -86,12 +85,12 @@ <h3>Creating Sessions<a class="headerlink" href="#creating-sessions" title="Perm
 address, and <tt class="docutils literal"><span class="pre">media_mode</span></tt> which is a String (defined by the MediaModes class). This method returns
 a <tt class="docutils literal"><span class="pre">Session</span></tt> object. Its <tt class="docutils literal"><span class="pre">session_id</span></tt> attribute is useful when saving to a persistent store (such
 as a database).</p>
-<div class="code python highlight-python"><div class="highlight"><pre><span class="c"># Just a plain Session:</span>
-<span class="n">session</span> <span class="o">=</span> <span class="n">opentok</span><span class="o">.</span><span class="n">create_session</span><span class="p">()</span>
-<span class="c"># A Session that attempts to send streams directly between clients (falling back</span>
+<div class="code python highlight-python"><div class="highlight"><pre><span class="c"># Create a session that attempts to send streams directly between clients (falling back</span>
 <span class="c"># to use the OpenTok TURN server to relay streams if the clients cannot connect):</span>
-<span class="n">session</span> <span class="o">=</span> <span class="n">opentok</span><span class="o">.</span><span class="n">create_session</span><span class="p">(</span><span class="n">media_mode</span><span class="o">=</span><span class="n">MediaModes</span><span class="o">.</span><span class="n">relayed</span><span class="p">)</span>
-<span class="c"># A Session with a location hint</span>
+<span class="n">session</span> <span class="o">=</span> <span class="n">opentok</span><span class="o">.</span><span class="n">create_session</span><span class="p">()</span>
+<span class="c"># A session that uses the OpenTok Media Router:</span>
+<span class="n">session</span> <span class="o">=</span> <span class="n">opentok</span><span class="o">.</span><span class="n">create_session</span><span class="p">(</span><span class="n">media_mode</span><span class="o">=</span><span class="n">MediaModes</span><span class="o">.</span><span class="n">routed</span><span class="p">)</span>
+<span class="c"># A session with a location hint</span>
 <span class="n">session</span> <span class="o">=</span> <span class="n">opentok</span><span class="o">.</span><span class="n">create_session</span><span class="p">(</span><span class="n">location</span><span class="o">=</span><span class="s">u&#39;12.34.56.78&#39;</span><span class="p">)</span>
 
 <span class="c"># Store this session ID in the database</span>
@@ -195,8 +194,15 @@ <h2>Release Notes<a class="headerlink" href="#release-notes" title="Permalink to
 <p>See the <a class="reference external" href="https://github.com/opentok/Opentok-Python-SDK/releases">Releases</a> page for details about
 each release.</p>
 </div>
-<div class="section" id="id1">
-<h2>Important changes in v2.2<a class="headerlink" href="#id1" title="Permalink to this headline">¶</a></h2>
+<div class="section" id="important-changes-since-v2-2">
+<h2>Important changes since v2.2<a class="headerlink" href="#important-changes-since-v2-2" title="Permalink to this headline">¶</a></h2>
+<p><strong>Changes in v2.2.1:</strong></p>
+<p>The default setting for the create_session() method is to create a session with the media mode set
+to relayed. In previous versions of the SDK, the default setting was to use the OpenTok Media Router
+(media mode set to routed). In a relayed session, clients will attempt to send streams directly
+between each other (peer-to-peer); if clients cannot connect due to firewall restrictions, the
+session uses the OpenTok TURN server to relay audio-video streams.</p>
+<p><strong>Changes in v2.2.0:</strong></p>
 <p>This version of the SDK includes support for working with OpenTok 2.0 archives. (This API does not
 work with OpenTok 1.0 archives.)</p>
 <p>The OpenTok.create_session() method now includes a media_mode parameter, instead of a p2p parameter.</p>
@@ -237,7 +243,7 @@ <h3><a href="index.html">Table Of Contents</a></h3>
 <li><a class="reference internal" href="#documentation">Documentation</a></li>
 <li><a class="reference internal" href="#requirements">Requirements</a></li>
 <li><a class="reference internal" href="#release-notes">Release Notes</a></li>
-<li><a class="reference internal" href="#id1">Important changes in v2.2</a></li>
+<li><a class="reference internal" href="#important-changes-since-v2-2">Important changes since v2.2</a></li>
 <li><a class="reference internal" href="#development-and-contributing">Development and Contributing</a></li>
 <li><a class="reference internal" href="#support">Support</a></li>
 </ul>

docs/_sources/README.txt

@@ -10,8 +10,7 @@ The OpenTok Python SDK lets you generate
 `tokens <http://tokbox.com/opentok/tutorials/create-token/>`_ for `OpenTok <http://www.tokbox.com/>`_
 applications, and `archive <http://www.tokbox.com/platform/archiving>`_ Opentok 2.0 sessions.
 
-If you are updating from a previous version of this SDK, see
-`Important changes in v2.2 <#important-changes-in-v22>`_.
+If you are updating from a previous version of this SDK, see "Important changes since v2.2.0" below.
 
 Installation using Pip (recommended):
 -------------------------------------
@@ -22,7 +21,7 @@ http://www.pip-installer.org/en/latest/
 Add the ``opentok`` package as a dependency in your project. The most common way is to add it to your
 ``requirements.txt`` file::
 
-  opentok>=2.2.0
+  opentok>=2.2.1
 
 Next, install the dependencies::
 
@@ -55,12 +54,12 @@ as a database).
 
 .. code:: python
 
-  # Just a plain Session:
-  session = opentok.create_session()
-  # A Session that attempts to send streams directly between clients (falling back
+  # Create a session that attempts to send streams directly between clients (falling back
   # to use the OpenTok TURN server to relay streams if the clients cannot connect):
-  session = opentok.create_session(media_mode=MediaModes.relayed)
-  # A Session with a location hint
+  session = opentok.create_session()
+  # A session that uses the OpenTok Media Router:
+  session = opentok.create_session(media_mode=MediaModes.routed)
+  # A session with a location hint
   session = opentok.create_session(location=u'12.34.56.78')
 
   # Store this session ID in the database
@@ -177,8 +176,18 @@ Release Notes
 See the `Releases <https://github.com/opentok/Opentok-Python-SDK/releases>`_ page for details about
 each release.
 
-Important changes in v2.2
--------------------------
+Important changes since v2.2
+----------------------------
+
+**Changes in v2.2.1:**
+
+The default setting for the create_session() method is to create a session with the media mode set
+to relayed. In previous versions of the SDK, the default setting was to use the OpenTok Media Router
+(media mode set to routed). In a relayed session, clients will attempt to send streams directly
+between each other (peer-to-peer); if clients cannot connect due to firewall restrictions, the
+session uses the OpenTok TURN server to relay audio-video streams.
+
+**Changes in v2.2.0:**
 
 This version of the SDK includes support for working with OpenTok 2.0 archives. (This API does not
 work with OpenTok 1.0 archives.)

docs/docs/opentok.html

@@ -75,11 +75,13 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this
 <li><strong>status</strong> &#8211; <p>The status of the archive, which can be one of the following:</p>
 <ul>
 <li>&#8220;available&#8221; &#8211; The archive is available for download from the OpenTok cloud.</li>
+<li>&#8220;expired&#8221; &#8211; The archive is no longer available for download from the OpenTok cloud.</li>
 <li>&#8220;failed&#8221; &#8211; The archive recording failed.</li>
 <li>&#8220;started&#8221; &#8211; The archive started and is in the process of being recorded.</li>
 <li>&#8220;stopped&#8221; &#8211; The archive stopped recording.</li>
 <li>&#8220;uploaded&#8221; &#8211; The archive is available for download from the the upload target
-S3 bucket.</li>
+Amazon S3 bucket or Windows Azure container that you set at the
+<a class="reference external" href="https://dashboard.tokbox.com">OpenTok dashboard</a>.</li>
 </ul>
 </li>
 <li><strong>url</strong> &#8211; The download URL of the available MP4 file. This is only set for an archive with the status set to
@@ -235,7 +237,7 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this
 
 <dl class="method">
 <dt id="opentok.opentok.OpenTok.create_session">
-<tt class="descname">create_session</tt><big>(</big><em>location=None</em>, <em>media_mode=u'disabled'</em><big>)</big><a class="headerlink" href="#opentok.opentok.OpenTok.create_session" title="Permalink to this definition">¶</a></dt>
+<tt class="descname">create_session</tt><big>(</big><em>location=None</em>, <em>media_mode=u'enabled'</em><big>)</big><a class="headerlink" href="#opentok.opentok.OpenTok.create_session" title="Permalink to this definition">¶</a></dt>
 <dd><p>Creates a new OpenTok session and returns the session ID, which uniquely identifies
 the session.</p>
 <p>For example, when using the OpenTok JavaScript library, use the session ID when calling the
@@ -414,7 +416,8 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this
 <p>Clients must be actively connected to the OpenTok session for you to successfully start
 recording an archive.</p>
 <p>You can only record one archive at a time for a given session. You can only record archives
-of OpenTok server-enabled sessions; you cannot archive peer-to-peer sessions.</p>
+of sessions that use the OpenTok Media Router (sessions witht the media mode set to routed);
+you cannot archive sessions witht the media mode set to relayed.</p>
 <table class="docutils field-list" frame="void" rules="none">
 <col class="field-name" />
 <col class="field-body" />