npm package: @openhps/webrtc
Description: Open Hybrid Positioning System - WebRTC API
Author: Maxim Van de Wynckel
Latest version: 1.0.4

<h1 align="center">
  <img alt="OpenHPS" src="https://openhps.org/images/logo_text-512.png" width="40%" /><br />
  @openhps/webrtc
</h1>
<p align="center">
    <a href="https://github.com/OpenHPS/openhps-web/actions/workflows/main.yml" target="_blank">
        <img alt="Build Status" src="https://github.com/OpenHPS/openhps-web/actions/workflows/main.yml/badge.svg">
    </a>
    <a href="https://codecov.io/gh/OpenHPS/openhps-web">
        <img src="https://codecov.io/gh/OpenHPS/openhps-web/branch/master/graph/badge.svg"/>
    </a>
    <a href="https://codeclimate.com/github/OpenHPS/openhps-web/" target="_blank">
        <img alt="Maintainability" src="https://img.shields.io/codeclimate/maintainability/OpenHPS/openhps-web">
    </a>
    <a href="https://badge.fury.io/js/@openhps%web">
        <img src="https://badge.fury.io/js/@openhps%2Fweb.svg" alt="npm version" height="18">
    </a>
</p>

<h3 align="center">
    <a href="https://github.com/OpenHPS/openhps-core">@openhps/core</a> &mdash; <a href="https://openhps.org/docs/web">API</a>
</h3>

<br />
This component adds a video source node that can be used for processing video data.

## Getting Started
If you have [npm installed](https://www.npmjs.com/get-npm), start using @openhps/webrtc with the following command.
```bash
npm install @openhps/webrtc --save
```
## Usage

```html
<button id="start">Start Test</button>

<div id="result">
    Click the start button to test the component.
</div>

<video id="videoRef"></video>

<script type="module">
    import { 
        ModelBuilder, 
        CallbackSinkNode, 
        DataObject,
        Magnetometer,
        Accelerometer,
        Gyroscope,
        LinearAccelerationSensor
    } from './js/openhps-core.es.min.js';
    import { VideoSource } from './js/openhps-webrtc.es.min.js';

    var source = new VideoSource({
        uid: "source",
        autoStart: true,
        fps: 30,
        videoSource: "videoRef",
        height: 720,
        width: 1024
    });

    source.on('error', console.error);
    
    document.getElementById("start").onclick = () => source.play();
    
    ModelBuilder.create()
        .from(source)
        .to(new CallbackSinkNode(frame => {
            console.log(frame);
        }))
        .build();
</script>
```

## Contributors
The framework is open source and is mainly developed by PhD Student Maxim Van de Wynckel as part of his research towards *Hybrid Positioning and Implicit Human-Computer Interaction* under the supervision of Prof. Dr. Beat Signer.

## Contributing
Use of OpenHPS, contributions and feedback is highly appreciated. Please read our [contributing guidelines](CONTRIBUTING.md) for more information.

## License
Copyright (C) 2019-2023 Maxim Van de Wynckel & Vrije Universiteit Brussel

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

https://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.