opentok 2.2.4 → 2.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5cee4e37d52a813e5b61449188d03d0a679ab00a
-  data.tar.gz: bcfd00abc717c38236c0358375616c1947d35698
+  metadata.gz: 3c7ab13d69f3ada792acd0b12de334447a368562
+  data.tar.gz: 486244b6bc125f6ff67bc6057c50627905705210
 SHA512:
-  metadata.gz: 85739d5bb678e7af843692b30ace91d862552a8b749031bd35991415a9b0cf806d0daf79a381e03558baec66ff10071e012400294595df31fa88692a04c7e2f7
-  data.tar.gz: a85cdc9408a6df9babe9507ba71c001eae8c7a37de6a41211a0e96473b3ee0da1df25cce92e4aa292f914e6a3a37aed90f22bfdaab16847f5606df29b148b6b7
+  metadata.gz: 470a8d8ca01f754f8c73370173f73d1a83908aee2220fd19970a5ad3e1172212cad967413c230d40699bd0edd443e4afd0bc8847abc2c56cfad143bed229466a
+  data.tar.gz: 7d1382c8466a7b03411186904c2b3f6c7de085bff320d3bb14afbd0ad3b1163b148fa6edfada9d25dcb3670a9a77b4ef89f30a6c03e118915fa47776c7e0b027

data/README.md

