https://github.com/vimeo/vimeo-threejs-player
A plugin for streaming video from Vimeo to WebGL/VR/AR apps
https://github.com/vimeo/vimeo-threejs-player
augmented-reality plugin threejs video vimeo virtual-reality webgl
Last synced: 5 days ago
JSON representation
A plugin for streaming video from Vimeo to WebGL/VR/AR apps
- Host: GitHub
- URL: https://github.com/vimeo/vimeo-threejs-player
- Owner: vimeo
- License: mit
- Created: 2018-11-03T17:41:11.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2023-03-13T00:44:07.000Z (about 2 years ago)
- Last Synced: 2025-04-03T22:41:36.288Z (26 days ago)
- Topics: augmented-reality, plugin, threejs, video, vimeo, virtual-reality, webgl
- Language: JavaScript
- Homepage: https://vimeo-threejs-player.glitch.me/
- Size: 3.12 MB
- Stars: 90
- Watchers: 17
- Forks: 21
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Vimeo three.js player
A plugin for streaming video from Vimeo to WebGL/VR/AR apps
## Examples
## Features
📼 **Streaming video made simple**: The plugin lets you stream video hosted on Vimeo directly to your WebGL 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:
The first step is to generate your own Vimeo API token. [Generate the token](https://vimeo-authy.herokuapp.com/auth/vimeo/webgl), 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 77](https://github.com/vimeo/vimeo-threejs-player/blob/master/examples/basic.html#L77) to your Vimeo video id. It should look like
```js
vimeoPlayer = new Vimeo.Player(vimeo_video_id, { autoplay: false });
```
Try our other examples or head to our [getting started guide](https://github.com/vimeo/vimeo-threejs-player/wiki/Getting-Started-%F0%9F%9A%80) to learn more
> Streaming Vimeo videos requires video file access via the Vimeo API. Accessing video files is limited to [Vimeo Pro and Business](https://vimeo.com/upgrade) customers.
## Questions
For questions and support, ask on [StackOverflow](https://stackoverflow.com/questions/ask/?tags=vimeo)
## Contributing
Get involved! Check out the [Setting up the development environment guide](https://github.com/vimeo/vimeo-threejs-player/wiki/Setting-up-the-development-environment-%F0%9F%91%B7%F0%9F%8F%BD%E2%80%8D) for how to get started.
## License
This software is free software and is distributed under an [MIT License](LICENSE).