Skip to content

grt107/grt-js-video-player

Repository files navigation

GRT JS Video Player

LightWeight Free Javascript Video Player.

Simple and lightweight JavaScript HTML5 video player used for playing different video formats on websites.

This player supports all the basic modern features. You can change aspect ratio, autoplay, full screen, PIP (picture in picture), volume, controls visibility, and much more. Please read the integration below for all the available options.

You can check the demo here: grt107.github.io/grt-js-video-player/

Screenshot:

Alt text

How to use the plugin in your website:

1- Include the player stylesheet file grt-js-video-player.css inside the <head> tag.

<link rel="stylesheet" href="grt-js-video-player.css">

2- Include the javascript file grt-js-video-player.js before the closing <body> tag.

<script src="grt-js-video-player.js"></script>

3- Add the following div inside your document body and change the video url on the grtvideoplayer-url attribute.

  <div grtvideoplayer-url="https://commondatastorage.googleapis.com/gtv-videos-bucket/sample/BigBuckBunny.mp4"></div>

4- Initialize the javascript after grt-js-video-player.js and before the closing <body> tag.

  <script> 
  	grtVideoPlayer.init();
  </script>

Advanced Options

All options available demo code:

<script> 
	grtVideoPlayer.init({ 
		aspectRatio: "16x9", // Change video aspect ratio. Accepts values: 16x9, 1x1 , 4x3, 5x4, 3x2, 21x9, 9x16, 3x4, 4x5, 2x3. Default is 16x9. 
		controls: true, // Enable or disable controls. Accepts values true or false. Default is true. 
		clickToPlay: true,// Click on the whole video container to play/pause video. Accepts values true or false. Default is true. 
		autoPlay: false, // Enable or disable autoplay. Accepts values true or false. Default is false. 
		muted: false, // Enable or disable sound on video. Accepts values true or false. Default is false. 
		volume:90, // Set the volume level on video. It accepts values from 0 to 100. Default is set to 80. 
		fullScreenButton: true, // Enable or disable the FullScreen button on controls. It accepts values true or false. Default is set to true. 
		pipButton: true, // Enable or disable the PIP button on controls. It accepts values true or false. Default is set to true. 
		speedButton: true, // Enable or disable the Speed button on controls. It accepts values true or false. Default is set to true. 
	});
</script>

Aspect Ratio

You can change video aspect ratio. It accepts values: 16x9, 1x1 , 4x3, 5x4, 3x2, 21x9, 9x16, 3x4, 4x5, 2x3. Default is set to 16x9.

<script> 
grtVideoPlayer.init({ 
  aspectRatio: "4x3", 
});
</script>

Controls

You can change controls visibility. It accepts values true or false. Default is set to true.

<script> 
grtVideoPlayer.init({ 
  controls: false,
});
</script>

Click To Play

You can click on the whole video container to play/pause video. It accepts values true or false. Default is set to true.

<script> 
grtVideoPlayer.init({ 
  clickToPlay: false,
});
</script>

AutoPlay

You can enable or disable autoplay. It accepts values true or false. Default is set to false. In some devices and browsers (especially mobile), the autoplay will work only if the video is also muted.

<script> 
grtVideoPlayer.init({ 
   autoPlay: true,
});
</script>

Muted

You can enable or disable sound on the video player. It accepts values true or false. Default is set to false.

<script> 
grtVideoPlayer.init({ 
   muted: true,
});
</script>

Volume

You can set the volume level on video. It accepts values from 0 to 100. Default is set to 80.

<script> 
grtVideoPlayer.init({ 
   volume: 75,
});
</script>

FullScreen Button

You can enable or disable the FullScreen button on controls. It accepts values true or false. Default is set to true.

<script> 
grtVideoPlayer.init({ 
   fullScreenButton: false,
});
</script>

PIP Button

You can enable or disable the PIP button on controls. It accepts values true or false. Default is set to true.

<script> 
grtVideoPlayer.init({ 
   pipButton: false,
});
</script>

Speed Button

You can enable or disable the Speed button on controls. It accepts values true or false. Default is set to true.

<script> 
grtVideoPlayer.init({ 
   speedButton: false,
});
</script>

About

GRT JS Video Player - LightWeight Free Javascript Video Player.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published