Skip to content

vimeo/aframe-vimeo-component

Repository files navigation

Vimeo A-Frame component

An A-Frame component for streaming video from Vimeo to WebGL/VR/AR apps

Build Status Code Style Glitch Examples status License

Getting startedWikiStay in touch

Examples

Basic Shapes 360 WebVR Playback Control

Features

📼 Streaming video made simple: The component lets you stream video hosted on Vimeo directly to your A-Frame app

🏋🏿‍ Let us do the heavy lifting: stream multiple resolutions including adaptive video on supported platforms for best performance and video quality

📱 Works everywhere: works on phones, tablets, laptops, computers, VR headsets and even underwater

Usage

To start playing and streaming video now, remix the Glitch example:

Glitch remix badge

The first step is to generate your own Vimeo API token. Generate the token, and then copy it and paste it into the .env in Glitch.

Almost done, go to the basic example under examples/basic.html and change the video id in line in to your Vimeo video id. It should look like

 <a-entity vimeo="id: vimeo_video_id">

Try our other examples or head to our Getting Started guide to learn more

Streaming Vimeo videos requires video file access via the Vimeo API. Accessing video files is limited to Vimeo Pro and Business customers. Also, for security reasons, it is necessary to run the included server which communicates with the API, if you are interested in learning more checkout our threejs-player repository which this component is based on.

Questions

For questions and support, open a Github issue.

Contributing

Get involved! Check out the Setting up the development environment guide for how to get started.

License

This software is free software and is distributed under an MIT License.