...
Table of Contents |
---|
Overview
The player shows how to convert stream published on WCS server to HLS and play it in browser using HLS.js. HLS stream segments cut starts automatically when strea stream is requested by HLS URL, for example example `https://demotest1.flashphoner.com:8445/test/test.m3u8` on the screenshot below
Since build 2.0.244, the example supports the following parameters:
- llhls - enable Low Latency HLS support:
false
ortrue
- src - stream full HLS URL to play, should be encoded with URI, for example
https%3A%2F%2Ftest1.flashphoner.com%3A8445%2Ftest%2Ftest.m3u8
- autoplay - automatically play the HLS URL, in this case all the input fields and buttons are hidden:
false
(by default) ortrue
The player URL example with parameters as displayed on the screenshot above (the link is available in Permalink
field)
Code Block | ||
---|---|---|
| ||
https://test1.flashphoner.com:8444/client2/examples/demo/streaming/hls-js-player/hls-js-player.html?llhls=false&src=https%3A%2F%2Ftest1.flashphoner.com%3A8445%2Ftest%2Ftest.m3u8 |
The player URL example with autoplay enabled
Code Block | ||
---|---|---|
| ||
https://test1.flashphoner.com:8444/client2/examples/demo/streaming/hls-js-player/hls-js-player.html?llhls=false&src=https%3A%2F%2Ftest1.flashphoner.com%3A8445%2Ftest%2Ftest.m3u8&autoplay=true |
In this case the stream should be played automatically with audio muted. A viewer should use a loud slider in the player interface to unmute audio.
The code of the example
The source code can be accessed on server by the following path:
...
hls-js-player.css - player page styles file
hls-js-player.html - player page
hls.js - player script (https://github.com/video-dev/hls.js/, Apache License Version 2.0)
hls-js-player.js - player launch script
hls.min.js - player script (minimized)
../hls-player/player-page.html - common player page elements for three HLS playback examples
The example can be tested using the fiollowing URL:
...
Where host is WCS server address
Analyzing the code
...
To analize analyze the code get hls-js-player.js file version with hash 51703a2 1703e13 which is available available here and and can be downloaded in build build 2.0.5.28.2753.141244.
1. A server HLS URL detectiongetHLSUrl() Loading the player page
Code Block | ||||
---|---|---|---|---|
| ||||
function initPageconst loadPlayerPage = function() { $loadPage("#header").text("HLS.JS Player Minimal"); $("#urlServer").val(getHLSUrl()); ...../hls-player/player-page.html", "playerPage", initPage ); } |
2. div element set up to pass to the player
A div element for stream playback is passed to playerThe player HTML page initializing
If browser does not support MSE, player will not be initialized and a warning will be displayed
Code Block | ||||
---|---|---|---|---|
| ||||
const initPage = function initPage(() { if (playSrc) { setValue("fullLink", decodeURIComponent(playSrc)); } else if (autoplay) { ... console.warn("No HLS URL set, autoplay disabled"); autoplay = false; } if (llHlsEnabled) { setCheckbox("llHlsEnabled", llHlsEnabled); } remoteVideo = document.getElementById('remoteVideo'); remoteVideo.style ="background-color: lightgrey;"; } |
3. Stream name detection (the stream should be published to server)
encodeURIComponent() code
Code Block | ||||
---|---|---|---|---|
| ||||
function playBtnClick() { if (validateForm()) if (Hls.isSupported()) { console.log("Using HLS.JS " + Hls.version); if (autoplay) { // There should not be any visible item on the page unless player hideAllToAutoplay(); // The player should use all available page width setUpPlayerItem(true); // The player should be muted to automatically start playback initVideoPlayer(remoteVideo, true); playBtnClick(); } else { setText("header", "HLS.JS Player Minimal"); showItem("llHlsMode"); displayCommonItems(); setUpButtons(); enablePlaybackStats(); // The player should have a maximum fixed size setUpPlayerItem(false); // The player can be unmuted because user should click Play button initVideoPlayer(remoteVideo, false); } } else { var streamName = $('#playStream').val(setText("notifyFlash", "Your browser doesn't support MSE technology required to play video"); disableItem("applyBtn"); toggleInputs(false); streamName = encodeURIComponent(streamName);} } |
3. Video tag initializing to play
Code Block | ||||
---|---|---|---|---|
| ||||
const initVideoPlayer = function(video, muted) { if (video) { video.style.backgroundColor = "black"; video.muted = muted; } } |
4. HLS HLS stream URL forming
If authentication key and token are set, they will be inclueded included to stream URL
Code Block | ||||
---|---|---|---|---|
| ||||
function playBtnClick(const getVideoSrc = function(src) { let videoSrc = src; if (validateForm()) { ... let streamName = getValue('playStream'); streamName = encodeURIComponent(streamName); var videoSrc = $getValue("#urlServerurlServer").val() + '/' + streamName + '/' + streamName + '.m3u8'; varlet key = $getValue('#keykey').val(); varlet token = $getValue("#tokentoken").val(); if (key.length > 0 && token.length > 0) { videoSrc += "?" + key + "=" + token; } } ... setValue("fullLink", videoSrc); }return videoSrc; } |
5. Player starting
If browser does not support MSE, player will not be started and a warning will be displayed. HLS.js player configuration
Code Block | ||||
---|---|---|---|---|
| ||||
function playBtnClick(const getHlsConfig = function(llHlsEnabled) { if (validateForm()) {let config = { lowLatencyMode: false, enableWorker: true, ... backBufferLength: 90, manifestLoadingTimeOut: 15000 if (Hls.isSupported()}; console.log("Low Latency HLS: "+llHlsEnabled) if(llHlsEnabled) { // Here we configure HLS.JS for lower latency var hls = new Hls()config = { lowLatencyMode: llHlsEnabled, enableWorker: true, backBufferLength: 90, liveBackBufferLength: 0, liveSyncDuration: 0.5, liveMaxLatencyDuration: 5, liveDurationInfinity: true, highBufferWatchdogPeriod: 1, manifestLoadingTimeOut: 15000 }; } return config; } |
6. Player launching
Code Block | ||||
---|---|---|---|---|
| ||||
const playBtnClick = hls.loadSource(videoSrcfunction() { let videoSrc = getVideoSrc(getValue("fullLink")); if (videoSrc) { llHlsEnabled = hls.attachMedia(remoteVideogetCheckbox("llHlsEnabled"); hlsPlayer = new Hls(getHlsConfig(llHlsEnabled)); hlshlsPlayer.on(Hls.Events.MANIFEST_PARSED, function() { console.log("Play with HLS.js"); remoteVideo.play(); }); remoteVideo.onplaying = onStarted(); => { console.log("playing event fired"); }displayPermalink(videoSrc); } else {hlsPlayer.loadSource(videoSrc); hlsPlayer.attachMedia(remoteVideo); $("#notifyFlash").text("Your browser doesn't support MSEonStarted(); technology required to play video"); } } } |
67. Playback stopping
Code Block | ||||
---|---|---|---|---|
| ||||
functionconst stopBtnClick = function() { if (hlsPlayer != null) { console.log("Stop HLS segments loading"); hlsPlayer.stopLoad(); hlsPlayer = null; } if (remoteVideo != null) { console.log("Stop HTML5 player"); remoteVideo.pause(); remoteVideo.currentTime = 0; remoteVideo.removeAttribute('src'); remoteVideo.load(); } onStopped(); } |
8. Getting an available playback statistics from HTML5 video tag
HTML5Stats code
Code Block | ||||
---|---|---|---|---|
| ||||
const PlaybackStats = function(interval) { const playbackStats = { interval: interval || STATS_INTERVAL, timer: null, stats: null, start: function() { let video = remoteVideo; playbackStats.stop(); stats = HTML5Stats(video); playbackStats.timer = setInterval(playbackStats.displayStats, playbackStats.interval); setText("videoWidth", "N/A"); setText("videoHeight", "N/A"); setText("videoRate", "N/A"); setText("videoFps", "N/A"); showItem("stats"); }, stop: function() { if (playbackStats.timer) { clearInterval(playbackStats.timer); playbackStats.timer = null; } playbackStats.stats = null; hideItem("stats"); }, displayStats: function() { if (stats.collect()) { let width = stats.getWidth(); let height = stats.getHeight(); let bitrate = stats.getBitrate(); let fps = stats.getFps(); setText("videoWidth", width); setText("videoHeight", height); if (bitrate !== undefined) { setText("videoRate", Math.round(bitrate)); } if (fps !== undefined) { setText("videoFps", fps.toFixed(1)); } } } }; return playbackStats; } |