bitmovin / bitmovin-php

DEPRECATED: PHP client for the Bitmovin API, see https://github.com/bitmovin/bitmovin-api-sdk-php

New API Client (Recommended)

bitmovin-php is the legacy Bitmovin API client for PHP.

We recommend using the new client, which you can find at bitmovin-api-sdk-php. Using the new client guarantees 100% specification conformity at any given time and access to all features of the API as soon as they are released.

---

bitmovin-php

PHP-Client which enables you to seamlessly integrate the Bitmovin API into your projects. Using this API client requires an active account. Sign up for a Bitmovin API key.

The full Bitmovin API reference can be found on our website.

Installation

Requirements: PHP 5.6.0 or higher is required

Composer

To install the api-client with composer, add the following to your composer.json file:

{
"require": 
  {
    "bitmovin/bitmovin-php": "1.5.*"
  }
}

Then run php composer.phar install

OR

run the following command: php composer.phar require bitmovin/bitmovin-php:1.5.*

Example

The following example creates a simple transcoding job and transfers it to a GCS output location (CreateSimpleEncoding.php):

<?php

use Bitmovin\api\enum\CloudRegion;
use Bitmovin\BitmovinClient;
use Bitmovin\configs\audio\AudioStreamConfig;
use Bitmovin\configs\EncodingProfileConfig;
use Bitmovin\configs\JobConfig;
use Bitmovin\configs\manifest\DashOutputFormat;
use Bitmovin\configs\manifest\HlsOutputFormat;
use Bitmovin\configs\video\H264VideoStreamConfig;
use Bitmovin\input\HttpInput;
use Bitmovin\output\GcsOutput;

require_once __DIR__ . '/vendor/autoload.php';

$client = new BitmovinClient('INSERT YOUR API KEY HERE');

// CONFIGURATION
$videoInputPath = 'http://eu-storage.bitcodin.com/inputs/Sintel.2010.720p.mkv';
$gcs_accessKey = 'INSERT YOUR GCS OUTPUT ACCESS KEY HERE';
$gcs_secretKey = 'INSERT YOUR GCS OUTPUT SECRET KEY HERE';
$gcs_bucketName = 'INSERT YOUR GCS OUTPUT BUCKET NAME HERE';
$gcs_prefix = 'path/to/your/output/destination/';

// CREATE ENCODING PROFILE
$encodingProfile = new EncodingProfileConfig();
$encodingProfile->name = 'Test Encoding';
$encodingProfile->cloudRegion = CloudRegion::GOOGLE_EUROPE_WEST_1;

// CREATE VIDEO STREAM CONFIG FOR 1080p
$videoStreamConfig_1080 = new H264VideoStreamConfig();
$videoStreamConfig_1080->input = new HttpInput($videoInputPath);
$videoStreamConfig_1080->width = 1920;
$videoStreamConfig_1080->height = 1080;
$videoStreamConfig_1080->bitrate = 4800000;
$videoStreamConfig_1080->rate = 25.0;
$encodingProfile->videoStreamConfigs[] = $videoStreamConfig_1080;

// CREATE VIDEO STREAM CONFIG FOR 720p
$videoStreamConfig_720 = new H264VideoStreamConfig();
$videoStreamConfig_720->input = new HttpInput($videoInputPath);
$videoStreamConfig_720->width = 1280;
$videoStreamConfig_720->height = 720;
$videoStreamConfig_720->bitrate = 2400000;
$videoStreamConfig_720->rate = 25.0;
$encodingProfile->videoStreamConfigs[] = $videoStreamConfig_720;

// CREATE AUDIO STREAM CONFIG
$audioConfig = new AudioStreamConfig();
$audioConfig->input = new HttpInput($videoInputPath);
$audioConfig->bitrate = 128000;
$audioConfig->rate = 48000;
$audioConfig->name = 'English';
$audioConfig->lang = 'en';
$audioConfig->position = 1;
$encodingProfile->audioStreamConfigs[] = $audioConfig;

