recordrtc.org
v1.0.6
Published
http://recordrtc.org/ is a documentation webpage for RecordRTC.js. It is open-sourced in github and everyone can collaborate to improve documentation.
Downloads
5
Maintainers
Readme
RecordRTC.org
http://recordrtc.org/ is a documentation webpage for RecordRTC.js. It is open-sourced in github and everyone can collaborate to improve documentation.
To contribute:
- You should modify
RecordRTC.js
file (akalatest.js
file) - You'll see that each function/property/method is having comments (format is chosen from http://usejsdoc.org/).
- Using
jsdoc
tool, you can generate documentation HTML pages fromlatest.js
file - You should NEVER modify HTML pages. You merely need to modify
latest.js
file for documentation.
Steps to contribute:
- Modify
latest.js
file - Use below NPM-commands to generate HTML pages.
- Manually copy/paste
latest.js
file in the resultingrecordrtc.org
directory - Copy
recordrtc.org
directory and replace inRecordRTC
github clone'sgh-pages
section - Send a pull-request and done!
# First step: install recordrtc.org template and javascript file
npm install recordrtc.org
# Second step: generate HTML files from template & latest.js file
cd node_modules && cd recordrtc.org
# This command generates HTML pages from latest.js file
# for Linux/Mac
node_modules/.bin/jsdoc node_modules/recordrtc/RecordRTC.js -d ./../../recordrtc-gh-pages node_modules/recordrtc/README.md -t template
# for Windows
node_modules\.bin\jsdoc node_modules\recordrtc\RecordRTC.js -d .\..\..\recordrtc-gh-pages node_modules\recordrtc\README.md -t template
Now you'll see a directory with name recordrtc.org
.
# This command runs index.html file
# You can use it to preview HTML pages (doc files)
# for Linux/mac
./../../recordrtc.org/index.html
# for Windows
.\..\..\recordrtc.org\index.html
Send pull requests
Now, you should fork this repository:
And push/pull recordrtc.org
directory to gh-pages
.
How to modify latest.js
file?
RecordRTC is using comments format from jsdoc:
E.g.
/**
* Description
* @summary Summary
* @typedef Hello
* @example
* var some = new Something();
*/
Example - stopRecording
method:
/**
* This method stops recording. It takes single "callback" argument. It is suggested to get blob or URI in the callback to make sure all encoders finished their jobs.
* @param {function} callback - This callback function is invoked after completion of all encoding jobs.
* @method
* @memberof RecordRTC
* @instance
* @example
* recordRTC.stopRecording(function(videoURL) {
* video.src = videoURL;
* });
* @todo Implement <code class="str">recordRTC.stopRecording().getDataURL(callback);</code>
*/
stopRecording: stopRecording,
License
RecordRTC.js is released under MIT licence . Copyright (c) Muaz Khan.