Merge pull request #236 from opentok/dev

v4.4.0

Author: Manik Sachdeva

README.md

@@ -20,7 +20,7 @@ Add this package (`opentok/opentok`) to your `composer.json` file, or just run t
 command line:
 
 ```
-$ ./composer.phar require opentok/opentok 4.3.x
+$ ./composer.phar require opentok/opentok 4.4.x
 ```
 
 ### Manually:
@@ -255,16 +255,18 @@ You can only start live streaming broadcasts for sessions that use the OpenTok M
 Start the live streaming broadcast of an OpenTok Session using the
 `startBroadcast($sessionId, $options)` method of the `OpenTok\OpenTok` class.
 This will return an `OpenTok\Broadcast` instance. The `$options` parameter is
-an optional array used to assign a layout type for the broadcast.
+an optional array used to assign broadcast options such as layout, maxDuration, resolution, and more.
 
 ```php
 // Start a live streaming broadcast of a session
 $broadcast = $opentok->startBroadcast($sessionId);
 
 
-// Start a live streaming broadcast of a session, setting a layout type
+// Start a live streaming broadcast of a session, using broadcast options
 $options = array(
-    'layout' => Layout::getBestFit()
+    'layout' => Layout::getBestFit(),
+    'maxDuration' => 5400,
+    'resolution' => '1280x720'
 );
 $broadcast = $opentok->startBroadcast($sessionId, $options);
 

src/OpenTok/Broadcast.php

@@ -87,6 +87,9 @@ public function __get($name)
             case 'partnerId':
             case 'sessionId':
             case 'broadcastUrls':
+            case 'status':
+            case 'maxDuration':
+            case 'resolution':
                 return $this->data[$name];
                 break;
             case 'hlsUrl':

src/OpenTok/OpenTok.php

@@ -504,7 +504,7 @@ public function startBroadcast($sessionId, $options=array())
         $defaults = array(
             'layout' => Layout::getBestFit()
         );
-        $options = array_merge($defaults, array_intersect_key($options, $defaults));
+        $options = array_merge($defaults, $options);
         list($layout) = array_values($options);
 
         // validate arguments

src/OpenTok/Util/Client.php

@@ -38,7 +38,7 @@
 
 // TODO: build this dynamically
 /** @internal */
-define('OPENTOK_SDK_VERSION', '4.3.0');
+define('OPENTOK_SDK_VERSION', '4.4.0');
 /** @internal */
 define('OPENTOK_SDK_USER_AGENT', 'OpenTok-PHP-SDK/' . OPENTOK_SDK_VERSION);
 
@@ -280,13 +280,17 @@ public function startBroadcast($sessionId, $options)
             '/v2/project/'.$this->apiKey.'/broadcast'
         );
 
+        $optionsJson = [
+            'sessionId' => $sessionId,
+            'layout' => $options['layout']->jsonSerialize()
+        ];
+        unset($options['layout']);
+        $optionsJson = array_merge($optionsJson, $options);
+
         try {
             $response = $this->client->send($request, [
                 'debug' => $this->isDebug(),
-                'json' => [
-                    'sessionId' => $sessionId,
-                    'layout' => $options['layout']->jsonSerialize()
-                ]
+                'json' => $optionsJson
             ]);
             $broadcastJson = json_decode($response->getBody(), true);
         } catch (\Exception $e) {

tests/OpenTok/ArchiveTest.php

@@ -156,7 +156,7 @@ public function testStopsArchive()
         // TODO: test the dynamically built User Agent string
         $userAgent = $request->getHeaderLine('User-Agent');
         $this->assertNotEmpty($userAgent);
-        $this->assertStringStartsWith('OpenTok-PHP-SDK/4.3.0', $userAgent);
+        $this->assertStringStartsWith('OpenTok-PHP-SDK/4.4.0', $userAgent);
 
         // TODO: test the properties of the actual archive object
         $this->assertEquals('stopped', $this->archive->status);
@@ -195,7 +195,7 @@ public function testDeletesArchive()
         // TODO: test the dynamically built User Agent string
         $userAgent = $request->getHeaderLine('User-Agent');
         $this->assertNotEmpty($userAgent);
-        $this->assertStringStartsWith('OpenTok-PHP-SDK/4.3.0', $userAgent);
+        $this->assertStringStartsWith('OpenTok-PHP-SDK/4.4.0', $userAgent);
 
         $this->assertTrue($success);
         // TODO: assert that all properties of the archive object were cleared