@bitmovin/api-sdk 1.98.0 → 1.99.0

package/dist/common/RestClient.js

@@ -238,7 +238,7 @@ var HeaderHandler = /** @class */ (function (_super) {
         var headers = {
             'X-Api-Key': apiKey,
             'X-Api-Client': 'bitmovin-api-sdk-javascript',
-            'X-Api-Client-Version': '1.98.0',
+            'X-Api-Client-Version': '1.99.0',
             'Content-Type': 'application/json'
         };
         if (tenantOrgId) {

package/dist/encoding/simple/jobs/vod/VodApi.d.ts

@@ -14,7 +14,7 @@ export default class VodApi extends BaseAPI {
     constructor(configuration: Configuration);
     /**
      * @summary Create a Simple Encoding VOD Job
-     * @param {SimpleEncodingVodJobRequest} simpleEncodingVodJobRequest The Simple Encoding VOD Job to be created
+     * @param {SimpleEncodingVodJobRequest} simpleEncodingVodJobRequest The Simple Encoding VOD Job to be created.  Check out our [Simple Encoding API Documentation](https://bitmovin.com/docs/encoding/articles/simple-encoding-api) for additional information about the Simple Encoding API.
      * @throws {BitmovinError}
      * @memberof VodApi
      */

package/dist/encoding/simple/jobs/vod/VodApi.js

@@ -31,7 +31,7 @@ var VodApi = /** @class */ (function (_super) {
     }
     /**
      * @summary Create a Simple Encoding VOD Job
-     * @param {SimpleEncodingVodJobRequest} simpleEncodingVodJobRequest The Simple Encoding VOD Job to be created
+     * @param {SimpleEncodingVodJobRequest} simpleEncodingVodJobRequest The Simple Encoding VOD Job to be created.  Check out our [Simple Encoding API Documentation](https://bitmovin.com/docs/encoding/articles/simple-encoding-api) for additional information about the Simple Encoding API.
      * @throws {BitmovinError}
      * @memberof VodApi
      */

package/dist/models/SimpleEncodingVodJobUrlInput.d.ts

@@ -18,7 +18,7 @@ export declare class SimpleEncodingVodJobUrlInput {
      */
     credentials?: SimpleEncodingVodJobCredentials;
     /**
-     * Defines the type of the input file, if no type is set it is assumed that the input file contains at least one video stream and optionally one or multiple audio streams.
+     * Defines the type of the input file, if no type is set it is assumed that the input file contains at least one video stream and optionally one or multiple audio streams.  Note that when defining video and audio inputs, you can either - add one single input without inputType, in which case that source file must contain a video stream and (if you want audio) one audio stream, or - add one single input with inputType=VIDEO and (if you want audio) one or more inputs with inputType=AUDIO (each containing one audio stream)  Other combinations are not valid.
      * @type {SimpleEncodingVodJobInputType}
      * @memberof SimpleEncodingVodJobUrlInput
      */

package/dist/models/SimpleEncodingVodJobUrlOutput.d.ts

@@ -5,7 +5,7 @@ import SimpleEncodingVodJobCredentials from './SimpleEncodingVodJobCredentials';
  */
 export declare class SimpleEncodingVodJobUrlOutput {
     /**
-     * Define a URL pointing to a folder which will be used to upload the encoded assets.  The output folder structure used looks the following way: <br><br> `http://host/my-folder`     <ul>       <li>         `/video`         <ul>           <li>`/h264/{width}x{height}_{bitrate}/` (multiple subfolders containing different output renditions)</li>         </ul>       </li>       <li>`/audio`         <ul>           <li>`/aac/{language}/` - if language is unique (subfolder containing audio output files)</li>           <li>`/aac/{language}_{index}/` - if language is not unique (subfolder containing audio output files)</li>         </ul>       </li>       <li>`/subtitles` (subfolder containing subtitles files)</li>       <li>`/captions` (subfolder containing subtitles files)</li>       <li>`/sprites` (subfolder containing generated sprites)</li>       <li>`/thumbnails` (subfolder containing generated thumbnails)</li>       <li>`/index.m3u8` (HLS manifest file) </li>       <li>`/stream.mpd` (DASH manifest file) </li>     </ul>  Currently the following protocols/storages systems are supported: S3, GCS, Azure Blob Storage, Akamai NetStorage. Note that most protocols will require `credentials` to access the asset. Check the description below which ones are applicable. See below how to construct the URLs for the individual protocals/storage systems.  ---  **S3**: * `s3://<my-bucket>/path/`  Authentication can be done via accesskey/secretkey or role-based authentication. Generic S3 is currently NOT supported.  **GCS**: * `gcs://<my-bucket>/path/`  Authentication can be done via accesskey/secretkey or a service account  **Azure Blob Storage (ABS)**: * `https://<account>.blob.core.windows.net/<container>/path/`  It is required to provide the Azure key credentials for authentication.  **Akamai NetStorage**: * `https://<host>-nsu.akamaihd.net/<CP-code>/path/`  It is required to provider username/password credentials for authentication. (required)
+     * Define a URL pointing to a folder which will be used to upload the encoded assets.  The output folder structure used looks the following way: <br><br> `http://host/my-folder`     <ul>       <li>         `/video`         <ul>           <li>`/h264/{width}x{height}_{bitrate}/` (multiple subfolders containing different output renditions)</li>         </ul>       </li>       <li>`/audio`         <ul>           <li>`/aac/{language}/` - if language is unique (subfolder containing audio output files)</li>           <li>`/aac/{language}_{index}/` - if language is not unique (subfolder containing audio output files)</li>         </ul>       </li>       <li>`/subtitles` (subfolder containing subtitles files)</li>       <li>`/captions` (subfolder containing subtitles files)</li>       <li>`/sprites` (subfolder containing generated sprites)</li>       <li>`/thumbnails` (subfolder containing generated thumbnails)</li>       <li>`/index.m3u8` (HLS manifest file) </li>       <li>`/stream.mpd` (DASH manifest file) </li>     </ul>    Currently the following protocols/storages systems are supported: S3, GCS, Azure Blob Storage, Akamai NetStorage. Note that most protocols will require `credentials` to access the asset. Check the description below which ones are applicable. See below how to construct the URLs for the individual protocals/storage systems. --- **Recommended:** In order to ensure the uniques of the output paths, the use of placeholders in the output's is URL recommended. The following placeholders are supported:  {uuid} - will be replace with a random UUID {asset} - will be replaced with the asset file name (only for the input type VIDEO or DEFAULT)  Example:  * using an `{uuid}` placeholder: The output URL provided `s3://<my-bucket>/{uuid}/path/` will be transformed to `s3://<my-bucket>/<random-uuid-value>/path/`.  * using an `{asset}` placeholder: Given the following input URL `s3://my-bucket/path/filename.mp4`, of input type VIDEO or DEFAULT, the following output URL  `s3://<my-bucket>/{asset}/path/` will be transformed to `s3://<my-bucket>/filename/path/`  Note: the placeholders can be combined or used multiple times in the same URL.  ---  **S3**: * `s3://<my-bucket>/path/`  Authentication can be done via accesskey/secretkey or role-based authentication. Generic S3 is currently NOT supported.  **GCS**: * `gcs://<my-bucket>/path/`  Authentication can be done via accesskey/secretkey or a service account  **Azure Blob Storage (ABS)**: * `https://<account>.blob.core.windows.net/<container>/path/`  It is required to provide the Azure key credentials for authentication.  **Akamai NetStorage**: * `https://<host>-nsu.akamaihd.net/<CP-code>/path/`  It is required to provider username/password credentials for authentication. (required)
      * @type {string}
      * @memberof SimpleEncodingVodJobUrlOutput
      */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bitmovin/api-sdk",
-  "version": "1.98.0",
+  "version": "1.99.0",
   "description": "Bitmovin JS/TS API SDK",
   "author": "Bitmovin Inc",
   "keywords": [