Socket
Socket
Sign inDemoInstall

vue-stream-mask

Package Overview
Dependencies
4
Maintainers
1
Versions
28
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

vue-stream-mask

You can see it working live here [vue-stream-mask demo](https://sagoncalves.github.io/vue-stream-mask/ "vue-stream-mask demo")


Version published
Maintainers
1
Weekly downloads
12
increased by9.09%

Weekly downloads

Readme

Source

Vue Stream Mask Component

You can see it working live here vue-stream-mask demo

Features

  • Person & multi-person body segmentation blurring video background
  • Green screen mask, you can use the background you wish with a simple property
Add to your project
yarn add vue-stream-mask
Import component
import * as VueStreamMask from "vue-stream-mask"

Vue.use(VueStreamMask)
HTML
<vue-stream-mask />

Ways of use

- Default -

By default when the component loads it ask for the camera media and later emits the loaded event wich serves as a parameter the stream that you can add to a RTCPeerConnection, If you want to avoid this behaviour check the on demand way of use.

Example:

<vue-stream-mask @loaded="handleStream" />

<!-- somewhere else on like on your code methods -->

<script>
	function handleStream(stream){
		// Do things to the stream
		// E.g. Send it to another computer using an RTCPeerConnection
		//      pc is an RTCPeerConnection created elsewhere
		this.pc.addStream(stream);
	}
</script>

- On demand -

If you want to ask for the media stream at a certain moment on your app

Example:

<vue-stream-mask await ref="vueStreamRef"/>

<!-- somewhere else on like on your code methods -->
<script>
	async function initStream(){
		let stream = await this.$refs.vueStreamRef.init()
		// Do things to the stream
		// E.g. Send it to another computer using an RTCPeerConnection
		//      pc is an RTCPeerConnection created elsewhere
		this.pc.addStream(stream);
	}
</script>

Methods

functionDescription
async init() Triggering this function will start video capture and return a media stream object
stop() Triggering this function will stop video capture

Props

Property nameDescription
awaitComponent wont ask for media stream until you run the init() func
showDisplays a canvas element with the local stream
multipleEnables multiple person segmentation
backgroundIf enabled it replaces persons background with given img url
backgroundBlurAmountif background prop its not defined you can handle with this one how much blur you want in the background

Keywords

FAQs

Last updated on 09 Jun 2020

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.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc