0.1.0 • Published 4 years ago

react-simple-kvs-viewer v0.1.0

Weekly downloads
-
License
GPL-2.0
Repository
gitlab
Last release
4 years ago

react-simple-kvs-viewer

A simple react component viewer for AWS KVS WebRTC.

Description

react-simple-kvs-viewer is a simple react component able to playback video from AWS KVS WebRTC

This library is still experimental and is therefore not yet suitable for production.

Install

Install using npm or yarn

npm i --save react-simple-kvs-viewer
yarn add react-simple-kvs-viewer

props

  • streamName - Name of the Signaling channel as defined in AWS
  • region - Region where Signaling channel is hosted
  • awsConfig - A valid AWS.config object with valid credentials (accessKeyId, secretAccessKey, sessionToken). These credentials need a valid IAM policy to interact with KVS

Example

Import module

import Cam from 'react-simple-kvs-viewer';

Use it into your render method as in this example.

    render() {
        return (
            ...
            <Grid container spacing={2}>
                <Grid item xs={4}>
                    <Card className={'MyCard'}>    
                        <CardHeader className={'MyCardClassName'} title="My Cam"/>
                        <CardContent>
                            <Cam ref={this.Cam1} streamName='TBHouseStream' region='eu-west-1' awsConfig={AWS.config} />
                        </CardContent>
                    </Card>
                </Grid>
            ...
        )
    }
0.1.0

4 years ago