Merge pull request #360 from opentok/archive-params

feat: added quantization parameter

Author: manchuck

composer.json

@@ -33,7 +33,7 @@
         "johnstevenson/json-works": "~1.1",
         "firebase/php-jwt": "^6.11",
         "guzzlehttp/guzzle": "~6.0|~7.0",
-      "ext-json": "*",
+        "ext-json": "*",
         "vonage/jwt": "^0.5.1"
     },
     "require-dev": {

src/OpenTok/Archive.php

@@ -136,6 +136,10 @@ public function __construct($archiveData, $options = array())
         Validators::validateClient($client);
         Validators::validateHasStreamMode($streamMode);
 
+        if (isset($archiveData['maxBitrate']) && isset($archiveData['quantizationParameter'])) {
+            throw new \DomainException('Max Bitrate cannot be set with QuantizationParameter ');
+        }
+
         $this->data = $archiveData;
 
         if (isset($this->data['multiArchiveTag'])) {
@@ -179,6 +183,7 @@ public function __get($name)
             case 'resolution':
             case 'streamMode':
             case 'maxBitrate':
+            case 'quantizationParameter':
                 return $this->data[$name];
             case 'multiArchiveTag':
                 return $this->multiArchiveTag;

src/OpenTok/OpenTok.php

@@ -887,6 +887,9 @@ public function disableForceMute(string $sessionId, array $options): bool
      *    <li><code>maxBitRate</code> &mdash; Max Bitrate allowed for the broadcast composing. Must be between
      *    400000 and 2000000.</li>
      *
+     *    <li><code>quantizationParameter</code> &mdash; quantization parameter (QP) is an optional video encoding
+     *    value allowed for composed archiving, smaller values generate higher quality and larger archives</li>
+     *
      *    <li><code>outputs</code> (Array) &mdash;
      *      Defines the HLS broadcast and RTMP streams. You can provide the following keys:
      *      <ul>

tests/OpenTokTest/ArchiveTest.php

@@ -30,7 +30,7 @@ public static function setUpBeforeClass(): void
         self::$mockBasePath = __DIR__ . DIRECTORY_SEPARATOR . '..' . DIRECTORY_SEPARATOR . 'mock' . DIRECTORY_SEPARATOR;
     }
 
-    public function setupArchives($streamMode)
+    public function setupArchives($streamMode, $quantization = false)
     {
         // Set up fixtures
         $this->archiveData = array(
@@ -49,9 +49,15 @@ public function setupArchives($streamMode)
             'outputMode' => 'composed',
             'resolution' => '640x480',
             'streamMode' => $streamMode,
-            'multiArchiveTag' => true
+            'multiArchiveTag' => true,
+            'maxBitrate' => 400000,
         );
 
+        if ($quantization) {
+            unset($this->archiveData['maxBitrate']);
+            $this->archiveData['quantizationParameter'] = 40;
+        }
+
         $this->archive = new Archive($this->archiveData, array(
             'apiKey' => $this->API_KEY,
             'apiSecret' => $this->API_SECRET,
@@ -127,6 +133,10 @@ public function testReadsProperties()
         $this->assertEquals($this->archiveData['resolution'], $this->archive->resolution);
         $this->assertEquals($this->archiveData['streamMode'], $this->archive->streamMode);
         $this->assertEquals($this->archiveData['multiArchiveTag'], $this->archive->multiArchiveTag);
+        $this->assertEquals($this->archiveData['maxBitrate'], $this->archive->maxBitrate);
+
+       $this->setupArchives(StreamMode::AUTO, true);
+       $this->assertEquals($this->archiveData['quantizationParameter'], $this->archive->quantizationParameter);
     }
 
     public function testStopsArchive()