amphibee/laravel-coconut

A Wrapper around coconut transcoding library for laravel

1.0.1 2023-07-31 21:45 UTC

Requires

• php: ^8.1|^8.2
• illuminate/support: ^10.0
• opencoconut/coconut: ^3.0

Requires (Dev)

• orchestra/testbench: ^6.0
• phpunit/phpunit: ^10.0

MIT

• AmphiBee
• Nidhal Abidi

• amphibee
• nidhalkratos
• laravel-coconut

README

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 amphibee/laravel-coconut

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=

or these one if you use FTP

# .env
COCONUT_STORAGE_PUBLIC_HOST=
COCONUT_FTP_STORAGE_URL=

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

• v1.0 Laravel 10 compatibility
• v1.0.1 Added ftp and coconut storage, update route event

Credits

• Nidhal Abidi
• All Contributors

License

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