// CREATE JOB CONFIG
$jobConfig = new JobConfig();
// ASSIGN OUTPUT
$jobConfig->output = new GcsOutput($gcs_accessKey, $gcs_secretKey, $gcs_bucketName, $gcs_prefix);
// ASSIGN ENCODING PROFILES TO JOB
$jobConfig->encodingProfile = $encodingProfile;
// ENABLE DASH OUTPUT
$jobConfig->outputFormat[] = new DashOutputFormat();
// ENABLE HLS OUTPUT
$jobConfig->outputFormat[] = new HlsOutputFormat();

// RUN JOB AND WAIT UNTIL IT HAS FINISHED
$client->runJobAndWaitForCompletion($jobConfig);

For more examples go to our example page.

bitmovin-php's Issues

S3 Directory Name

Hi there,
Can you tell me how I use Amazon S3 can specify a folder name in the API?

I use: $outputConfig->prefix = "/streams_neu/"

There he should create the video in the folder Video_XY. Unfortunately, he always creates a hash value as a folder name.

I need this to update videos.

Unfortunately, I find no function.

Hope you can help me.
Thank you.

Error

Hi,

I have a problem with the manifest, I removed subtitules and HLS. Error: Error with the manifest, maybe MPD is not valid.
XML:
{
"name": "stream.mpd",
"bucket": "prueba-ott.appspot.com",
"generation": "1530521806949461",
"metageneration": "2",
"contentType": "application/dash+xml",
"timeCreated": "2018-07-02T08:56:46.949Z",
"updated": "2018-07-02T08:59:43.887Z",
"storageClass": "STANDARD",
"size": "1544",
"md5Hash": "kp9kd/hZjTM47HeXOXS8Ww==",
"contentEncoding": "identity",
"crc32c": "XKMFqg==",
"etag": "CNWY/4SGgNwCEAI=",
"downloadTokens": "4a190606-08e8-4fef-94cf-a46302e8085a",
"metadata": {
"md5-hash": "929f6477f8598d3338ec77973974bc5b"
}
}

Get profiles list

In the previus API¹ I could get the existing profiles² with:

use bitcodin\EncodingProfile;

public function getProfiles(){
  $encodingProfiles = EncodingProfile::getList()->profiles;
  return $encodingProfiles;
}

I did not found a way to do it in this new API, all the examples shows how to create the profiles, but none how to get a existing one.

¹ https://github.com/bitmovin/bitcodin-php
² https://app.bitmovin.com/encoding-profiles

Question: bitcodin vs bitmovin

How does this project compare with https://github.com/bitmovin/bitcodin-php ?
Confused....

S3-to-S3 example failing

We're using the PHP S3-to-S3 example. We're encountering an error in the following lines:

                // CREATE API CLIENT
		$apiClient = new ApiClient('<our-API-key>');
		
		// CREATE ENCODING
		$encoding = new Encoding('A Name for your encoding');
		$encoding->setCloudRegion(CloudRegion::AWS_US_EAST_1);
		$encoding = $apiClient->encodings()->create($encoding);

We don't have an actual error message because this is being run within a Laravel project; the error we get is a fatal throwable exception, which tells us nothing.

Trimming is being ignored.

I want to encode a small part of a larger video, but the trim settings are not having any effect.

I ran the code exactly as it appears in the example EncodingWithS3InputAndS3OutputAndOffsetAndDuration.php.
The encoding works (and I can play the resulting manifests), but the offset and duration are completely ignored, and the encoding started at the beginning of the file.

update dependencies

can you please upgrade the dependencies?

• jms/serializer -> 1.14 -> 3.0
• icecave/parity -> 1.0 -> 2.0
• icecave/repr -> 1.0 -> 2.0

i tried to do a PR, but somehow running tests, is a nightmare. (#88)

what is the current way to run, tests?

Version of Guzzle

Hi,

Is there any reason why there's a dependency on a specific version of "guzzlehttp/guzzle": "6.2.x"? https://github.com/bitmovin/bitmovin-php/blob/master/composer.json#L33

I've forked the repo as I'm using Drupal 8.4-dev which is using 6.3 so I've changed composer to "guzzlehttp/guzzle": "^6.0" in order to test a bitmovin integration.

Create MP4Muxing with multiple audio tracks.

live statistics missing

Hi,
I can't find the live statistics function in the PHP SDK:

https://api.bitmovin.com/v1/encoding/statistics/encodings/encoding_id/live-statistics

Kind regards,
Erik