WebRTC video component for Vue.js
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
assets
build
demo
dist
docs
src
.babelrc
.editorconfig
.gitignore
LICENSE
README.md
index.html
package-lock.json
package.json

README.md

vue-webrtc

WebRTC component designed for Vue.js

npm npm Contributions welcome License

See this for browser compatibility.

Installation

npm install vue-webrtc --save

yarn add vue-webrtc

Usage

import Vue from 'vue'
import WebRTC from 'vue-webrtc'

Vue.use(WebRTC)
// or
import {WebRTC} from 'vue-webrtc'
Vue.component(WebRTC.name, WebRTC)

// template
<vue-webrtc width="100%" roomId="roomId">
</vue-webrtc>

Testing & Dev

npm run dev
npm run demo

Props

prop type default notes
roomId string 'public-room' id of the room to join
socketURL string '' URL of the signaling server
cameraHeight number 160 height of video element
autoplay boolean true autoplay attribute
screenshotFormat string 'image/jpeg' format of screenshot

Events

name param notes
opened-room roomid emitted when the first user opens the room
joined-room video emitted when anyone joins the room
left-room video.id emitted when anyone leaves the room

Methods

name param notes
join void Join a room, opening it if needed
leave void Leave a room
capture void Capture the current image through the webcam as base64 encoded string

Styles

.video-list

.video-item

License

MIT

Roadmap

This version should be considered a 1.0 work in progress. There are many more features provided by the RTCMultiConnection library that we'd like to support, including:

  • Camera selection (we currently use the default camera)
  • Audio selection
  • WebRTC data events

Let us know what you'd like to see next and vote for a feature.

Credits

Author: @AndyWeston on GitHub at vue-webrtc

This project is based off of the excellent work found at WebRTC Experiments: https://www.rtcmulticonnection.org/

The Vue.js work is based on this camera component:
@vinceg vue-web-cam