live-bridge-widget
v0.20.14
Published
A widget to insert live in your React project
Downloads
175
Readme
Live Bridge é uma solução para inserir lives ou aulas online em seus sites ou sistemas por meio de uma integração simples, inserindo um script sem precisar de programação.
Instalação via Script
Importe os seguintes scripts em sua página html:
<script src="https://livebridgeuseast1.s3.amazonaws.com/js/2.live-bridge.chunk.js"></script>
<script src="https://livebridgeuseast1.s3.amazonaws.com/js/main.live-bridge.chunk.js"></script>
<script src="https://livebridgeuseast1.s3.amazonaws.com/js/runtime-main.live-bridge.js"></script>
Feito isso, basta adicionar o código abaixo na sua página html no local na qual deseja que o Live Bridge seja apresentado:
<div id="root-live-bridge"></div>
Pronto, o componente já está integrado dentro do site!
Instalação via Npm ou Yarn
Se você utiliza React Js em seu sistema você pode fazer a instalação utilizando o npm ou yarn usando o seguinte comando:
Instalação com o npm:
npm install live-bridge-widget
Instalação com o yarn:
yarn install live-bridge-widget
Após o procedimento acima estiver sido realizado você já pode adicionar uma instância do componente em seu sistema React Js da seguinte forma:
<LiveBridgeWidget/>
Pronto, o componente já está instegrado dentro do seu sistema!
Parâmetros disponibilizados
Caso deseje, alguns parâmetros podem ser passados na instância do componente, observe os exemplos abaixo:
- Para instalação via script:
<div
id="root-live-bridge"
data-client-id="Codigo de identificação do cliente que está se conectando cadastrado no Live Bridge"
data-session-id="Codigo de identificação da sala a ser conectada. Caso o cliente informado tenha cadastro no Live Bridge, com esse código é possivel acessar informações de registro da live realizada sala ou executar determinadas ações como por exemplo o download da live caso ela tenha sido gravada"
data-style='{"width": "100%", "height" : "100%", "background" : "black", "margin" : "0px", "padding" : "10px"}' <!-- caso desejar segue um exemplo de como estilizar o componente -->
data-is-host="informa que é um usuário host. Valores possíveis: false ou true"
data-nickname="nome do usuário exibido na live"
data-resolution="Qualidade da resolução. Valores possiveis: MIN, SD, HD"
data-url-callback="URL a ser redirecionado ao sair da sala. Obs: se esse usuário for host todos os participantes da live serão redirecionado para a URL informada"
></div>
- Para instalação via NPM:
<LiveBridgeWidget
idClient="Codigo de identificação do cliente que está se conectando cadastrado no Live Bridge"
room="Codigo de identificação da sala a ser conectada. Caso o cliente informado tenha cadastro no Live Bridge, com esse código é possivel acessar informações de registro da live realizada sala ou executar determinadas ações como por exemplo o download da live caso ela tenha sido gravada"
styles={ Objeto com a estilização css do componente }
isHost="informa que é um usuário host. Valores possíveis: false ou true"
nickname="nome do usuário exibido na live"
resolution="Qualidade da resolução. Valores possiveis: MIN, SD, HD"
urlCallback="URL a ser redirecionado ao sair da sala. Obs: se esse usuário for host todos os participantes da live serão redirecionado para a URL informada"
/>
Para mais informações acesse nosso site