Added readme

This commit is contained in:
Muaz Ahmad 2023-08-24 14:23:04 +05:00
parent da31feba15
commit db63b7013c

15
README.md Normal file
View file

@ -0,0 +1,15 @@
# hls-player.js
Extremely basic hls player using MediaSource extensions.
Meant to be a custom replacement for hls.js for the stream-server repo
**Not a drop-in replacement nor intended for actual use**. Meant to just be used with the way stream-server handles the http serving.
Currently only works with a single playlist file (not the manifest playlist)
Only works with fragmented mp4, not mpegts. Requires h264 video and mp4a audio. Should be able to parse the codec profile automatically given the above.
Use requires an html5 `<video>` tag. If attributes `autoplay muted` are set, can be used by adding this script: `<script>var x = new VideoLoader('video_tag_id')</script>`. Otherwise add extra code to handle playing, etc.
Simplest export is `cat *.js > /path/to/output.js`. Minify, rename, do whatever extra bits you want.