https://github.com/jesstelford/aframe-video-billboard

Video Billboard entity & component for A-Frame.
https://github.com/jesstelford/aframe-video-billboard

Last synced: 2 months ago
JSON representation

Video Billboard entity & component for A-Frame.

• Host: GitHub
• URL: https://github.com/jesstelford/aframe-video-billboard
• Owner: jesstelford
• License: mit
• Created: 2016-10-11T21:00:07.000Z (about 8 years ago)
• Default Branch: master
• Last Pushed: 2018-06-19T12:14:46.000Z (over 6 years ago)
• Last Synced: 2024-08-17T02:12:19.256Z (3 months ago)
• Language: JavaScript
• Homepage: https://jesstelford.github.io/aframe-video-billboard/
• Size: 511 KB
• Stars: 40
• Watchers: 3
• Forks: 4
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Looking for maintainers

I have recently [started a new business](https://mobile.twitter.com/ceteio), which means I no longer have time to maintain this project.

Please [reach out](https://github.com/jesstelford) if you are interested in updating this component to the latest versions of aframe, and resolving the list of issues ❤️

# aframe-video-billboard

A Video Billboard entity & component for [A-Frame](https://aframe.io).

Create an `` entity, streaming video from the user's camera

to a plane in 3D space.

_Note: Requires the latest WebRTC spec.

This can be easily shimmed with

[`webrtc-adapter`](https://github.com/webrtc/adapter)_

By default, will select the "back" facing camera.

### Installation

#### Browser

Use directly from the unpkg CDN:

```html

  

  

  

  

    registerAframeVideoBillboard(window.AFRAME);

  

  

    

    

  

```

#### npm

Install via npm:

```bash

npm install aframe-video-billboard

```

Then register and use.

```javascript

import aframe from 'aframe';

import registerVideoBillboard from 'aframe-video-billboard';

registerVideoBillboard(aframe);

```

### `video-billboard` component

_Note: The `` entity automatically includes the

`video-billboard` component._

#### Schema

| attribute | type | default | description |

|---|---|---|---|

| `deviceId` | string | `''` | Select the specific device for display. If omitted, will attempt to get the rear-facing video stream. If rear-facing video stream not detected, will get the first video stream found. Note that if it is not a valid video device, nothing will be shown. |

| `minWidth` | number | 4 | The minimum width in world-units to display the video. Video aspect ratio will be preserved. |

| `minHeight` | number | 3 | The minimum height in world-units to display the video. Video aspect ratio will be preserved. |

#### Events

| event name | data | description |

|---|---|---|

| `video-play` | `{source, stream}` | `source` is an instance of MediaDeviceInfo. `stream` is an instance of MediaStream. Fired every time the source changes and video playback begins.