Skip to content

Commit eca126a

Browse files
committedFeb 12, 2019
add helpers and uml diagram
1 parent 2d32e32 commit eca126a

File tree

1 file changed

+9
-4
lines changed

1 file changed

+9
-4
lines changed
 

‎README.md

+9-4
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ composer require aminyazdanpanah/php-ffmpeg-video-streaming
2323
``` php
2424
require 'vendor/autoload.php'; // if you use frameworks that require autoload, you do not need to require it
2525

26-
$path = ''/var/www/media/videos/test.mp4'';// the path to the video
26+
$path = '/var/www/media/videos/test.mp4';// the path to the video
2727

2828
dash($path);// auto create dash MPD file based on original video
2929
hls($path);// auto create HLS M3U8 file based on original video
@@ -39,8 +39,11 @@ This is how it works:
3939

4040

4141
### DASH
42-
You can create an MPD playlist to do [DASH](https://en.wikipedia.org/wiki/Dynamic_Adaptive_Streaming_over_HTTP).
42+
**[Dynamic Adaptive Streaming over HTTP (DASH)](https://en.wikipedia.org/wiki/Dynamic_Adaptive_Streaming_over_HTTP)**, also known as MPEG-DASH, is an adaptive bitrate streaming technique that enables high quality streaming of media content over the Internet delivered from conventional HTTP web servers.
4343

44+
To create an MPD file use `DASH` method and export video into Dash.
45+
46+
4447
As of version 1.1.0, the ```autoGenerateRepresentations``` method has been added. This method allows you to create a multi-representations MPD file automatically based on the video size and bit rate:
4548

4649
``` php
@@ -53,7 +56,7 @@ AYazdanpanah\FFMpegStreaming\FFMpeg::create()// it can pass the configuration an
5356
->save(); // it can pass a path to the method or it can be null
5457
```
5558

56-
or you can add representation manually by using ```addRepresentation``` method:
59+
Also you can add representation manually by using ```addRepresentation``` method:
5760

5861
``` php
5962
$rep_1 = (new Representation())->setKiloBitrate(800);
@@ -73,7 +76,9 @@ AYazdanpanah\FFMpegStreaming\FFMpeg::create()// it can pass the configuration an
7376
For more information about [FFMpeg](https://ffmpeg.org/) and its dash options please [click here](https://ffmpeg.org/ffmpeg-formats.html#dash-2).
7477
### HLS
7578

76-
Create an M3U8 playlist to do [HLS](https://en.wikipedia.org/wiki/HTTP_Live_Streaming).
79+
**[HTTP Live Streaming (also known as HLS)](https://en.wikipedia.org/wiki/HTTP_Live_Streaming)** is an HTTP-based media streaming communications protocol implemented by [Apple Inc](https://www.apple.com/).
80+
81+
To create an M3U8 playlist to do HLS, just use `HLS` method.
7782

7883
As of version 1.1.0, the ```autoGenerateRepresentations``` method has been added. This method allows you to create a multi-formats M3U8 file automatically based on original video size and bit rate:
7984

0 commit comments

Comments
 (0)
Please sign in to comment.