Updated code sample for start_encode2

1) Changed status getting logic (replacing status_url with value from
previous call)
2) Added QencodeClientException
3) Added support for Destination permissions and storage_class fields

Author: NikitaYeryomin

autoload.php

@@ -2,6 +2,7 @@
 $files = array(
     "Exceptions/QencodeException.php",
     "Exceptions/QencodeApiException.php",
+    "Exceptions/QencodeClientException.php",
     "Classes/TranscodingTask.php",
     "Classes/TranscodingTaskCollection.php",
     "Classes/CustomTranscodingParams.php",

examples/start_encode.php

@@ -18,7 +18,7 @@
 
 try {
 
-    $task = $q->createTask();
+    $task = $q->createTask();  // /v1/create_task
     log_message("Created task: ".$task->getTaskToken());
 
     //set start time (in seconds) in input video to begin transcoding from
@@ -47,13 +47,16 @@
     echo "DONE!";
 
 
+} catch (QencodeClientException $e) {
+    // We got some inconsistent state in client application (e.g. task_token not found when requesting status)
+    log_message('Qencode Client Exception: ' . $e->getCode() . ' ' . $e->getMessage());
 } catch (QencodeApiException $e) {
     // API response status code was not successful
     log_message('Qencode API Exception: ' . $e->getCode() . ' ' . $e->getMessage());
 } catch (QencodeException $e) {
     // API call failed
     log_message('Qencode Exception: ' . $e->getMessage());
-    var_export($pf->getLastResponseRaw());
+    var_export($q->getLastResponseRaw());
 }
 
 function log_message($msg) {

examples/start_encode2.php

@@ -2,6 +2,7 @@
 require_once __DIR__ . '/../autoload.php';
 
 use Qencode\Exceptions\QencodeApiException;
+use Qencode\Exceptions\QencodeClientException;
 use Qencode\Exceptions\QencodeException;
 use Qencode\Classes\CustomTranscodingParams;
 use Qencode\Classes\Format;
@@ -11,25 +12,27 @@
 use Qencode\QencodeApiClient;
 
 // Replace this with your API key
-$apiKey = '5a5db6fa5b4c5';
+$apiKey = 'abcdefgh';
+$video_url = 'https://qa.qencode.com/static/1.mp4';
 
-$transcodingProfileId = '5a5db6fa5b8ac';
-
-$video_url = 'https://qa.stagevids.com/static/1.mp4';
-
-$q = new QencodeApiClient($apiKey, 'https://api-qa.qencode.com');
+$q = new QencodeApiClient($apiKey);
 
 try {
 
     $task = $q->createTask();
+    log_message("Created task: ".$task->getTaskToken());
+
     $params = new CustomTranscodingParams();
     $params->source = $video_url;
 
     $format = new Format();
     $format->destination = new Destination();
-    $format->destination->url = "s3://s3-eu-west-2.amazonaws.com/qencode-test";
-    $format->destination->key = "AKIAIKZIPSJ7SDAIWK4A";
-    $format->destination->secret = "h2TGNXeT49OT+DtZ3RGr+94HEhptS6oYsmXCwWuL";
+    $format->destination->url = "s3://s3-your-region.amazonaws.com/your-bucket/folder";
+    $format->destination->key = "your-access-key";
+    $format->destination->secret = "your-secret-key";
+    $format->destination->permissions = "public-read";
+    $format->destination->storage_class = "REDUCED_REDUNDANCY";
+    $format->segment_duration = 4;
     $format->output = "advanced_hls";
 
     $stream = new Stream();
@@ -53,21 +56,28 @@
     do {
         sleep(5);
         $response = $task->getStatus();
-        print_r($response);
-        echo "<BR><BR>";
+        if (is_array($response) and array_key_exists('percent', $response)) {
+            log_message("Completed: {$response['percent']}%");
+        }
     } while ($response['status'] != 'completed');
 
     foreach ($response['videos'] as $video) {
-        echo $video['user_tag'] . ': ' . $video['url'].'<BR>';
+        log_message($video['user_tag'] . ': ' . $video['url']);
     }
     echo "DONE!";
 
-
+} catch (QencodeClientException $e) {
+    // We got some inconsistent state in client application (e.g. task_token not found when requesting status)
+    log_message('Qencode Client Exception: ' . $e->getCode() . ' ' . $e->getMessage());
 } catch (QencodeApiException $e) {
     // API response status code was not successful
-    echo 'Qencode API Exception: ' . $e->getCode() . ' ' . $e->getMessage();
+    log_message('Qencode API Exception: ' . $e->getCode() . ' ' . $e->getMessage());
 } catch (QencodeException $e) {
     // API call failed
-    echo 'Qencode Exception: ' . $e->getMessage();
+    log_message('Qencode Exception: ' . $e->getMessage());
     var_export($q->getLastResponseRaw());
 }
+
+function log_message($msg) {
+    echo $msg."\n";
+}

src/Classes/Destination.php

@@ -20,4 +20,18 @@ class Destination {
      * @var string
      */
     public $secret;
+
+    /**
+     * Permission settings for S3
+     * For the list of available permissions see: https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#permissions
+     * @var string
+     */
+    public $permissions;
+
+    /**
+     * S3 storage class
+     * Use REDUCED_REDUNDANCY to reduce storage redundancy
+     * @var string
+     */
+    public $storage_class;
 }

src/Classes/TranscodingTask.php

@@ -2,6 +2,8 @@
 
 namespace Qencode\Classes;
 
+use Qencode\Exceptions\QencodeClientException;
+
 class TranscodingTask {
 
     private $api;
@@ -119,15 +121,15 @@ public function startCustom($task_params, $payload = null) {
     public function getStatus() {
         $params = array('task_tokens[]' => $this->taskToken);
         //TODO: fallback to /v1/status
-        //echo "Checking status: ".$this->statusUrl."\n";
         $response = $this->api->post($this->statusUrl, $params);
-        $status = $response['statuses'][$this->taskToken];
-        $this->lastStatus = $status;
-        if (is_array($status) and array_key_exists('status_url', $status)) {
-            $this->statusUrl = $status['status_url'];
+        $this->lastStatus = $response['statuses'][$this->taskToken];
+        if ($this->lastStatus == null) {
+            throw new QencodeClientException('Task '. $this->taskToken. ' not found!');
         }
-
-        return $status;
+        if (array_key_exists('status_url', $this->lastStatus)) {
+            $this->statusUrl = $this->lastStatus['status_url'];
+        }
+        return $this->lastStatus;
     }
 
     /**

src/Exceptions/QencodeClientException.php

@@ -0,0 +1,10 @@
+<?php
+
+namespace Qencode\Exceptions;
+
+/**
+ * Qencode exception thrown by API client code
+ */
+class QencodeClientException extends QencodeException
+{
+}

src/QencodeApiClient.php

@@ -131,9 +131,9 @@ private function request($method, $path, array $params = [])
         if (!empty($params) & is_array($params)) {
             $params = http_build_query($params);
         }
-        //echo $url;
-        //echo "<br>";
-        //echo $params."<br><br>";
+        #echo $url;
+        #echo "\n";
+        #echo $params."\n\n";
         $curl = curl_init($url);
 
         curl_setopt($curl, CURLOPT_USERPWD, $this->key);
@@ -161,8 +161,8 @@ private function request($method, $path, array $params = [])
             throw new QencodeException('CURL: ' . $error, $errorNumber);
         }
 
-        //echo $this->lastResponseRaw;
-        //echo "<br><br>";
+        #echo $this->lastResponseRaw;
+        #echo "\n\n";
         $this->lastResponse = $response = json_decode($this->lastResponseRaw, true);
         //print_r($response);