nidhalkratos/laravel-coconut-v2

A Wrapper around coconut transcoding library for laravel

0.0.3 2021-12-20 02:13 UTC

This package is auto-updated.

Last update: 2024-11-20 09:03:36 UTC


README

Latest Version on Packagist Total Downloads

A laravel wrapper package for coconut transcoding api. Check the official php library at https://github.com/opencoconut/coconutphp for more

Installation

You can install the package via composer:

composer require nidhalkratos/laravel-coconut-v2

Usage

Set these environment variables to let coconut connect to the gcs bucket

# .env
COCONUT_API_KEY=
COCONUT_GCS_BUCKET=
COCONUT_GCS_KEY=
COCONUT_GCS_SECRET=

The package will fire an event whenever a coconut sends a notification and thus you need to create a listeners for the event to fire whenever the event is fired Coconut will send webhook events to the route named coconut.callback (Created by the package)

// Create a coconut instance
$coconut = app('coconut');
$coconut->notification = [
    'type' => 'http',
    'url' =>  route('coconut.callback',$this->id),
    'metadata' => true
];

//Parameters
$jobParams = [
    'input' => ['url' => $this->rawUrl()],
    'outputs' => [
        'jpg:720x' => Storage::disk('gcs')->path($this->THUMBNAIL_DIRECTORY_PATH . $this->id . '.jpg') 
    ]
];

//Create the job
$job = $coconut->job->create($jobParams);

Testing

composer test

Changelog

Please see CHANGELOG for more information what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security

If you discover any security related issues, please email nidhalkratos@gmail.com instead of using the issue tracker.

Credits

License

The MIT License (MIT). Please see License File for more information.

Laravel Package Boilerplate

This package was generated using the Laravel Package Boilerplate.