Skip to content

vimeo/vimeo-depth-player

Repository files navigation

Vimeo Depth Player

License Codeship Status PRs Welcome Glitch Examples status

A WebVR volumetric video renderer that uses color-depth based videos hosted on Vimeo.

This repository consists of tools and demos presetned at the Volumetric Filmmaking meetup at NYC.
Check out our demo and our complimentary three.js player repository.

Examples

Demo Livestreaming demo Check out our volumetric playback and volumetric live-streaming demos.

Features

📼 Render volumetric video: The plugin lets you render volumetric video hosted on Vimeo

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

📱 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

Upload your volumetric video to Vimeo. If you are using Depthkit footage, remember to put the metadata in the video description.

Next 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 example javascript file under client.js and change the video id in line 40 to your Vimeo video id. It should look like

 // Create a new Vimeo Player and set the video
 vimeoPlayer = new Vimeo.Player(your_vimeo_video_id, {
   autoplay: false,
   autoload: true
 });

For our full three.js player documentation visit this page

Streaming Vimeo videos requires video file access via the Vimeo API. Accessing video files is limited to Vimeo Pro and Business customers.

Questions

For questions and support, open a new issue on Github.

License

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

Thanks

Special thanks to three.js, Depthkit and Depthkit.js