Merge pull request #60 from jeffswartz/archiving_updates_docs

Archiving updates docs

Author: aoberoi

README.rst

@@ -101,6 +101,16 @@ a Session that has clients connection.
   # Store this archive_id in the database
   archive_id = archive.id
 
+You can also disable audio or video recording by setting the `hasAudio` or `hasVideo` property of
+the `options` parameter to `false`:
+
+.. code:: python
+
+  archive = opentok.start_archive(session_id, name=u'Important Presentation', hasVideo=False)
+
+  # Store this archive_id in the database
+  archive_id = archive.id
+
 You can stop the recording of a started Archive using the ``opentok.stop_archive(archive_id)``
 method. You can also do this using the ``archive.stop()`` method of an ``Archive`` instance.
 

docs/README.html

@@ -125,6 +125,14 @@ <h3>Working with Archives<a class="headerlink" href="#working-with-archives" tit
 a Session that has clients connection.</p>
 <div class="code python highlight-python"><div class="highlight"><pre><span class="n">archive</span> <span class="o">=</span> <span class="n">opentok</span><span class="o">.</span><span class="n">start_archive</span><span class="p">(</span><span class="n">session_id</span><span class="p">,</span> <span class="n">name</span><span class="o">=</span><span class="s">u&#39;Important Presentation&#39;</span><span class="p">)</span>
 
+<span class="c"># Store this archive_id in the database</span>
+<span class="n">archive_id</span> <span class="o">=</span> <span class="n">archive</span><span class="o">.</span><span class="n">id</span>
+</pre></div>
+</div>
+<p>You can also disable audio or video recording by setting the <cite>hasAudio</cite> or <cite>hasVideo</cite> property of
+the <cite>options</cite> parameter to <cite>false</cite>:</p>
+<div class="code python highlight-python"><div class="highlight"><pre><span class="n">archive</span> <span class="o">=</span> <span class="n">opentok</span><span class="o">.</span><span class="n">start_archive</span><span class="p">(</span><span class="n">session_id</span><span class="p">,</span> <span class="n">name</span><span class="o">=</span><span class="s">u&#39;Important Presentation&#39;</span><span class="p">,</span> <span class="n">hasVideo</span><span class="o">=</span><span class="bp">False</span><span class="p">)</span>
+
 <span class="c"># Store this archive_id in the database</span>
 <span class="n">archive_id</span> <span class="o">=</span> <span class="n">archive</span><span class="o">.</span><span class="n">id</span>
 </pre></div>

docs/_sources/README.txt

@@ -101,6 +101,16 @@ a Session that has clients connection.
   # Store this archive_id in the database
   archive_id = archive.id
 
+You can also disable audio or video recording by setting the `hasAudio` or `hasVideo` property of
+the `options` parameter to `false`:
+
+.. code:: python
+
+  archive = opentok.start_archive(session_id, name=u'Important Presentation', hasVideo=False)
+
+  # Store this archive_id in the database
+  archive_id = archive.id
+
 You can stop the recording of a started Archive using the ``opentok.stop_archive(archive_id)``
 method. You can also do this using the ``archive.stop()`` method of an ``Archive`` instance.
 

docs/docs/opentok.html

@@ -63,6 +63,10 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this
 <tr class="field-odd field"><th class="field-name">Variables:</th><td class="field-body"><ul class="first last simple">
 <li><strong>created_at</strong> &#8211; The time at which the archive was created, in milliseconds since the UNIX epoch.</li>
 <li><strong>duration</strong> &#8211; The duration of the archive, in milliseconds.</li>
+<li><strong>hasAudio</strong> &#8211; Boolean value set to true when the archive contains an audio track,
+and set to false otherwise.</li>
+<li><strong>hasVideo</strong> &#8211; Boolean value set to true when the archive contains a video track,
+and set to false otherwise.</li>
 <li><strong>id</strong> &#8211; The archive ID.</li>
 <li><strong>name</strong> &#8211; The name of the archive. If no name was provided when the archive was created, this is set
 to null.</li>
@@ -192,20 +196,20 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this
 <span id="opentok-opentok-module"></span><h2>opentok.opentok module<a class="headerlink" href="#module-opentok.opentok" title="Permalink to this headline">¶</a></h2>
 <dl class="class">
 <dt id="opentok.opentok.MediaModes">
-<em class="property">class </em><tt class="descclassname">opentok.opentok.</tt><tt class="descname">MediaModes</tt><big>(</big><em>*keys</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#opentok.opentok.MediaModes" title="Permalink to this definition">¶</a></dt>
+<em class="property">class </em><tt class="descclassname">opentok.opentok.</tt><tt class="descname">MediaModes</tt><a class="headerlink" href="#opentok.opentok.MediaModes" title="Permalink to this definition">¶</a></dt>
 <dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">enum.Enum</span></tt></p>
 <p>List of valid settings for the mediaMode parameter of the OpenTok.createSession() method.</p>
 <dl class="attribute">
 <dt id="opentok.opentok.MediaModes.relayed">
-<tt class="descname">relayed</tt><em class="property"> = u'enabled'</em><a class="headerlink" href="#opentok.opentok.MediaModes.relayed" title="Permalink to this definition">¶</a></dt>
+<tt class="descname">relayed</tt><em class="property"> = None</em><a class="headerlink" href="#opentok.opentok.MediaModes.relayed" title="Permalink to this definition">¶</a></dt>
 <dd><p>The session will attempt to transmit streams directly between clients. If two clients
 cannot send and receive each others&#8217; streams, due to firewalls on the clients&#8217; networks,
 their streams will be relayed using the OpenTok TURN Server.</p>
 </dd></dl>
 
 <dl class="attribute">
 <dt id="opentok.opentok.MediaModes.routed">
-<tt class="descname">routed</tt><em class="property"> = u'disabled'</em><a class="headerlink" href="#opentok.opentok.MediaModes.routed" title="Permalink to this definition">¶</a></dt>
+<tt class="descname">routed</tt><em class="property"> = None</em><a class="headerlink" href="#opentok.opentok.MediaModes.routed" title="Permalink to this definition">¶</a></dt>
 <dd><p>The session will transmit streams using the OpenTok Media Server.</p>
 </dd></dl>
 
@@ -237,7 +241,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'enabled'</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=&lt;MediaModes.relayed: u'enabled'&gt;</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
@@ -315,7 +319,7 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this
 
 <dl class="method">
 <dt id="opentok.opentok.OpenTok.generate_token">
-<tt class="descname">generate_token</tt><big>(</big><em>session_id</em>, <em>role=u'publisher'</em>, <em>expire_time=None</em>, <em>data=None</em><big>)</big><a class="headerlink" href="#opentok.opentok.OpenTok.generate_token" title="Permalink to this definition">¶</a></dt>
+<tt class="descname">generate_token</tt><big>(</big><em>session_id</em>, <em>role=&lt;Roles.publisher: u'publisher'&gt;</em>, <em>expire_time=None</em>, <em>data=None</em><big>)</big><a class="headerlink" href="#opentok.opentok.OpenTok.generate_token" title="Permalink to this definition">¶</a></dt>
 <dd><p>Generates a token for a given session.</p>
 <table class="docutils field-list" frame="void" rules="none">
 <col class="field-name" />
@@ -408,7 +412,7 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this
 
 <dl class="method">
 <dt id="opentok.opentok.OpenTok.start_archive">
-<tt class="descname">start_archive</tt><big>(</big><em>session_id</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#opentok.opentok.OpenTok.start_archive" title="Permalink to this definition">¶</a></dt>
+<tt class="descname">start_archive</tt><big>(</big><em>session_id</em>, <em>hasAudio=True</em>, <em>hasVideo=True</em>, <em>name=None</em><big>)</big><a class="headerlink" href="#opentok.opentok.OpenTok.start_archive" title="Permalink to this definition">¶</a></dt>
 <dd><p>Starts archiving an OpenTok 2.0 session.</p>
 <p>Clients must be actively connected to the OpenTok session for you to successfully start
 recording an archive.</p>
@@ -424,6 +428,12 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this
 <li><strong>name</strong> (<em>String</em>) &#8211; This is the name of the archive. You can use this name
 to identify the archive. It is a property of the Archive object, and it is a property
 of archive-related events in the OpenTok.js library.</li>
+<li><strong>hasAudio</strong> (<em>Boolean</em>) &#8211; if set to True, an audio track will be inserted to the archive. 
+hasAudio is an optional parameter that is set to True by default. If you set both  
+hasAudio and hasVideo to False, the call to the start_archive() method results in
+an error.</li>
+<li><strong>hasVideo</strong> (<em>Boolean</em>) &#8211; if set to True, a video track will be inserted to the archive. 
+hasVideo is an optional parameter that is set to True by default.</li>
 </ul>
 </td>
 </tr>
@@ -456,26 +466,26 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this
 
 <dl class="class">
 <dt id="opentok.opentok.Roles">
-<em class="property">class </em><tt class="descclassname">opentok.opentok.</tt><tt class="descname">Roles</tt><big>(</big><em>*keys</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#opentok.opentok.Roles" title="Permalink to this definition">¶</a></dt>
+<em class="property">class </em><tt class="descclassname">opentok.opentok.</tt><tt class="descname">Roles</tt><a class="headerlink" href="#opentok.opentok.Roles" title="Permalink to this definition">¶</a></dt>
 <dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">enum.Enum</span></tt></p>
 <p>List of valid roles for a token.</p>
 <dl class="attribute">
 <dt id="opentok.opentok.Roles.moderator">
-<tt class="descname">moderator</tt><em class="property"> = u'moderator'</em><a class="headerlink" href="#opentok.opentok.Roles.moderator" title="Permalink to this definition">¶</a></dt>
+<tt class="descname">moderator</tt><em class="property"> = None</em><a class="headerlink" href="#opentok.opentok.Roles.moderator" title="Permalink to this definition">¶</a></dt>
 <dd><p>In addition to the privileges granted to a publisher, in clients using the OpenTok.js 2.2
 library, a moderator can call the <cite>forceUnpublish()</cite> and <cite>forceDisconnect()</cite> method of the
 Session object.</p>
 </dd></dl>
 
 <dl class="attribute">
 <dt id="opentok.opentok.Roles.publisher">
-<tt class="descname">publisher</tt><em class="property"> = u'publisher'</em><a class="headerlink" href="#opentok.opentok.Roles.publisher" title="Permalink to this definition">¶</a></dt>
+<tt class="descname">publisher</tt><em class="property"> = None</em><a class="headerlink" href="#opentok.opentok.Roles.publisher" title="Permalink to this definition">¶</a></dt>
 <dd><p>A publisher can publish streams, subscribe to streams, and signal</p>
 </dd></dl>
 
 <dl class="attribute">
 <dt id="opentok.opentok.Roles.subscriber">
-<tt class="descname">subscriber</tt><em class="property"> = u'subscriber'</em><a class="headerlink" href="#opentok.opentok.Roles.subscriber" title="Permalink to this definition">¶</a></dt>
+<tt class="descname">subscriber</tt><em class="property"> = None</em><a class="headerlink" href="#opentok.opentok.Roles.subscriber" title="Permalink to this definition">¶</a></dt>
 <dd><p>A subscriber can only subscribe to streams.</p>
 </dd></dl>