Giter Site home page Giter Site logo

naeramarth7 / aframe-video-shader Goto Github PK

View Code? Open in Web Editor NEW

This project forked from mayognaise/aframe-video-shader

0.0 2.0 0.0 21.75 MB

A shader to display video for A-Frame VR.

Home Page: http://mayognaise.github.io/aframe-video-shader/basic

License: MIT License

JavaScript 100.00%

aframe-video-shader's Introduction

AFrame Video Shader

A shader to display video for A-Frame VR. Inspired by @Jam3's ios-video-test

DEMO

example

Notes

  • This was made for inline video playback for iPhone. If you only support desktop/android, please use flat instead for better performance.

Limitation

  • Currently only videos under SAME DOMAIN can be played with any browsers on iOS devices and desktop Safari.
  • Large/long video mostly gets error. More about limitation, please see here

Properties

  • Basic material's properties are supported.
  • The property is pretty much same as flat shader besides repeat. Will update it soon.
  • autoplay will be useful when Method is ready.
  • muted is currently always true. Will be supported soon.
  • loop is currently always true. Will be supported soon.
  • filter property will be supported soon.
  • pause controls the playback.
Property Description Default Value
src image url. @see Textures null
autoplay play automatecally once it's ready true
preload preload video (this works for only desktop) true
muted mute or unmute true (currently always true.)
loop loop video true (currently always true.)
fps video fps 60
volume video volume undefined
pause video playback false

For refference, please check the following links:

MediaElement properties will be supported soon.

Method

MediaElement methods will be supported soon.

Events

Media events will be supported soon.

Usage

Browser Installation

Install and use by directly including the browser files:

<head>
  <title>My A-Frame Scene</title>
  <script src="https://aframe.io/releases/0.2.0/aframe.min.js"></script>
  <!-- NOTE: somehow `aframe-video-shader` makes error ๐Ÿ˜ข so it's been `aframe-vid-shader.min.js` for now -->
  <script src="https://rawgit.com/mayognaise/aframe-video-shader/master/dist/aframe-vid-shader.min.js"></script>
</head>

<body>
  <a-scene>
    <a-entity geometry="primitive:box;" material="shader:video;src:url(bbb.mp4);"></a-entity>
  </a-scene>
</body>

NPM Installation

Install via NPM:

npm i -D aframe-video-shader

Then register and use.

import 'aframe'
import 'aframe-video-shader'

aframe-video-shader's People

Contributors

mayognaise avatar naeramarth7 avatar

Watchers

 avatar  avatar

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.