v4.1.1 (#207)

* fixes start archive for individual stream

Author: Manik Sachdeva

README.md

@@ -120,7 +120,7 @@ You can only archive sessions that use the OpenTok Media Router
 You can start the recording of an OpenTok Session using the `startArchive($sessionId, $name)` method
 of the `OpenTok\OpenTok` class. This will return an `OpenTok\Archive` instance. The parameter
 `$archiveOptions` is an optional array and is used to assign a name, whether to record audio and/or
-video, and the desired output mode for the Archive. Note that you can only start an
+video, the desired output mode for the Archive, and the desired resolution if applicable. Note that you can only start an
 Archive on a Session that has clients connected.
 
 ```php
@@ -130,18 +130,19 @@ $archive = $opentok->startArchive($sessionId);
 
 // Create an archive using custom options
 $archiveOptions = array(
-    'name' => 'Important Presentation',     // default: null
-    'hasAudio' => true,                     // default: true
-    'hasVideo' => true,                     // default: true
-    'outputMode' => OutputMode::INDIVIDUAL  // default: OutputMode::COMPOSED
+    'name' => 'Important Presentation',      // default: null
+    'hasAudio' => true,                      // default: true
+    'hasVideo' => true,                      // default: true
+    'outputMode' => OutputMode::COMPOSED,    // default: OutputMode::COMPOSED
+    'resolution' => '1280x720'               // default: '640x480'
 );
 $archive = $opentok->startArchive($sessionId, $archiveOptions);
 
 // Store this archiveId in the database for later use
 $archiveId = $archive->id;
 ```
 
-Setting the output mode to `OutputMode::INDIVIDUAL` setting causes each stream in the archive to be recorded to its own individual file. The `OutputMode::COMPOSED` setting (the default) causes all streams in the archive to be recorded to a single (composed) file.
+If you set the `outputMode` option to `OutputMode::INDIVIDUAL`, it causes each stream in the archive to be recorded to its own individual file. Please note that you cannot specify the resolution when you set the `outputMode` option to `OutputMode::INDIVIDUAL`. The `OutputMode::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 `stopArchive($archiveId)` method of the
 `OpenTok\OpenTok` object. You can also do this using the `stop()` method of the

src/OpenTok/OpenTok.php

@@ -286,26 +286,36 @@ public function startArchive($sessionId, $options=array())
         if (!is_array($options)) {
             $options = array('name' => $options);
         }
-
+        
         // unpack optional arguments (merging with default values) into named variables
         $defaults = array(
             'name' => null,
             'hasVideo' => true,
             'hasAudio' => true,
             'outputMode' => OutputMode::COMPOSED,
-            'resolution' => '640x480'
+            'resolution' => null,
         );
         $options = array_merge($defaults, array_intersect_key($options, $defaults));
         list($name, $hasVideo, $hasAudio, $outputMode, $resolution) = array_values($options);
-
         // validate arguments
         Validators::validateSessionId($sessionId);
         Validators::validateArchiveName($name);
         Validators::validateArchiveHasVideo($hasVideo);
         Validators::validateArchiveHasAudio($hasAudio);
         Validators::validateArchiveOutputMode($outputMode);
-        Validators::validateArchiveResolution($resolution);
 
+        if ((is_null($resolution) || empty($resolution)) && $outputMode === OutputMode::COMPOSED) {
+            $options['resolution'] = "640x480";
+        } else if((is_null($resolution) || empty($resolution)) && $outputMode === OutputMode::INDIVIDUAL) {
+            unset($options['resolution']);
+        } else if(!empty($resolution) && $outputMode === OutputMode::INDIVIDUAL) {
+            $errorMessage = "Resolution can't be specified for Individual Archives";
+            throw new UnexpectedValueException($errorMessage);
+        } else if(!empty($resolution) && $outputMode === OutputMode::COMPOSED && !is_string($resolution)) {
+            $errorMessage = "Resolution must be a valid string";
+            throw new UnexpectedValueException($errorMessage);
+        }
+        // we don't validate the actual resolution so if we add resolutions, we don't artificially block functionality
         // make API call
         $archiveData = $this->client->startArchive($sessionId, $options);
 

src/OpenTok/Util/Validators.php

@@ -145,12 +145,6 @@ public static function validateArchiveOutputMode($outputMode)
             throw new InvalidArgumentException('Unknown output mode: '.print_r($outputMode, true));
         }
     }
-    public static function validateArchiveResolution($resolution)
-    {
-        if (!(is_string($resolution))) {
-            throw new InvalidArgumentException('The resolution must be a string: '.print_r($resolution, true));
-        }
-    }
     public static function validateArchiveId($archiveId)
     {
         if ( !is_string($archiveId) || preg_match(self::$guidRegEx, $archiveId) ) {