omar-videoconference-component v1.0.4

OMAR VIDEO CONFERENCE COMPONENT

Este componente es una librería de React para poder utilizar las video asistencias de OMAR ©

Cómo Instalar

npm i omar-videoconference-component 

Uso

import React from "react";
import "./App.css";
import { OmarVideoConference } from "omar-videoconference-component/lib";

function App() {
  return (
    <div className="App">
      <OmarVideoConference
        secretKey="YOUR_SECRET_KEY"
        topic="CHANNEL_TOPIC"
        subject="ANY_SUBJECT"
        source="MY_CUSTOM_SOURCE"
        externalId="MY_ID"
        containerStylingCallback={(style) => {
          style.height = "90vh"
          style.width = "100vw"
          // and more styling posibilities from css props
        }}
        loadingComp={
          <div style={{ backgroundColor: "wheat", padding: 10, margin: 10}}>
            Cargando desde componente personalizado...
          </div>
        }
        errorComp={
          <div style={{ backgroundColor: "wheat", padding: 30, margin: 50}}>
            <h3>
              Ocurrió un error al iniciar la videoconferencia
            </h3>
          </div>
        }
        closedConferenceMessageComp={
          <div style={{ backgroundColor: "wheat", padding: 30, margin: 50}}>
            <h2>
              Gracias por Usar nuestra Video Conferencia!
            </h2>
          </div>
        }
      />
    </div>
  );
}

Parámetros

secretKey (string) - Requerido

Es el token de autenticación que se debe usar para acceder a la video asistencias

topic (string) - Requerido

Es el canal por el cual se va a atender la video asistencia. (Ejemplo: VENTAS, RETENCIONES)

subject (string) - Opcional

Es el tema o el motivo del requerimiento de la video asistencia

source (string) - Opcional

El origen desde donde se está solicitando la video asistencia (Ejemplo: Kiosko, Télefono Móvil)

externalId (string) - Opcional

Un id que se puede setear para que sea identificado internamente por OMAR

containerStylingCallback (style CSS Object) => Void - Opcional

Es un callback que contiene como parámetro un objeto de tipo estilo css al cual podemos modificar sus propiedades CSS para modificar el contenedor de la video asistencia. Esto es requerido si se quiere cambiar el tamaño de la vista del video, tal como se muestra en el ejemplo de uso.

loadingComp (Componente de React | React.ReactNode) - Opcional

Un Componente de React que puede ser usado para mostrar una vista de espera mientras la video asistencia se carga.

ErrorComp (Componente de React | React.ReactNode) - Opcional

Un Componente de React que puede ser usado para mostrar una vista de error en caso de que alguno pase.

closedConferenceMessageComp (Componente de React | React.ReactNode) - Opcional

Un Componente de React que puede ser usado para mostrar una vista luego de que se haya cerrado la video asistencia.

Legal

SmartSense LTD 2022 - Todos los derechos reservados