XR8.addCameraPipelineModule()

XR8.addCameraPipelineModule(módule)

Descripción

las aplicaciones de cámara de 8th Wall se construyen utilizando un marco de módulos de canalización de cámara. Para una descripción completa de los módulos de canalización de cámara, consulta CameraPipelineModule.

Las aplicaciones instalan módulos que luego controlan el comportamiento de la aplicación en tiempo de ejecución. Un objeto módulo debe tener una cadena .name que sea única dentro de la aplicación, y luego debe proporcionar uno o más métodos del ciclo de vida de la cámara que se ejecutarán en el punto apropiado del bucle de ejecución.

Durante el tiempo de ejecución principal de una aplicación, cada fotograma de la cámara pasa por el siguiente ciclo:

onBeforeRun -> onCameraStatusChange (requesting -> hasStream -> hasVideo | failed) -> onStart -> onAttach -> onProcessGpu -> onProcessCpu -> onUpdate -> onRender

Los módulos de cámara deben implementar uno o varios de los siguientes métodos del ciclo de vida de la cámara:

Función	Descripción
onAppResourcesLoaded	Se activa cuando hemos recibido del servidor los recursos adjuntos a una aplicación.
onAttach	Se activa antes de la primera vez que un módulo recibe actualizaciones de fotograma. Se activan los módulos que se han añadido antes o después de que se ejecute la canalización.
onBeforeRun	Llamada inmediatamente después de XR8.run(). Si se devuelve alguna promesa, XR esperará todas las promesas antes de continuar.
onCameraStatusChange	Se activa cuando se produce un cambio durante la solicitud de permisos de la cámara.
onCanvasSizeChange	Se ejecuta cuando el lienzo cambia de tamaño.
onDetach	se llama después de la última vez que un módulo recibe actualizaciones de marcos. Esto ocurre después de parar el motor o de retirar manualmente el módulo de la canalización, lo que ocurra primero.
onDeviceOrientationChange	Se ejecuta cuando el dispositivo cambia de orientación horizontal/vertical.
onException	Se activa cuando se produce un error en XR. Llamada con el objeto de error.
onPaused	Se activa cuando se llama a XR8.pause().
onProcessCpu	Llamada para leer los resultados del procesamiento de la GPU y devolver los datos utilizables.
onProcessGpu	Llamada para iniciar el procesamiento de la GPU.
onRemove	se activa cuando se elimina un módulo de la canalización.
onRender	Activado después de onUpdate. Este es el momento en que el motor de renderizado emite cualquier comando de dibujo WebGL. Si una aplicación proporciona su propio bucle de ejecución y confía en XR8.runPreRender() y XR8.runPostRender(), no se llama a este método y toda la renderización debe ser coordinada por el bucle de ejecución externo.
onResume	Se activa cuando se llama a XR8.resume().
onStart	Se activa cuando se inicia XR. Primera llamada de retorno después de llamar a XR8.run().
onUpdate	Llamada para actualizar la escena antes de la renderización. Los datos devueltos por los módulos en onProcessGpu y onProcessCpu estarán presentes como processGpu.modulename y processCpu.modulename, donde el nombre viene dado por module.name = "modulename".
onVideoSizeChange	Se ejecuta cuando el lienzo cambia de tamaño.
requiredPermissions	Los módulos pueden indicar qué capacidades del navegador requieren que puedan necesitar solicitudes de permisos. El marco de trabajo puede utilizarlos para solicitar los permisos adecuados si no los tiene, o para crear componentes que soliciten los permisos adecuados antes de ejecutar XR.

Nota: Los módulos de cámara que implementen onProcessGpu o onProcessCpu pueden proporcionar datos a etapas posteriores de la canalización. Esto se hace mediante el nombre del módulo.

Parámetros

Parámetro	Tipo	Descripción
módulo	Objeto	El módulo objeto.

Returns

Ninguno

Ejemplo 1 - Un módulo de canalización de cámaras para gestionar los permisos de las cámaras:

XR8.addCameraPipelineModule({
  name: 'camerastartupmodule',
  onCameraStatusChange: ({status}) {
    if (status == 'requesting') {
      myApplication.showCameraPermissionsPrompt()
    } else if (status == 'hasStream') {
      myApplication.dismissCameraPermissionsPrompt()
    }} else if (status == 'hasVideo') {
      myApplication.startMainApplictation()
    }} else if (status == 'failed') {
      myApplication.promptUserToChangeBrowserSettings()
    }}
  }},
}})

Ejemplo 2 - una aplicación para escanear códigos QR podría construirse así

// Instala un módulo que obtenga la alimentación de la cámara como un UInt8Array.
XR8.addCameraPipelineModule(
  XR8.CameraPixelArray.pipelineModule({luminance: true, width: 240, height: 320}))

// Instala un módulo que dibuje la imagen de la cámara en el lienzo.
XR8.addCameraPipelineModule(XR8.GlTextureRenderer.pipelineModule())

// Crea nuestra lógica de aplicación personalizada para escanear y mostrar códigos QR.
XR8.addCameraPipelineModule({
  name: 'qrscan',
  onProcessCpu: ({processGpuResult}) => {
    // CameraPixelArray.pipelineModule() los devuelve en onProcessGpu.
    const { pixels, rows, cols, rowBytes } = processGpuResult.camerapixelarray
    const { wasFound, url, corners } = findQrCode(pixels, rows, cols, rowBytes)
    return { wasFound, url, corners }
 }},
  onUpdate: ({processCpuResult}) => {
 // Estos fueron devueltos por este módulo ('qrscan') en onProcessCpu
    const {wasFound, url, corners } = processCpuResult.qrscan
    if (wasFound) {
      showUrlAndCorners(url, corners)
 }}
 }},
}})