kaleidoscopejs
Advanced tools
# Kaleidoscope
An embeddable, lightweight, dependency-free 360º video/image viewer
Get the code:
$ npm install kaleidoscopejs
Add the script to your page:
<script src="node_modules/kaleidoscopejs/dist/kaleidoscope.min.js"></script>
var viewer = new Kaleidoscope.Video({source: 'equirectangular-video.mp4', containerId: '#target'});
viewer.render();
var viewer = new Kaleidoscope.Image({source: 'equirectangular-image.jpg', containerId: '#target'});
viewer.render();
let viewer = new Kaleidoscope.Video(options)
options.source source video to be played. This can be either a video tag or an url to the video file. Passing a tag is useful when embedding in player or using adaptative streaming.
options.containerId is where you want to render the 360, this is going to be retrieved via document.querySelector and when you call render() the 360 canvas will be append to it.
options.container HTML element to attach the 360 canvas to. You should always either pass a containerId or a container.
options.height height of the 360 canvas. Defaults to 360.
options.width width of the 360 canvas. Defaults to 640.
options.autoplay to autoplay the video once rendered. Doesn't work on mobile. Defaults to true.
options.muted to define if the video should start muted. Defaults to false.
options.initialYaw number to define initial yaw of 360, should be in degrees(45, 90, 180 etc).
options.loop to define if the video should loop. Defaults to false.
options.onError callback to when something goes wrong.
options.verticalPanning disables vertical panning. Defaults to false.
options.onDragStart callback called when user interaction starts.
options.onDragStop callback called when user interaction ends.
viewer.render() renders the canvas in the defined containerId or container.
viewer.play() starts the current video. Useful for mobile.
viewer.pause() pauses the current video.
viewer.centralize() move camera back to the original center.
let viewer = new Kaleidoscope.Image(options)
options.source source of the image to be rendered. This can be either an url to the image or the img tag itself.
options.containerId is where you want to render the 360, this is going to be retrieved via document.querySelector and when you call render() the 360 canvas will be append to it.
options.container HTML element to attach the 360 canvas to. You should always either pass a containerId or a container.
options.height height of the 360 canvas. Defaults to 360.
options.width width of the 360 canvas. Defaults to 640.
options.initialYaw number to define initial yaw of 360, should be in degrees(45, 90, 180 etc).
options.verticalPanning disables vertical panning. Defaults to false.
options.onDragStart callback called when user interaction starts.
options.onDragStop callback called when user interaction ends.
options.onError callback to when something goes wrong.
viewer.render() renders the canvas in the defined containerId or container.
viewer.centralize() move camera back to the original center.
*Most recent versions.
360 videos doesn't work in Safari, IE 11, Microsoft Edge, Android and iOS if the video is served from a different domain, due some CORS implementation bugs.
FAQs
360º video/image viewer
The npm package kaleidoscopejs receives a total of 374 weekly downloads. As such, kaleidoscopejs popularity was classified as not popular.
We found that kaleidoscopejs demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Research
Security News
The Socket Research Team has discovered six new malicious npm packages linked to North Korea’s Lazarus Group, designed to steal credentials and deploy backdoors.
Security News
Socket CEO Feross Aboukhadijeh discusses the open web, open source security, and how Socket tackles software supply chain attacks on The Pair Program podcast.
Security News
Opengrep continues building momentum with the alpha release of its Playground tool, demonstrating the project's rapid evolution just two months after its initial launch.