cloudmersive/cloudmersive_video_api_client

1.0.4 2020-08-23 04:53 UTC

Requires

• php: >=5.5
• ext-curl: *
• ext-json: *
• ext-mbstring: *
• guzzlehttp/guzzle: ^6.2

Requires (Dev)

• friendsofphp/php-cs-fixer: ~1.12
• phpunit/phpunit: ^4.8
• squizlabs/php_codesniffer: ~2.6

proprietary

• Cloudmersive

• php
• api
• sdk
• swagger

README

The video APIs help you convert, encode, and transcode videos.

Cloudmersive Video and Media Services API - Convert and encode video and media files and content between file formats. On-demand.

• API version: v1
• Package version: 1.0.4

Requirements

PHP 5.5 and later

Installation & Usage

Composer

To install the bindings via Composer, add the following to composer.json:

{
  "repositories": [
    {
      "type": "git",
      "url": "https://github.com/cloudmersive/cloudmersive_video_api_client.git"
    }
  ],
  "require": {
    "cloudmersive/cloudmersive_video_api_client": "*@dev"
  }
}

Then run composer install

Manual Installation

Download the files and include autoload.php:

    require_once('/path/to/cloudmersive_video_api_client/vendor/autoload.php');

Tests

To run the unit tests:

composer install
./vendor/bin/phpunit

Getting Started

Please follow the installation procedure and then run the following:

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: Apikey
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Apikey', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Apikey', 'Bearer');

$apiInstance = new Swagger\Client\Api\AudioApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$input_file = "/path/to/file.txt"; // \SplFileObject | Input file to perform the operation on.
$file_url = "file_url_example"; // string | Optional; URL of an audio file being used for conversion. Use this option for files larger than 2GB.
$bit_rate = 56; // int | Optional; Specify the desired bitrate of the converted audio file in kilobytes per second (kB/s). Value may be between 48 and 1,411. By default, the optimal bitrate will be chosen automatically.

try {
    $result = $apiInstance->audioConvertToAac($input_file, $file_url, $bit_rate);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AudioApi->audioConvertToAac: ', $e->getMessage(), PHP_EOL;
}

?>

Documentation for API Endpoints

All URIs are relative to https://api.cloudmersive.com

Class	Method	HTTP request	Description
AudioApi	audioConvertToAac	POST /video/convert/to/aac	Convert Audio File to AAC format.
AudioApi	audioConvertToM4a	POST /video/convert/to/m4a	Convert Audio File to M4A format.
AudioApi	audioConvertToMp3	POST /video/convert/to/mp3	Convert Audio File to MP3 format.
AudioApi	audioConvertToWav	POST /video/convert/to/wav	Convert Audio File to WAV format.
VideoApi	videoConvertToGif	POST /video/convert/to/gif	Convert Video to Animated GIF format.
VideoApi	videoConvertToMov	POST /video/convert/to/mov	Convert Video to MOV format.
VideoApi	videoConvertToMp4	POST /video/convert/to/mp4	Convert Video to MP4 format.
VideoApi	videoConvertToStillFrames	POST /video/convert/to/still-frames	Convert Video to PNG Still Frames.
VideoApi	videoConvertToWebm	POST /video/convert/to/webm	Convert Video to WEBM format.
VideoApi	videoCutVideo	POST /video/cut	Cut a Video to a Shorter Length
VideoApi	videoGetInfo	POST /video/convert/get-info	Get detailed information about a video or audio file
VideoApi	videoResizeVideo	POST /video/resize/preserveAspectRatio	Resizes a Video Preserving the Original Aspect Ratio.
VideoApi	videoResizeVideoSimple	POST /video/resize/target	Resizes a Video without Preserving Aspect Ratio.
VideoApi	videoScanForNsfw	POST /video/scan/nsfw	Scan a Video for NSFW content.
VideoApi	videoSplitVideo	POST /video/split	Split a Video into Two Shorter Videos

Documentation For Models

• MediaInformation
• NsfwResult
• NsfwScannedFrame
• SplitVideoResult
• StillFrame
• StillFramesResult
• VideoFile

Documentation For Authorization

Apikey

• Type: API key
• API key parameter name: Apikey
• Location: HTTP header

Author