Updated PHP client to v1.177.0

bitmovin · Oct 31, 2023 · a37d0eb · a37d0eb
1 parent 08e653e
commit a37d0eb
Show file tree

Hide file tree

Showing 12 changed files with 132 additions and 8 deletions.
diff --git a/README.md b/README.md
@@ -40,7 +40,7 @@ To install the API client with composer, add the following to your composer.json
 {
 "require":
   {
-    "bitmovin/bitmovin-api-sdk-php": "1.176.0"
+    "bitmovin/bitmovin-api-sdk-php": "1.177.0"
   }
 }
 ```
@@ -49,7 +49,7 @@ Then run `php composer.phar install`
 
 OR
 
-run the following command: `php composer.phar require bitmovin/bitmovin-api-sdk-php:1.176.0`
+run the following command: `php composer.phar require bitmovin/bitmovin-api-sdk-php:1.177.0`
 
 ## Initialization
 

diff --git a/composer.json b/composer.json
@@ -1,7 +1,7 @@
 {
     "name": "bitmovin/bitmovin-api-sdk-php",
     "description": "This is the Bitmovin API SDK for PHP",
-    "version": "1.176.0",
+    "version": "1.177.0",
     "authors": [
         {
             "name": "Bitmovin Inc",

diff --git a/docs/classes/BitmovinApiSdk_Models_LiveHlsManifest.html b/docs/classes/BitmovinApiSdk_Models_LiveHlsManifest.html
@@ -130,7 +130,7 @@ <h4>public</h4>
             <li id="programDateTimeSettings"><a title="BitmovinApiSdk\Models\LiveHlsManifest" href="../classes/BitmovinApiSdk_Models_LiveHlsManifest/programDateTimeSettings.html">programDateTimeSettings()</a>
                 — Configuration for the EXT-X-PROGRAM-DATETIME tag</li>
             <li id="timeshift"><a title="BitmovinApiSdk\Models\LiveHlsManifest" href="../classes/BitmovinApiSdk_Models_LiveHlsManifest/timeshift.html">timeshift()</a>
-                — Timeshift in seconds</li>
+                — Timeshift in seconds. We recommend to use a timeshift value not greater than 3 hours (10800.0 seconds). Longer values could negatively impact the manifest update frequency.</li>
           </ul>
           <h3>Inherited from <a title="BitmovinApiSdk\Common\ApiResource" href="../classes/BitmovinApiSdk_Common_ApiResource.html">BitmovinApiSdk\Common\ApiResource</a></h3>
           <h4>public</h4>

diff --git a/docs/classes/BitmovinApiSdk_Models_LiveHlsManifest/timeshift.html b/docs/classes/BitmovinApiSdk_Models_LiveHlsManifest/timeshift.html
@@ -62,7 +62,7 @@
       </nav>
       <section>
         <h1><small>BitmovinApiSdk\Models\LiveHlsManifest::</small>timeshift</h1>
-        <h4>Timeshift in seconds</h4>
+        <h4>Timeshift in seconds. We recommend to use a timeshift value not greater than 3 hours (10800.0 seconds). Longer values could negatively impact the manifest update frequency.</h4>
         <p/>
         <ul/>
         <ul/>

diff --git a/docs/classes/BitmovinApiSdk_Models_PrewarmedEncoderPool.html b/docs/classes/BitmovinApiSdk_Models_PrewarmedEncoderPool.html
@@ -72,6 +72,7 @@ <h2 id="synopsis">Synopsis</h2>
                     </li><li>public string <a href="#members">$infrastructureId</a>;
                     </li><li>public <span title="BitmovinApiSdk\Models\PrewarmedEncoderDiskSize">PrewarmedEncoderDiskSize</span> <a href="#members">$diskSize</a>;
                     </li><li>public int <a href="#members">$targetPoolSize</a>;
+                    </li><li>public <span title="BitmovinApiSdk\Models\bool">bool</span> <a href="#members">$dynamicPool</a>;
                     </li><li>public <span title="BitmovinApiSdk\Models\bool">bool</span> <a href="#members">$gpuEnabled</a>;
                     </li><li>public <span title="BitmovinApiSdk\Models\PrewarmedEncoderPoolStatus">PrewarmedEncoderPoolStatus</span> <a href="#members">$status</a>;
                     </li></ul><ul class="none"><li>// Inherited members from <span title="BitmovinApiSdk\Models\BitmovinResource">BitmovinResource</span></li><li>public string <a href="#members">$name</a>;
@@ -86,6 +87,7 @@ <h2 id="synopsis">Synopsis</h2>
                     </li><li>public $this <a title="BitmovinApiSdk\Models\PrewarmedEncoderPool" href="../classes/BitmovinApiSdk_Models_PrewarmedEncoderPool/infrastructureId.html">infrastructureId</a>()
                     </li><li>public $this <a title="BitmovinApiSdk\Models\PrewarmedEncoderPool" href="../classes/BitmovinApiSdk_Models_PrewarmedEncoderPool/diskSize.html">diskSize</a>()
                     </li><li>public $this <a title="BitmovinApiSdk\Models\PrewarmedEncoderPool" href="../classes/BitmovinApiSdk_Models_PrewarmedEncoderPool/targetPoolSize.html">targetPoolSize</a>()
+                    </li><li>public $this <a title="BitmovinApiSdk\Models\PrewarmedEncoderPool" href="../classes/BitmovinApiSdk_Models_PrewarmedEncoderPool/dynamicPool.html">dynamicPool</a>()
                     </li><li>public $this <a title="BitmovinApiSdk\Models\PrewarmedEncoderPool" href="../classes/BitmovinApiSdk_Models_PrewarmedEncoderPool/gpuEnabled.html">gpuEnabled</a>()
                     </li></ul><ul class="none"><li>// Inherited methods from <span title="BitmovinApiSdk\Models\BitmovinResource">BitmovinResource</span></li><li>public void <a title="BitmovinApiSdk\Models\BitmovinResource" href="../classes/BitmovinApiSdk_Models_BitmovinResource/__construct.html">__construct</a>()
                         </li><li>public $this <a title="BitmovinApiSdk\Models\BitmovinResource" href="../classes/BitmovinApiSdk_Models_BitmovinResource/name.html">name</a>()
@@ -126,6 +128,9 @@ <h4>public</h4>
             <li id="diskSize"><strong>$diskSize</strong>
                 —
                 <a title="BitmovinApiSdk\Models\PrewarmedEncoderDiskSize" href="../classes/BitmovinApiSdk_Models_PrewarmedEncoderDiskSize.html">BitmovinApiSdk\Models\PrewarmedEncoderDiskSize</a></li>
+            <li id="dynamicPool"><strong>$dynamicPool</strong>
+                —
+                <a title="BitmovinApiSdk\Models\bool" href="../classes/BitmovinApiSdk_Models_bool.html">BitmovinApiSdk\Models\bool</a></li>
             <li id="encoderVersion"><strong>$encoderVersion</strong>
                 —
                 string</li>
@@ -163,6 +168,8 @@ <h4>public</h4>
                 — The cloud region in which the pool&amp;#39;s instances will be running. Must be a specific region (e.g. not &amp;#39;AUTO&amp;#39;, &amp;#39;GOOGLE&amp;#39; or &amp;#39;EUROPE&amp;#39;) (required)</li>
             <li id="diskSize"><a title="BitmovinApiSdk\Models\PrewarmedEncoderPool" href="../classes/BitmovinApiSdk_Models_PrewarmedEncoderPool/diskSize.html">diskSize()</a>
                 — Disk size of the prewarmed instances in GB. Needs to be chosen depending on input file sizes and encoding features used. (required)</li>
+            <li id="dynamicPool"><a title="BitmovinApiSdk\Models\PrewarmedEncoderPool" href="../classes/BitmovinApiSdk_Models_PrewarmedEncoderPool/dynamicPool.html">dynamicPool()</a>
+                — Activate dynamic pool behaviour. Pool will increase/decrease based on usage. Minimum pool size is set by targetPoolSize.</li>
             <li id="encoderVersion"><a title="BitmovinApiSdk\Models\PrewarmedEncoderPool" href="../classes/BitmovinApiSdk_Models_PrewarmedEncoderPool/encoderVersion.html">encoderVersion()</a>
                 — The encoder version which the pool&amp;#39;s instances will be running (required)</li>
             <li id="gpuEnabled"><a title="BitmovinApiSdk\Models\PrewarmedEncoderPool" href="../classes/BitmovinApiSdk_Models_PrewarmedEncoderPool/gpuEnabled.html">gpuEnabled()</a>

diff --git a/docs/classes/BitmovinApiSdk_Models_PrewarmedEncoderPool/dynamicPool.html b/docs/classes/BitmovinApiSdk_Models_PrewarmedEncoderPool/dynamicPool.html
@@ -0,0 +1,94 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE html SYSTEM "about:legacy-compat">
+<html xmlns="http://www.w3.org/1999/xhtml" lang="en">
+  <head>
+    <title>phpDox - BitmovinApiSdk\Models\PrewarmedEncoderPool::dynamicPool</title>
+    <link rel="stylesheet" type="text/css" href="../../css/style.css" media="screen"/>
+    <meta http-equiv="content-type" content="text/html; charset=utf-8"/>
+  </head>
+  <body>
+    <nav class="topnav">
+      <ul>
+        <li>
+          <div class="logo"><span>/**</span>phpDox</div>
+        </li>
+        <li class="separator">
+          <a href="../../index.html">Overview</a>
+        </li>
+        <li class="separator">
+          <a href="../../namespaces.html">Namespaces</a>
+        </li>
+        <li>
+          <a href="../../interfaces.html">Interfaces</a>
+        </li>
+        <li>
+          <a href="../../classes.html">Classes</a>
+        </li>
+      </ul>
+    </nav>
+    <div id="mainstage">
+      <div class="box">
+        <ul class="breadcrumb">
+          <li>
+            <a href="../../index.html">Overview</a>
+          </li>
+          <li class="separator">
+            <a href="../../classes.html">Classes</a>
+          </li>
+          <li class="separator">
+            <a href="../../classes.html#BitmovinApiSdk_Models">BitmovinApiSdk\Models</a>
+          </li>
+          <li class="separator">
+            <a title="BitmovinApiSdk\Models\PrewarmedEncoderPool" href="../../classes/BitmovinApiSdk_Models_PrewarmedEncoderPool.html">PrewarmedEncoderPool</a>
+          </li>
+          <li class="separator">dynamicPool</li>
+        </ul>
+      </div>
+      <nav class="box">
+        <ul>
+          <li>
+            <a href="#introduction">Introduction</a>
+          </li>
+          <li>
+            <a href="#synopsis">Synopsis</a>
+          </li>
+          <li>
+            <a href="#parameter">Parameter</a>
+          </li>
+          <li>
+            <a href="#return">Return</a>
+          </li>
+        </ul>
+      </nav>
+      <section>
+        <h1><small>BitmovinApiSdk\Models\PrewarmedEncoderPool::</small>dynamicPool</h1>
+        <h4>Activate dynamic pool behaviour. Pool will increase/decrease based on usage. Minimum pool size is set by targetPoolSize.</h4>
+        <p/>
+        <ul/>
+        <ul/>
+        <h2 id="signature">Signature</h2>
+        <div class="styled synopsis">
+          <code>public function dynamicPool(bool
+        $dynamicPool )
+            </code>
+        </div>
+        <h2 id="parameterlist">Parameters</h2>
+        <dl class="styled">
+          <dt><code>$dynamicPool</code>
+                —
+                bool</dt>
+          <dd><br/><br/><br/>      </dd>
+        </dl>
+        <h2 id="return">Returns</h2>
+        <dl class="styled">
+          <dt>$this</dt>
+          <dd><br/>
+        </dd>
+        </dl>
+      </section>
+    </div>
+    <footer>
+      <span>Generated using phpDox 0.12.0 - Copyright (C) 2010 - 2023 by Arne Blankerts and Contributors</span>
+    </footer>
+  </body>
+</html>
diff --git a/docs/classes/BitmovinApiSdk_Models_StreamsVideoResponse.html b/docs/classes/BitmovinApiSdk_Models_StreamsVideoResponse.html
@@ -79,6 +79,7 @@ <h2 id="synopsis">Synopsis</h2>
                     </li><li>public <span title="\BitmovinApiSdk\Models\StreamsAdConfigResponse">StreamsAdConfigResponse</span> <a href="#members">$adConfig</a>;
                     </li><li>public <span title="\BitmovinApiSdk\Models\StreamsContentProtectionResponse">StreamsContentProtectionResponse</span> <a href="#members">$contentProtection</a>;
                     </li><li>public <span title="BitmovinApiSdk\Models\StreamsTrimmingStatus">StreamsTrimmingStatus</span> <a href="#members">$trimming</a>;
+                    </li><li>public string <a href="#members">$downloadUrl</a>;
                     </li></ul><ul class="none"><li>// methods</li><li>public void <a title="BitmovinApiSdk\Models\StreamsVideoResponse" href="../classes/BitmovinApiSdk_Models_StreamsVideoResponse/__construct.html">__construct</a>()
                     </li><li>public $this <a title="BitmovinApiSdk\Models\StreamsVideoResponse" href="../classes/BitmovinApiSdk_Models_StreamsVideoResponse/styleConfig.html">styleConfig</a>()
                     </li><li>public $this <a title="BitmovinApiSdk\Models\StreamsVideoResponse" href="../classes/BitmovinApiSdk_Models_StreamsVideoResponse/adConfig.html">adConfig</a>()
@@ -117,6 +118,9 @@ <h4>public</h4>
             <li id="description"><strong>$description</strong>
                 —
                 string</li>
+            <li id="downloadUrl"><strong>$downloadUrl</strong>
+                —
+                string</li>
             <li id="encodingTasks"><strong>$encodingTasks</strong>
                 —
                 <a title="\BitmovinApiSdk\Models\StreamsVideoEncodingTask" href="../classes/_BitmovinApiSdk_Models_StreamsVideoEncodingTask.html">\BitmovinApiSdk\Models\StreamsVideoEncodingTask</a>[]

diff --git a/docs/index.html b/docs/index.html
@@ -34,7 +34,7 @@ <h2>Software Documentation</h2>
       </div>
       <div id="buildinfo">
         <h3>Build</h3>
-        <p>Tue, 17 Oct 2023 09:30:08 +0000</p>
+        <p>Tue, 31 Oct 2023 12:50:47 +0000</p>
         <h3>VCS Info</h3>
         <p>
                     tag: <br/>

diff --git a/src/Common/Middleware/CustomApiHeaders.php b/src/Common/Middleware/CustomApiHeaders.php
@@ -17,7 +17,7 @@ public function __construct(string $apiKey, ?string $tenantOrgId)
             'Content-Type' => 'application/json',
             'X-Api-Key' => $apiKey,
             'X-Api-Client' => 'bitmovin-api-sdk-php',
-            'X-Api-Client-Version' => '1.176.0',
+            'X-Api-Client-Version' => '1.177.0',
         ];
 
         if ($tenantOrgId !== null) {

diff --git a/src/Models/LiveHlsManifest.php b/src/Models/LiveHlsManifest.php
@@ -42,7 +42,7 @@ public function manifestId(string $manifestId)
     }
 
     /**
-     * Timeshift in seconds
+     * Timeshift in seconds. We recommend to use a timeshift value not greater than 3 hours (10800.0 seconds). Longer values could negatively impact the manifest update frequency.
      *
      * @param float $timeshift
      * @return $this

diff --git a/src/Models/PrewarmedEncoderPool.php b/src/Models/PrewarmedEncoderPool.php
@@ -22,6 +22,9 @@ class PrewarmedEncoderPool extends BitmovinResource
     /** @var int */
     public $targetPoolSize;
 
+    /** @var bool */
+    public $dynamicPool;
+
     /** @var bool */
     public $gpuEnabled;
 
@@ -101,6 +104,19 @@ public function targetPoolSize(int $targetPoolSize)
         return $this;
     }
 
+    /**
+     * Activate dynamic pool behaviour. Pool will increase/decrease based on usage. Minimum pool size is set by targetPoolSize.
+     *
+     * @param bool $dynamicPool
+     * @return $this
+     */
+    public function dynamicPool(bool $dynamicPool)
+    {
+        $this->dynamicPool = $dynamicPool;
+
+        return $this;
+    }
+
     /**
      * Create pool with GPU instances for hardware encoding presets (e.g., VOD_HARDWARE_SHORTFORM).
      *

diff --git a/src/Models/StreamsVideoResponse.php b/src/Models/StreamsVideoResponse.php
@@ -43,6 +43,9 @@ class StreamsVideoResponse extends \BitmovinApiSdk\Common\ApiResource
     /** @var StreamsTrimmingStatus */
     public $trimming;
 
+    /** @var string */
+    public $downloadUrl;
+
     public function __construct($attributes = null)
     {
         parent::__construct($attributes);