@@ -6,10 +6,7 @@ The OpenTok Ruby SDK lets you generate
 [sessions](http://www.tokbox.com/opentok/tutorials/create-session/) and
 [tokens](http://www.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 since v2.2.0](#important-changes-since-v220).
+[archive](https://tokbox.com/opentok/tutorials/archiving) OpenTok sessions.
 
 # Installation
 
@@ -20,7 +17,7 @@ Bundler helps manage dependencies for Ruby projects. Find more info here: <http:
 Add this gem to your `Gemfile`:
 
 ```ruby
-gem "opentok", "~> 2.2"
+gem "opentok", "~> 2.3"
 ```
 
 Allow bundler to install the change.
@@ -32,7 +29,7 @@ $ bundle install
 ## RubyGems:
 
 ```
-$ gem install opentok -v 2.2.2
+$ gem install opentok -v 2.2.4
 ```
 
 # Usage
@@ -50,10 +47,11 @@ opentok = OpenTok::OpenTok.new api_key, api_secret
 
 ## Creating Sessions
 
-To create an OpenTok Session, use the `OpenTok.create_session(properties)` method. The
-`properties` parameter is an optional Hash used to specify whether you are creating a p2p Session
-and specifying a location hint. The `session_id` method of the returned `OpenTok::Session`
-instance is useful to get a sessionId that can be saved to a persistent store (e.g. database).
+To create an OpenTok Session, use the `OpenTok#create_session(properties)` method. The
+`properties` parameter is an optional Hash used to specify whether you are creating a session that
+uses the OpenTok Media Server and specifying a location hint. The `session_id` method of the
+returned `OpenTok::Session` instance is useful to get a sessionId that can be saved to a persistent
+store (e.g. database).
 
 ```ruby
 # Create a session that will attempt to transmit streams directly between clients.
@@ -66,6 +64,9 @@ session = opentok.create_session :media_mode => :routed
 # A session with a location hint:
 session = opentok.create_session :location => '12.34.56.78'
 
+# A session with automatic archiving (must use the routed media mode):
+session = opentok.create_session :archive_mode => :always, :media_mode => :routed
+
 # Store this sessionId in the database for later use:
 session_id = session.session_id
 ```
@@ -74,7 +75,7 @@ session_id = session.session_id
 
 Once a Session is created, you can start generating Tokens for clients to use when connecting to it.
 You can generate a token either by calling the `opentok.generate_token(session_id, options)` method,
-or by calling the `session.generate_token(options)` method on the an instance after creating it. The
+or by calling the `Session#generate_token(options)` method on the an instance after creating it. The
 `options` parameter is an optional Hash used to set the role, expire time, and connection data of
 the Token.
 
@@ -97,22 +98,40 @@ token = session.generate_token({
 
 You can start the recording of an OpenTok Session using the `opentok.archives.create(session_id,
 options)` method. This will return an `OpenTok::Archive` instance. The parameter `options` is an
-optional Hash used to assign a name for the Archive. Note that you can only start an
-Archive on a Session that has clients connected.
+optional Hash used to set the `has_audio`, `has_video`, and `name` options. Note that you can
+only start an Archive on a Session that has clients connected.
 
 ```ruby
+# Create an Archive
+archive = opentok.archives.create session_id
+
+# Create a named Archive
 archive = opentok.archives.create session_id :name => "Important Presentation"
 
+# Create an audio-only Archive
+archive = opentok.archives.create session_id :has_video => false
+
 # Store this archive_id in the database for later use
 archive_id = archive.id
 ```
 
+Setting the `:output_mode` option to `:individual` setting causes each stream in the archive
+to be recorded to its own individual file:
+
+```ruby
+archive = opentok.archives.create session_id :output_mode => :individual
+```
+
+The `:output_mode => :composed` setting (the default) causes all streams in the archive to be
+recorded to a single (composed) file.
+
 You can stop the recording of a started Archive using the `opentok.archives.stop_by_id(archive_id)`
-method. You can also do this using the `archive.stop` method of the `OpenTok::Archive` instance.
+method. You can also do this using the `Archive#stop()` method.
 
 ```ruby
 # Stop an Archive from an archive_id (fetched from database)
 opentok.archives.stop_by_id archive_id
+
 # Stop an Archive from an instance (returned from opentok.archives.create)
 archive.stop
 ```
@@ -130,6 +149,7 @@ To delete an Archive, you can call the `opentok.archives.delete_by_id(archive_id
 ```ruby
 # Delete an Archive from an archive_id (fetched from database)
 opentok.archives.delete_by_id archive_id
+
 # Delete an Archive from an Archive instance (returned from archives.create, archives.find)
 archive.delete
 ```
@@ -144,10 +164,18 @@ archive_list = opentok.archives.all
 
 # Get an specific Archive from the list
 archive_list[i]
+
 # Get the total number of Archives for this API Key
 $total = archive_list.total
 ```
 
+Note that you can also create an automatically archived session, by passing in `:always`
+as the `:archive_mode` property of the `options` parameter passed into the
+`OpenTok#create_session()` method (see "Creating Sessions," above).
+
+For more information on archiving, see the
+[OpenTok archiving](https://tokbox.com/opentok/tutorials/archiving/) programming guide.
+
 # Samples
 
 There are two sample applications included in this repository. To get going as fast as possible, clone the whole
@@ -184,8 +212,7 @@ 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.)
+This version of the SDK includes support for working with OpenTok archives.
 
 Note also that the `options` parameter of the `OpenTok.create_session()` method has a `media_mode`
 property instead of a `p2p` property.
@@ -202,7 +229,7 @@ Interested in contributing? We :heart: pull requests! See the [Development](DEVE
 
 # Support
 
-See <http://tokbox.com/opentok/support/> for all our support options.
+See <https://support.tokbox.com> for all our support options.
 
 Find a bug? File it on the [Issues](https://github.com/opentok/opentok-ruby-sdk/issues) page. Hint:
 test cases are really helpful!

data/doc/OpenTok.html

@@ -6,7 +6,7 @@
 <title>
   Module: OpenTok
   
-    &mdash; Documentation by YARD 0.8.7.4
+    &mdash; Documentation by YARD 0.8.7.6
   
 </title>
 
@@ -80,7 +80,7 @@
   
     <dt class="r1 last">Defined in:</dt>
     <dd class="r1 last">lib/opentok.rb<span class="defines">,<br />
-  lib/opentok/client.rb,<br /> lib/opentok/session.rb,<br /> lib/opentok/version.rb,<br /> lib/opentok/opentok.rb,<br /> lib/opentok/archive.rb,<br /> lib/opentok/archives.rb,<br /> lib/opentok/constants.rb,<br /> lib/opentok/exceptions.rb,<br /> lib/opentok/archive_list.rb,<br /> lib/opentok/token_generator.rb</span>
+  lib/opentok/client.rb,<br /> lib/opentok/session.rb,<br /> lib/opentok/version.rb,<br /> lib/opentok/archive.rb,<br /> lib/opentok/opentok.rb,<br /> lib/extensions/hash.rb,<br /> lib/opentok/archives.rb,<br /> lib/opentok/constants.rb,<br /> lib/opentok/exceptions.rb,<br /> lib/opentok/archive_list.rb,<br /> lib/opentok/token_generator.rb</span>
 </dd>
   
 </dl>
@@ -101,6 +101,8 @@
 <p class="children">
   
     
+      <strong class="modules">Modules:</strong> <span class='object_link'><a href="OpenTok/HashExtensions.html" title="OpenTok::HashExtensions (module)">HashExtensions</a></span>
+    
   
     
       <strong class="classes">Classes:</strong> <span class='object_link'><a href="OpenTok/Archive.html" title="OpenTok::Archive (class)">Archive</a></span>, <span class='object_link'><a href="OpenTok/ArchiveList.html" title="OpenTok::ArchiveList (class)">ArchiveList</a></span>, <span class='object_link'><a href="OpenTok/Archives.html" title="OpenTok::Archives (class)">Archives</a></span>, <span class='object_link'><a href="OpenTok/OpenTok.html" title="OpenTok::OpenTok (class)">OpenTok</a></span>, <span class='object_link'><a href="OpenTok/OpenTokArchiveError.html" title="OpenTok::OpenTokArchiveError (class)">OpenTokArchiveError</a></span>, <span class='object_link'><a href="OpenTok/OpenTokAuthenticationError.html" title="OpenTok::OpenTokAuthenticationError (class)">OpenTokAuthenticationError</a></span>, <span class='object_link'><a href="OpenTok/OpenTokError.html" title="OpenTok::OpenTokError (class)">OpenTokError</a></span>, <span class='object_link'><a href="OpenTok/Session.html" title="OpenTok::Session (class)">Session</a></span>
@@ -127,6 +129,11 @@
         </dt>
         <dd><pre class="code"><span class='lbrace'>{</span> <span class='label'>subscriber:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>subscriber</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='label'>publisher:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>publisher</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='label'>moderator:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>moderator</span><span class='tstring_end'>&quot;</span></span> <span class='rbrace'>}</span></pre></dd>
       
+        <dt id="ARCHIVE_MODES-constant" class="">ARCHIVE_MODES =
+          
+        </dt>
+        <dd><pre class="code"><span class='const'>Set</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='lbracket'>[</span><span class='symbol'>:manual</span><span class='comma'>,</span> <span class='symbol'>:always</span><span class='rbracket'>]</span><span class='rparen'>)</span></pre></dd>
+      
     </dl>
   
 
@@ -200,7 +207,7 @@
   
     <li>
       
-        <span class='name'>sessioin_id</span>
+        <span class='name'>session_id</span>
       
       
         <span class='type'>(<tt>String</tt>)</span>
@@ -240,7 +247,7 @@
       
         <li>
           <span class="name">:role</span>
-          <span class="type">(<tt>String</tt>)</span>
+          <span class="type">(<tt>Symbol</tt>)</span>
           <span class="default">
             
           </span>
@@ -322,9 +329,6 @@ cannot be updated once it is set.</p>
       <pre class="lines">
 
 
-43
-44
-45
 46
 47
 48
@@ -354,10 +358,13 @@ cannot be updated once it is set.</p>
 72
 73
 74
-75</pre>
+75
+76
+77
+78</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/opentok/session.rb', line 43</span>
+      <pre class="code"><span class="info file"># File 'lib/opentok/session.rb', line 46</span>
 
 <span class='kw'>class</span> <span class='const'>Session</span>
 
@@ -368,7 +375,7 @@ cannot be updated once it is set.</p>
     <span class='symbol'>:session_id</span> <span class='op'>=&gt;</span> <span class='tlambda'>-&gt;</span><span class='lparen'>(</span><span class='id identifier rubyid_instance'>instance</span><span class='rparen'>)</span> <span class='tlambeg'>{</span> <span class='id identifier rubyid_instance'>instance</span><span class='period'>.</span><span class='id identifier rubyid_session_id'>session_id</span> <span class='rbrace'>}</span>
   <span class='rbrace'>}</span><span class='rparen'>)</span>
 
-  <span class='id identifier rubyid_attr_reader'>attr_reader</span> <span class='symbol'>:session_id</span><span class='comma'>,</span> <span class='symbol'>:media_mode</span><span class='comma'>,</span> <span class='symbol'>:location</span><span class='comma'>,</span> <span class='symbol'>:api_key</span><span class='comma'>,</span> <span class='symbol'>:api_secret</span>
+  <span class='id identifier rubyid_attr_reader'>attr_reader</span> <span class='symbol'>:session_id</span><span class='comma'>,</span> <span class='symbol'>:media_mode</span><span class='comma'>,</span> <span class='symbol'>:location</span><span class='comma'>,</span> <span class='symbol'>:archive_mode</span><span class='comma'>,</span> <span class='symbol'>:api_key</span><span class='comma'>,</span> <span class='symbol'>:api_secret</span>
 
   <span class='comment'># @private
 </span>  <span class='comment'># this implementation doesn't completely understand the format of a Session ID
@@ -384,7 +391,7 @@ cannot be updated once it is set.</p>
   <span class='comment'># @private
 </span>  <span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_api_key'>api_key</span><span class='comma'>,</span> <span class='id identifier rubyid_api_secret'>api_secret</span><span class='comma'>,</span> <span class='id identifier rubyid_session_id'>session_id</span><span class='comma'>,</span> <span class='id identifier rubyid_opts'>opts</span><span class='op'>=</span><span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
     <span class='ivar'>@api_key</span><span class='comma'>,</span> <span class='ivar'>@api_secret</span><span class='comma'>,</span> <span class='ivar'>@session_id</span> <span class='op'>=</span> <span class='id identifier rubyid_api_key'>api_key</span><span class='comma'>,</span> <span class='id identifier rubyid_api_secret'>api_secret</span><span class='comma'>,</span> <span class='id identifier rubyid_session_id'>session_id</span>
-    <span class='ivar'>@media_mode</span><span class='comma'>,</span> <span class='ivar'>@location</span> <span class='op'>=</span> <span class='id identifier rubyid_opts'>opts</span><span class='period'>.</span><span class='id identifier rubyid_fetch'>fetch</span><span class='lparen'>(</span><span class='symbol'>:media_mode</span><span class='comma'>,</span> <span class='symbol'>:relayed</span><span class='rparen'>)</span><span class='comma'>,</span> <span class='id identifier rubyid_opts'>opts</span><span class='lbracket'>[</span><span class='symbol'>:location</span><span class='rbracket'>]</span>
+    <span class='ivar'>@media_mode</span><span class='comma'>,</span> <span class='ivar'>@location</span><span class='comma'>,</span> <span class='ivar'>@archive_mode</span> <span class='op'>=</span> <span class='id identifier rubyid_opts'>opts</span><span class='period'>.</span><span class='id identifier rubyid_fetch'>fetch</span><span class='lparen'>(</span><span class='symbol'>:media_mode</span><span class='comma'>,</span> <span class='symbol'>:relayed</span><span class='rparen'>)</span><span class='comma'>,</span> <span class='id identifier rubyid_opts'>opts</span><span class='lbracket'>[</span><span class='symbol'>:location</span><span class='rbracket'>]</span><span class='comma'>,</span> <span class='id identifier rubyid_opts'>opts</span><span class='period'>.</span><span class='id identifier rubyid_fetch'>fetch</span><span class='lparen'>(</span><span class='symbol'>:archive_mode</span><span class='comma'>,</span> <span class='symbol'>:manual</span><span class='rparen'>)</span>
   <span class='kw'>end</span>
 
   <span class='comment'># @private
@@ -402,9 +409,9 @@ cannot be updated once it is set.</p>
 </div>
 
     <div id="footer">
-  Generated on Fri Jun 20 12:49:10 2014 by
+  Generated on Mon May 25 15:52:46 2015 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
-  0.8.7.4 (ruby-1.9.3).
+  0.8.7.6 (ruby-1.9.3).
 </div>
 
   </body>

data/doc/OpenTok/Archive.html

@@ -6,7 +6,7 @@
 <title>
   Class: OpenTok::Archive
   
-    &mdash; Documentation by YARD 0.8.7.4
+    &mdash; Documentation by YARD 0.8.7.6
   
 </title>
 
@@ -169,6 +169,60 @@ epoch.</p>
 <p>The duration of the archive, in milliseconds.</p>
 </div></span>
   
+</li>
+
+    
+      <li class="public ">
+  <span class="summary_signature">
+    
+      <a href="#has_audio-instance_method" title="#has_audio (instance method)">- (true, false) <strong>has_audio</strong> </a>
+    
+
+    
+  </span>
+  
+  
+  
+    
+    
+  
+  
+  
+  
+  
+
+  
+    <span class="summary_desc"><div class='inline'>
+<p>Whether the archive has an audio track (true) or not (false).</p>
+</div></span>
+  
+</li>
+
+    
+      <li class="public ">
+  <span class="summary_signature">
+    
+      <a href="#has_video-instance_method" title="#has_video (instance method)">- (true, false) <strong>has_video</strong> </a>
+    
+
+    
+  </span>
+  
+  
+  
+    
+    
+  
+  
+  
+  
+  
+
+  
+    <span class="summary_desc"><div class='inline'>
+<p>Whether the archive has a video track (true) or not (false).</p>
+</div></span>
+  
 </li>
 
     
@@ -223,6 +277,34 @@ epoch.</p>
 <p>The name of the archive.</p>
 </div></span>
   
+</li>
+
+    
+      <li class="public ">
+  <span class="summary_signature">
+    
+      <a href="#output_mode-instance_method" title="#output_mode (instance method)">- (String) <strong>output_mode</strong> </a>
+    
+
+    
+  </span>
+  
+  
+  
+    
+    
+  
+  
+  
+  
+  
+
+  
+    <span class="summary_desc"><div class='inline'>
+<p>Whether all streams in the archive are recorded to a single file
+(:composed) or to individual files (:individual).</p>
+</div></span>
+  
 </li>
 
     
@@ -499,24 +581,32 @@ exceeded", "failure", "session ended", or "user initiated".</p>
       <pre class="lines">
 
 
-84
-85
-86
-87
-88
-89
-90
-91
-92</pre>
+100
+101
+102
+103
+104
+105
+106
+107
+108
+109
+110
+111
+112</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/opentok/archive.rb', line 84</span>
+      <pre class="code"><span class="info file"># File 'lib/opentok/archive.rb', line 100</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_method_missing'>method_missing</span><span class='lparen'>(</span><span class='id identifier rubyid_method'>method</span><span class='comma'>,</span> <span class='op'>*</span><span class='id identifier rubyid_args'>args</span><span class='comma'>,</span> <span class='op'>&amp;</span><span class='id identifier rubyid_block'>block</span><span class='rparen'>)</span>
   <span class='id identifier rubyid_camelized_method'>camelized_method</span> <span class='op'>=</span> <span class='id identifier rubyid_method'>method</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span><span class='period'>.</span><span class='id identifier rubyid_camelize'>camelize</span><span class='lparen'>(</span><span class='symbol'>:lower</span><span class='rparen'>)</span>
   <span class='kw'>if</span> <span class='ivar'>@json</span><span class='period'>.</span><span class='id identifier rubyid_has_key?'>has_key?</span> <span class='id identifier rubyid_camelized_method'>camelized_method</span> <span class='kw'>and</span> <span class='id identifier rubyid_args'>args</span><span class='period'>.</span><span class='id identifier rubyid_empty?'>empty?</span>
     <span class='comment'># TODO: convert create_time method call to a Time object
-</span>    <span class='ivar'>@json</span><span class='lbracket'>[</span><span class='id identifier rubyid_camelized_method'>camelized_method</span><span class='rbracket'>]</span>
+</span>    <span class='kw'>if</span> <span class='id identifier rubyid_camelized_method'>camelized_method</span> <span class='op'>==</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>outputMode</span><span class='tstring_end'>'</span></span>
+      <span class='ivar'>@json</span><span class='lbracket'>[</span><span class='id identifier rubyid_camelized_method'>camelized_method</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_to_sym'>to_sym</span>
+    <span class='kw'>else</span>
+      <span class='ivar'>@json</span><span class='lbracket'>[</span><span class='id identifier rubyid_camelized_method'>camelized_method</span><span class='rbracket'>]</span>
+    <span class='kw'>end</span>
   <span class='kw'>else</span>
     <span class='kw'>super</span> <span class='id identifier rubyid_method'>method</span><span class='comma'>,</span> <span class='op'>*</span><span class='id identifier rubyid_args'>args</span><span class='comma'>,</span> <span class='op'>&amp;</span><span class='id identifier rubyid_block'>block</span>
   <span class='kw'>end</span>
@@ -578,12 +668,12 @@ epoch.</p>
       <pre class="lines">
 
 
-50
-51
-52</pre>
+66
+67
+68</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/opentok/archive.rb', line 50</span>
+      <pre class="code"><span class="info file"># File 'lib/opentok/archive.rb', line 66</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_created_at'>created_at</span>
   <span class='ivar'>@created_at</span>
@@ -639,12 +729,12 @@ epoch.</p>
       <pre class="lines">
 
 
-50
-51
-52</pre>
+66
+67
+68</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/opentok/archive.rb', line 50</span>
+      <pre class="code"><span class="info file"># File 'lib/opentok/archive.rb', line 66</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_duration'>duration</span>
   <span class='ivar'>@duration</span>
@@ -655,6 +745,128 @@ epoch.</p>
 </div>
     
       
+      <span id="has_audio=-instance_method"></span>
+      <div class="method_details ">
+  <h3 class="signature " id="has_audio-instance_method">
+  
+    - (<tt>true</tt>, <tt>false</tt>) <strong>has_audio</strong> 
+  
+
+  
+
+  
+</h3><div class="docstring">
+  <div class="discussion">
+    
+<p>Whether the archive has an audio track (true) or not (false).</p>
+
+
+  </div>
+</div>
+<div class="tags">
+  
+<p class="tag_title">Returns:</p>
+<ul class="return">
+  
+    <li>
+      
+      
+        <span class='type'>(<tt>true</tt>, <tt>false</tt>)</span>
+      
+      
+      
+        &mdash;
+        <div class='inline'>
+<p>the current value of has_audio</p>
+</div>
+      
+    </li>
+  
+</ul>
+
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+
+
+66
+67
+68</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/opentok/archive.rb', line 66</span>
+
+<span class='kw'>def</span> <span class='id identifier rubyid_has_audio'>has_audio</span>
+  <span class='ivar'>@has_audio</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+    
+      
+      <span id="has_video=-instance_method"></span>
+      <div class="method_details ">
+  <h3 class="signature " id="has_video-instance_method">
+  
+    - (<tt>true</tt>, <tt>false</tt>) <strong>has_video</strong> 
+  
+
+  
+
+  
+</h3><div class="docstring">
+  <div class="discussion">
+    
+<p>Whether the archive has a video track (true) or not (false).</p>
+
+
+  </div>
+</div>
+<div class="tags">
+  
+<p class="tag_title">Returns:</p>
+<ul class="return">
+  
+    <li>
+      
+      
+        <span class='type'>(<tt>true</tt>, <tt>false</tt>)</span>
+      
+      
+      
+        &mdash;
+        <div class='inline'>
+<p>the current value of has_video</p>
+</div>
+      
+    </li>
+  
+</ul>
+
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+
+
+66
+67
+68</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/opentok/archive.rb', line 66</span>
+
+<span class='kw'>def</span> <span class='id identifier rubyid_has_video'>has_video</span>
+  <span class='ivar'>@has_video</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+    
+      
       <span id="id=-instance_method"></span>
       <div class="method_details ">
   <h3 class="signature " id="id-instance_method">
@@ -700,12 +912,12 @@ epoch.</p>
       <pre class="lines">
 
 
-50
-51
-52</pre>
+66
+67
+68</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/opentok/archive.rb', line 50</span>
+      <pre class="code"><span class="info file"># File 'lib/opentok/archive.rb', line 66</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_id'>id</span>
   <span class='ivar'>@id</span>
@@ -762,12 +974,12 @@ created, this is set to null.</p>
       <pre class="lines">
 
 
-50
-51
-52</pre>
+66
+67
+68</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/opentok/archive.rb', line 50</span>
+      <pre class="code"><span class="info file"># File 'lib/opentok/archive.rb', line 66</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_name'>name</span>
   <span class='ivar'>@name</span>
@@ -778,6 +990,68 @@ created, this is set to null.</p>
 </div>
     
       
+      <span id="output_mode=-instance_method"></span>
+      <div class="method_details ">
+  <h3 class="signature " id="output_mode-instance_method">
+  
+    - (<tt>String</tt>) <strong>output_mode</strong> 
+  
+
+  
+
+  
+</h3><div class="docstring">
+  <div class="discussion">
+    
+<p>Whether all streams in the archive are recorded to a single file
+(<tt>:composed</tt>) or to individual files (<tt>:individual</tt>).</p>
+
+
+  </div>
+</div>
+<div class="tags">
+  
+<p class="tag_title">Returns:</p>
+<ul class="return">
+  
+    <li>
+      
+      
+        <span class='type'>(<tt>String</tt>)</span>
+      
+      
+      
+        &mdash;
+        <div class='inline'>
+<p>the current value of output_mode</p>
+</div>
+      
+    </li>
+  
+</ul>
+
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+
+
+66
+67
+68</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/opentok/archive.rb', line 66</span>
+
+<span class='kw'>def</span> <span class='id identifier rubyid_output_mode'>output_mode</span>
+  <span class='ivar'>@output_mode</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+    
+      
       <span id="partner_id=-instance_method"></span>
       <div class="method_details ">
   <h3 class="signature " id="partner_id-instance_method">
@@ -823,12 +1097,12 @@ created, this is set to null.</p>
       <pre class="lines">
 
 
-50
-51
-52</pre>
+66
+67
+68</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/opentok/archive.rb', line 50</span>
+      <pre class="code"><span class="info file"># File 'lib/opentok/archive.rb', line 66</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_partner_id'>partner_id</span>
   <span class='ivar'>@partner_id</span>
@@ -886,12 +1160,12 @@ with the status "failed", this can be set to "system failure".</p>
       <pre class="lines">
 
 
-50
-51
-52</pre>
+66
+67
+68</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/opentok/archive.rb', line 50</span>
+      <pre class="code"><span class="info file"># File 'lib/opentok/archive.rb', line 66</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_reason'>reason</span>
   <span class='ivar'>@reason</span>
@@ -947,12 +1221,12 @@ with the status "failed", this can be set to "system failure".</p>
       <pre class="lines">
 
 
-50
-51
-52</pre>
+66
+67
+68</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/opentok/archive.rb', line 50</span>
+      <pre class="code"><span class="info file"># File 'lib/opentok/archive.rb', line 66</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_session_id'>session_id</span>
   <span class='ivar'>@session_id</span>
@@ -1009,12 +1283,12 @@ value is set to 0.</p>
       <pre class="lines">
 
 
-50
-51
-52</pre>
+66
+67
+68</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/opentok/archive.rb', line 50</span>
+      <pre class="code"><span class="info file"># File 'lib/opentok/archive.rb', line 66</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_size'>size</span>
   <span class='ivar'>@size</span>
@@ -1048,6 +1322,14 @@ OpenTok cloud.</p>
 </li><li>
 <p>"failed" -- The archive recording failed.</p>
 </li><li>
+<p>"paused" -- The archive is in progress and no clients are publishing
+streams to the session. When an archive is in progress and any client
+publishes a stream, the status is "started". When an archive is paused,
+nothing is recorded. When a client starts publishing a stream, the
+recording starts (or resumes). If all clients disconnect from a session
+that is being archived, the status changes to "paused", and after 60
+seconds the archive recording stops (and the status changes to "stopped").</p>
+</li><li>
 <p>"started" -- The archive started and is in the process of being recorded.</p>
 </li><li>
 <p>"stopped" -- The archive stopped recording.</p>
@@ -1088,12 +1370,12 @@ href="https://dashboard.tokbox.com">dashboard.tokbox.com</a>).</p>
       <pre class="lines">
 
 
-50
-51
-52</pre>
+66
+67
+68</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/opentok/archive.rb', line 50</span>
+      <pre class="code"><span class="info file"># File 'lib/opentok/archive.rb', line 66</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_status'>status</span>
   <span class='ivar'>@status</span>
@@ -1154,12 +1436,12 @@ OpenTok.getArchive() method.</p>
       <pre class="lines">
 
 
-50
-51
-52</pre>
+66
+67
+68</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/opentok/archive.rb', line 50</span>
+      <pre class="code"><span class="info file"># File 'lib/opentok/archive.rb', line 66</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_url'>url</span>
   <span class='ivar'>@url</span>
@@ -1207,13 +1489,13 @@ making it unavailable for download.</p>
       <pre class="lines">
 
 
-78
-79
-80
-81</pre>
+94
+95
+96
+97</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/opentok/archive.rb', line 78</span>
+      <pre class="code"><span class="info file"># File 'lib/opentok/archive.rb', line 94</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_delete'>delete</span>
   <span class='comment'># TODO: validate returned json fits schema
@@ -1253,13 +1535,13 @@ have disconnected from the session being archived.</p>
       <pre class="lines">
 
 
-68
-69
-70
-71</pre>
+84
+85
+86
+87</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/opentok/archive.rb', line 68</span>
+      <pre class="code"><span class="info file"># File 'lib/opentok/archive.rb', line 84</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_stop'>stop</span>
   <span class='comment'># TODO: validate returned json fits schema
@@ -1296,12 +1578,12 @@ have disconnected from the session being archived.</p>
       <pre class="lines">
 
 
-60
-61
-62</pre>
+76
+77
+78</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/opentok/archive.rb', line 60</span>
+      <pre class="code"><span class="info file"># File 'lib/opentok/archive.rb', line 76</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_to_json'>to_json</span>
   <span class='ivar'>@json</span><span class='period'>.</span><span class='id identifier rubyid_to_json'>to_json</span>
@@ -1316,9 +1598,9 @@ have disconnected from the session being archived.</p>
 </div>
 
     <div id="footer">
-  Generated on Fri Jun 20 12:49:10 2014 by
+  Generated on Mon May 25 15:52:46 2015 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
-  0.8.7.4 (ruby-1.9.3).
+  0.8.7.6 (ruby-1.9.3).
 </div>
 
   </body>