Have ideas to improve npm?Join in the discussion! »

a-recorder

1.0.0 • Public • Published

aframe-recorder

Recording component for A-Frame using MediaRecorder

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

Prerequisites

This component is compatible with A-Frame 0.5, 0.6 and 0.7

Usage

To use this component, include the component as follows

<script src="https://aframe.io/releases/0.6.1/aframe.min.js"></script>
<script src="./a-recorder.js"></script>
<a-scene>
  <a-entity recorder="recording.webm"></a-recorder>
  <!-- insert the rest of your a-scene -->
</a-scene>

To start recording, you can either

  • send a start event to the component or
  • use document.querySelector([recorder]).components.recorder.start()

To end the recording, you can either

  • send a stop event to the component or
  • use document.querySelector([recorder]).components.recorder.stop()

See the live example here.

Deployment

This component is deployed via npm.

Built With

Contributing

All contributions are welcome. For typos, small bug fixes and small improvements, please feel free to submit a Pull Request. If you are not sure if you have found a bug or have some larger scale changes in mind, please open an issue so duplication of work and misunderstandings can be avoided.

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

Authors

  • Ben Devine - Idea, Prototype - bnjm
  • Martin Splitt - Code, Documentation - avgp See also the list of contributors who participated in this project.

License

This project is licensed under the MIT License - see the LICENSE.md file for details

Acknowledgments

  • The A-Frame team and community for building A-Frame and inspiring us to make 3D and VR on the web easier

Install

npm i a-recorder

DownloadsWeekly Downloads

2

Version

1.0.0

License

ISC

Last publish

Collaborators

  • avatar
  • avatar