GithubHelp home page GithubHelp logo

meigo / svelte-video-player Goto Github PK

View Code? Open in Web Editor NEW
130.0 3.0 20.0 936 KB

Basic video player component for svelte

License: MIT License

CSS 0.39% HTML 1.16% JavaScript 18.66% Svelte 79.60% TypeScript 0.19%

svelte-video-player's Introduction

svp

Svelte Video Player

Basic video player component for svelte, sapper and legacy apps.

Controls are tabbable and respond to key presses (enter/space/arrows) where applicable.

Starting a player will pause previously playing video player instance.

Fullscreen functionality is disabled on iPhone, other than that should function fairly smoothly in both desktop and mobile browsers.

Demo

https://svelte-video-player.netlify.app/

Installation

yarn add svelte-video-player
# OR
npm install svelte-video-player

Props

Prop name Type Default value Description
width string | number 1920 Real width of video for calculating aspect ratio for responsive design
height string | number 1080 Real height of video for calculating aspect ratio for responsive design
poster string '' Absolute or relative URL of poster image
source string | string[] '' Absolute or relative URL (or array of those) of video source. Supported formats are webm, mp4 and ogg
controlsHeight string '55px' Height of bottom control bar, rescaling included components
trackHeight string '6px' Height of playbar and volume slider tracks
thumbSize string '15px' Size of playbar and volume slider thumb
centerIconSize string '60px' Size of center icon
playerBgColor string 'black' Color of player background
color string '#FF3E00' Main color of control components
focusColor string 'white' Color of focus outlines
barsBgColor string 'white' Background color of playbar and volume slider tracks
iconColor string 'white' Color of button icons
bufferedColor string '#FF9600' Color of buffered chunks
borderRadius string '8px' Rounded corner radius of the player.
skipSeconds string | number 5 Skipping time in seconds
chunkBars boolean false Display overlay with buffered and played parts of video
loop boolean false Play video in loop
controlsOnPause boolean true Show control bar when video is paused
timeDisplay boolean false Display current time beside playbar

Usage

If aspect ratio of the video is other than default 16:9 provide width and height props to player for calculating aspect ratio to prevent CLS. Real size of video player will be determined by it's parent element.

Import directly to svelte or sapper apps

See Example App.svelte.

<script>
  import VideoPlayer from 'svelte-video-player';

  const poster = 'https://www.server.com/poster.jpg';
  const source = [
    'https://www.server.com/video.webm',
    'https://www.server.com/video.mp4',
    'https://www.server.com/video.ogv',
  ];
</script>

<VideoPlayer {poster} {source} />;
<VideoPlayer poster="poster_url" source="video_url" />
<VideoPlayer width="500" height="500" poster="./local_poster.jpg" source="./local_video.mp4" loop />

For legacy apps load prebuilt script and stylesheet from unpkg.com

Example: https://codepen.io/meigo-kukk/pen/yLVMZBO

<html>
  <head>
    <link rel="stylesheet" href="https://unpkg.com/svelte-video-player@latest/dist/svelte-video-player.css" />
    <script src="https://unpkg.com/svelte-video-player@latest/dist/svelte-video-player.js"></script>

    <script>
      function initPlayer() {
        let player = new VideoPlayer({
          target: document.getElementById('player'),
          props: {
            poster:
              'https://res.cloudinary.com/animaly/image/upload/c_scale,w_960/v1608783923/ntiiorkrkxba6kmooa4u.gif',
            source:
              'https://res.cloudinary.com/animaly/video/upload/ac_aac,vc_h264/v1608783907/xixhbu5v9aawqqgiafri.mp4',
            controlsHeight: '55px',
            centerIconSize: '60px',
            color: 'deepskyblue',
          },
        });
      }
    </script>
  </head>
  <body onload="initPlayer()" style="background-color:#333">
    <div style="max-width: 600px; margin: 0 auto;">
      <div id="player" />
    </div>
  </body>
</html>

svelte-video-player's People

Contributors

meigo avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar

svelte-video-player's Issues

SSR failure

Hello, I'm trying to use svelte video on a skeleton sveltekit project with SSR enabled. During dev, it returns the following at the first page hit:

ReferenceError: window is not defined
    at /node_modules/svelte-video-player/src/libs/screenfull.js:154:7
    at /node_modules/svelte-video-player/src/libs/screenfull.js:186:3
    at instantiateModule (/home/michael/websites/mymy/node_modules/vite/dist/node/chunks/dep-63d4bd14.js:75119:15)
3:40:24 PM [vite] Error when evaluating SSR module /node_modules/svelte-video-player/src/FullscreenManager.svelte:
ReferenceError: window is not defined
    at /node_modules/svelte-video-player/src/libs/screenfull.js:152:7
    at /node_modules/svelte-video-player/src/libs/screenfull.js:184:3
    at instantiateModule (/home/michael/websites/mymy/node_modules/vite/dist/node/chunks/dep-63d4bd14.js:75119:15)
3:40:24 PM [vite] Error when evaluating SSR module /node_modules/svelte-video-player/src/VideoPlayerClient.svelte:
ReferenceError: window is not defined
    at /node_modules/svelte-video-player/src/libs/screenfull.js:150:7
    at /node_modules/svelte-video-player/src/libs/screenfull.js:182:3
    at instantiateModule (/home/michael/websites/mymy/node_modules/vite/dist/node/chunks/dep-63d4bd14.js:75119:15)
