cloudinary / video-live-streaming
Use the Video Live Streaming API to create and manage your RTMP live streams. This includes managing outputs as well as manually starting and stopping streams. See the [live streaming guide](https://cloudinary.com/documentation/video_live_streaming) for information on how to use the Live Streaming A
Requires
- php: ^8.1
- ext-curl: *
- ext-json: *
- ext-mbstring: *
- guzzlehttp/guzzle: ^7.4.5
- guzzlehttp/psr7: ^2.0
Requires (Dev)
- friendsofphp/php-cs-fixer: ^3.5
- overtrue/phplint: ^9.0
- phpunit/phpunit: ^9.0
README
Use the Video Live Streaming API to create and manage your RTMP live streams. This includes managing outputs as well as manually starting and stopping streams. See the live streaming guide for information on how to use the Live Streaming API to stream video to your users.
Note: The Live Streaming API is currently in development and is available as a Public Beta, which means we value your feedback, so please feel free to share any thoughts with us.
The API supports Basic Authentication using your Cloudinary API Key and API Secret (which can be found on the Dashboard page of your Cloudinary Console).
For more information, please visit https://support.cloudinary.com.
Installation & Usage
Requirements
PHP 8.1 and later.
Composer
To install the bindings via Composer, add the following to composer.json
:
{ "require": { "cloudinary/video-live-streaming": "*" } }
Then run composer install
Manual Installation
Download the files and include autoload.php
:
<?php require_once('/path/to/video-live-streaming/vendor/autoload.php');
Configuration
The API uses Basic Authentication over HTTPS.
You can find your product environment configuration credentials in the API Keys page of the Cloudinary Console Dashboard.
You can either pass configuration with each $apiInstance
initialization:
<?php require_once(__DIR__ . '/vendor/autoload.php'); // Configure Cloudinary URL: basicAuth $config = Cloudinary\Video\LiveStreaming\Configuration::getDefaultConfiguration() ->setCloudinaryUrl('cloudinary://key:secret@cloud_name'); $apiInstance = new Cloudinary\Video\LiveStreaming\Api\LiveStreamApi(null, $config);
Or set the environment variable globally.
For example, to set a temporary environment variable:
-
On Mac or Linux:
export CLOUDINARY_URL=cloudinary://key:secret@cloud_name
-
On Windows:
set CLOUDINARY_URL=cloudinary://key:secret@cloud_name
And then you can simply initialize $apiInstance
as follows:
<?php require_once(__DIR__ . '/vendor/autoload.php'); $apiInstance = new Cloudinary\Video\LiveStreaming\Api\LiveStreamApi();
Getting Started
Please follow the installation procedure and then run the following:
<?php require_once(__DIR__ . '/vendor/autoload.php'); $apiInstance = new Cloudinary\Video\LiveStreaming\Api\LiveStreamApi(); try { $result = $apiInstance->getLiveStreams(); print_r($result); } catch (Exception $e) { echo 'Exception when calling LiveStreamApi->getLiveStreams: ', $e->getMessage(), PHP_EOL; }
API Endpoints
All URIs are relative to https://api.cloudinary.com/v2/CLOUD_NAME/video, except if the operation defines another base path.
Models
- ErrorWrappedResponse
- LiveStreamCreatePayload
- LiveStreamInputCreatePayload
- LiveStreamInputResponse
- LiveStreamOutputCreatePayload
- LiveStreamOutputResponse
- LiveStreamOutputUpdatePayload
- LiveStreamOutputWrappedResponse
- LiveStreamOutputsWrappedResponse
- LiveStreamResponse
- LiveStreamUpdatePayload
- LiveStreamWrappedResponse
- LiveStreamsWrappedResponse
- MessageWrappedResponse
- MessageWrappedResponseData
Authorization
basicAuth
- Type: HTTP basic authentication
Tests
To run the tests, use:
composer install vendor/bin/phpunit
Author
About this package
This Video Live Streaming (Beta) PHP package is automatically generated.
- Package version:
0.1.0
- API version:
0.1.9
- Build package:
org.openapitools.codegen.languages.PhpNextgenClientCodegen