Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/escolalms/video
Video Processing to generate `hls` streaming formats
https://github.com/escolalms/video
api-rest ffmpeg laravel queue video
Last synced: 3 days ago
JSON representation
Video Processing to generate `hls` streaming formats
- Host: GitHub
- URL: https://github.com/escolalms/video
- Owner: EscolaLMS
- License: mit
- Created: 2021-09-16T14:05:32.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2024-02-14T14:26:36.000Z (9 months ago)
- Last Synced: 2024-03-14T16:24:05.328Z (8 months ago)
- Topics: api-rest, ffmpeg, laravel, queue, video
- Language: PHP
- Homepage:
- Size: 1.12 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Video
[](https://codecov.io/gh/EscolaLMS/Video)
[](https://github.com/EscolaLMS/Video/actions/workflows/test.yml)
[](https://packagist.org/packages/escolalms/video)
[](https://packagist.org/packages/escolalms/video)
[](https://packagist.org/packages/escolalms/video)
## What does it do
Coverts TopicVideo into HLS stream.
## Installing
- `composer require escolalms/video`
## Requirements
- `ffmpeg` must be installed
- Once `EscolaLms\TopicType\TopicTypeChanged` is dispatched job [ProccessVideo](src/Jobs/ProccessVideo.php) added to queue
## Configuration
You can configure the quality and resolution of the processed video by setting values in `config.php` file under the `bitrates` key. The key takes arrays of values.
- `kiloBitrates` parameter is responsible for the video quality.
- `scale` parameter is responsible for video resolution, setting this parameter may cause video distortion.
You can also disable video processing or change the drive.
Example config:
```php
return [
'disk' => env('VIDEO_DISK', config('filesystems.default')),
'enable' => env('VIDEO_PROCESSING_ENABLE', true),
'bitrates' => [
[
'kiloBitrate' => 250, // video quality
'scale' => '640:480' // This parameter changes the video resolution. You can omit this parameter.
],
...
]
];
```
## Example
This package extends API resources in `EscolaLms\TopicType` package.
- `\EscolaLms\TopicTypes\Http\Resources\TopicType\Client\VideoResource` - replaces value and url fields with hls values
```json
{
"id": 1,
"value": "course/1/topic/1/video/hls.m3u8",
"url": "https://escolalms.com/course/1/topic/1/video/hls.m3u8"
}
```
- `\EscolaLms\TopicTypes\Http\Resources\TopicType\Admin\VideoResource` - adds hls values
```json
{
"id": 1,
"value": "course/1/topic/1/video/video.mp4",
"url": "https://escolalms.com/course/1/topic/1/video/video.mp4",
"hls": "course/1/topic/1/video/hls.m3u8",
"hls_url": "https://escolalms.com/course/1/topic/1/video/hls.m3u8"
}
```
The processing status is saved in the json field in the `topics` table:
- Processing successful
```json
{
"ffmpeg": {
"state": "finished",
"path": "course/1/topic/1/video/hls.m3u8"
}
}
```
- Processing failed
```json
{
"ffmpeg": {
"state" : "error",
"message" : "Unable to probe /path/video.mp4"
}
}
```
## Tests
Run `./vendor/bin/phpunit` to run tests. See [tests](tests) folder as it's quite good staring point as documentation appendix.
Test details
[](https://codecov.io/gh/EscolaLMS/Video)
[](https://github.com/EscolaLMS/Video/actions/workflows/test.yml)
## Events
1. `ProcessVideoStarted` - event dispatched after processing started
2. `ProcessVideoFailed` - event dispatched after processing failed