3:40:24 PM [vite] Error when evaluating SSR module /node_modules/svelte-video-player/src/VideoPlayer.svelte:
ReferenceError: window is not defined
    at /node_modules/svelte-video-player/src/libs/screenfull.js:150:7
    at /node_modules/svelte-video-player/src/libs/screenfull.js:182:3
    at instantiateModule (/home/michael/websites/mymy/node_modules/vite/dist/node/chunks/dep-63d4bd14.js:75119:15)
3:40:24 PM [vite] Error when evaluating SSR module /node_modules/svelte-video-player/src/index.js:
ReferenceError: window is not defined
    at /node_modules/svelte-video-player/src/libs/screenfull.js:150:7
    at /node_modules/svelte-video-player/src/libs/screenfull.js:182:3
    at instantiateModule (/home/michael/websites/mymy/node_modules/vite/dist/node/chunks/dep-63d4bd14.js:75119:15)
3:40:24 PM [vite] Error when evaluating SSR module /src/routes/index.svelte:
ReferenceError: window is not defined
    at /node_modules/svelte-video-player/src/libs/screenfull.js:150:7
    at /node_modules/svelte-video-player/src/libs/screenfull.js:182:3
    at instantiateModule (/home/michael/websites/mymy/node_modules/vite/dist/node/chunks/dep-63d4bd14.js:75119:15)
500
window is not defined
ReferenceError: window is not defined
    at /node_modules/svelte-video-player/src/libs/screenfull.js:150:7
    at /node_modules/svelte-video-player/src/libs/screenfull.js:182:3
    at instantiateModule (/home/michael/websites/mymy/node_modules/vite/dist/node/chunks/dep-63d4bd14.js:75119:15)
<script>
	import { browser } from '$app/env';
	import VideoPlayer from 'svelte-video-player';

	const poster = 'https://www.server.com/poster.jpg';
	const source = [
		'https://www.server.com/video.webm',
		'https://www.server.com/video.mp4',
		'https://www.server.com/video.ogv'
	];
</script>

<h1>Welcome to SvelteKit</h1>
<p>Visit <a href="https://kit.svelte.dev">kit.svelte.dev</a> to read the documentation</p>

{#if browser}
	<VideoPlayer {poster} {source} />
{/if}

feature: pass ID to video player

Hi, thank you for the component. Could you add an id prop to pass onto the video tag? That would make it easier to auto play when launched inside a modal.

Video format error

I have noticed url are checked for the extensions, and if the extension is not present, cosole.error() is invoked. Some video's url have no extension however, but the player plays them just fine. Maybe it would be beneficial to get rid of this console noise?

if you check this link for example; the video plays just fine.

video doesn't change when `source` is updated

Hi, when the components source property changes, should the video that's displayed be updated?

My test case:

<script>
    import VideoPlayer from 'svelte-video-player';
    let src1 = 'https://res.cloudinary.com/dvm02rtnk/video/upload/v1628057414/blender/HERO_Blender_Grease_Pencil_Showcase_1080p_ctsjpy.mp4';
    let src2 = 'https://res.cloudinary.com/dvm02rtnk/video/upload/v1628057411/blender/Agent_327_Operation_Barbershop_1080p_hf1iq7.mp4';

    let source = "please select a video";
</script>
<h1>svelte-video-player</h1>
<div style="max-width: 40%">
    <div>
    Select
    <button on:click={() => source = src1}>Video 1</button>
    <button on:click={() => source = src2}>Video 2</button>
    </div>
    <div>
    Currently playing: {source}
    </div>
    <VideoPlayer bind:source={source} />
</div>

Pressing a button changes source, but VideoPlayer seems to want to play please select a video (if I do let source = src1 is player the first video, always.

No fullscreen control available

Hi,
I am using this component svelte-kit. (new to the whole thing)

Whenever I try to import this component, I get ReferenceError : window is not defined which mostly comes from screenfull.js

Post that I tried to import the component dynamically (as shown below) ,

  onMount(async () =>{
      VideoPlayer = (await import('svelte-video-player')).default;
 
  })

now the component is renderinh successfully but the full screen control still doesn't show up, I also tried below but this didn't work either.

  onMount(async () =>{
    if(typeof window !== 'undefined' && typeof window.document !== 'undefined' ){
      VideoPlayer = (await import('svelte-video-player')).default;
    }
  })

Not sure what exactly is the issue. Can you help?
Screenshot 2021-08-14 at 6 13 17 PM

Feature request: Hls support

This lib looks great. Would be great if there was Hls support—is this something you're planning on adding? ..I'm trying to figure out what would be involved in adding this functionality..

First frame as poster image

Would it be possible to add the option to just use the first frame (or any specified frame) of the video as the poster picture instead of having to create and link an external image?
Thanks for the module it works great!

Info request - autoplay or seeking from outside the component

First of all, thank you for the player;

I am probably missing some basic information;

is there a way to cause video seeking to a specific time , or play/pause from an external event instead of a user interaction?

like

  • "autoplay onmount"
  • seek to 00:05 when the user click a specfic button on page

thank you

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.