Su servidor prepara mundos y exporta artefactos a través de las API abiertas de HappyOyster; el SDK del cliente gestiona la conexión RTC y la interacción en tiempo real.
HappyOyster sigue una arquitectura dividida en servidor + cliente: su servidor gestiona los mundos y los artefactos a través de las API abiertas, y el SDK del cliente proporciona la experiencia en tiempo real. Antes de comenzar, complete Obtener credenciales de autenticación.
Nota
- Las API abiertas del lado del servidor se dividen por modo de experiencia en Aventura, Dirección y Actuación. Elija los endpoints que correspondan a su modo.
- Un Mundo y un Viaje están estrictamente vinculados al modelo que los creó; el acceso entre modelos devuelve
403001(mundo) o404000(viaje). - El SDK no es responsable de crear ni gestionar mundos; únicamente proporciona la experiencia en tiempo real del lado del cliente.
1. Preparar un mundo (API abierta del servidor)
- Crear un mundo, utilizando el endpoint correspondiente a su modo: Aventura-Crear mundo / Dirección-Crear mundo / Actuación-Crear mundo.
- Consultar el estado de compilación (cada 3–5 segundos) hasta que sea
ready: Aventura-Consultar estado de compilación del mundo / Dirección-Consultar estado de compilación del mundo / Actuación-Consultar estado de compilación del mundo. - Canjear por un ticket: Con la clave de API principal, llame a Aventura-Obtener credencial de viaje / Dirección-Obtener credencial de viaje / Actuación-Obtener credencial de viaje para obtener un
ticketde un solo uso. - Entregar credenciales al cliente: Envíe el
ticketjunto con la clave de API temporal (utilizada comotokendel SDK) al cliente.
2. Experiencia en tiempo real (SDK del cliente)
El SDK gestiona la conexión RTC, la reproducción de video y los comandos de interacción.
-
Inicializar el SDK:
initialize+updateToken— inyecte el host de API y la clave de API temporal. -
Iniciar la sesión:
startTravel(ticket); el SDK ingresa a la sala y establece la conexión automáticamente. -
Adjuntar el video: Agregue la vista devuelta por
attachVideo()a su diseño. Para el modo Actuación, configure la orientación del contenedor según el valoraspectRatiodevuelto al ingresar a la sala. -
Interacción en tiempo real:
- Aventura: Llame a
sendCommandpara enviar comandos de dirección, cámara o acción. - Dirección: Llame a
sendInstructpara enviar instrucciones de texto que impulsen la historia. - Actuación: Llame a
sendInstructpara enviar instrucciones de texto.
- Aventura: Llame a
-
Control de sesión:
- Aventura: No se admiten las funciones de pausa ni rebobinado.
- Dirección: Admite
pause,rewindyresume. - Actuación: Admite
pauseyresume; no se admiterewind.
-
Finalizar la sesión:
endTravellibera RTC y recursos.
3. Recuperar artefactos (API abierta del servidor)
Después de que finalice el viaje, consulte con la clave de API principal en Aventura-Consultar artefactos del viaje / Dirección-Consultar artefactos del viaje / Actuación-Consultar artefactos del viaje hasta que composeStatus = ready. Para entrega externa, recomendamos video.withInstructionAndWatermark (compuesto con instrucciones y marca de agua).
Siguientes pasos
- Descargar SDK y demos: Paquetes de SDK, guías de integración, referencias de API y demos de código abierto para cada plataforma.