avk-twilio-video
v1.0.0-dev
Published
Twilio Video JavaScript library
Downloads
3
Maintainers
Readme
twilio-video.js
twilio-video.js allows you to add real-time voice and video to your web apps.
Note that this is a beta release. You may encounter bugs and instability, and the APIs available in this release may change in subsequent releases.
We want your feedback! Email Rob Brazier, Product Manager for Programmable Video at [email protected] with suggested improvements, feature requests and general feedback. If you need technical support, contact [email protected].
Installation
NPM
npm install twilio-video --save
Bower
Until we release twilio-video.js 1.0.0 proper, you must specify a specific pre-release. For example,
bower install twilio-video#1.0.0-beta4 --save
CDN
Releases of twilio-video.js are hosted on a CDN, and you can include these directly in your web app using a <script> tag.
<script src="//media.twiliocdn.com/sdk/js/video/v1/twilio-video.min.js"></script>
Usage
The following is a simple example showing a Client connecting to a Room. For more information, refer to the API Docs.
const Video = require('twilio-video');
Video.connect({ name: 'room-name', token: '$TOKEN' }).then(room => {
console.log('Connected to Room "%s"', room.name);
room.participants.forEach(participant => {
console.log('Participant "%s" is connected', participant.identity);
participant.media.attach(document.body);
});
room.on('participantConnected', participant => {
console.log('Participant "%s" connected', participant.identity);
participant.media.attach(document.body);
});
room.on('participantDisconnected', participant => {
console.log('Participant "%s" disconnected', participant.identity);
});
});
Changelog
See CHANGELOG.md.
License
See LICENSE.md.
Building
Fork and clone the repository. Then, install dependencies with
npm install
Then run the build
script:
npm run build
The builds and docs will be placed in the dist/
directory.
Contributing
Bug fixes welcome! If you're not familiar with the GitHub pull request/contribution process, this is a nice tutorial.