Seu servidor prepara mundos e exporta artefatos através das APIs Abertas do HappyOyster; o SDK do cliente gerencia a conexão RTC e a interação em tempo real.
O HappyOyster segue uma divisão servidor + cliente: seu servidor gerencia mundos e artefatos por meio das APIs Abertas, e o SDK do cliente fornece a experiência em tempo real. Antes de começar, conclua Obter Credenciais de Autenticação.
O SDK gerencia a conexão RTC, a reprodução de vídeo e os comandos de interação.
Após o término da Viagem, consulte com a Chave de API primária em Aventura-Consultar Artefatos de Viagem / Direção-Consultar Artefatos de Viagem / Atuação-Consultar Artefatos de Viagem até
- As APIs Abertas do lado do servidor são divididas por modo de experiência em Aventura, Direção e Atuação. Escolha os endpoints correspondentes ao seu modo.
- Um Mundo e uma Viagem estão estritamente vinculados ao modelo que os criou; o acesso entre modelos retorna
403001(mundo) ou404000(viagem). - O SDK não é responsável por criar ou gerenciar mundos; ele apenas fornece a experiência em tempo real no lado do cliente.
1. Preparar um Mundo (API Aberta do Servidor)
- Criar um Mundo, usando o endpoint para o seu modo: Aventura-Criar Mundo / Direção-Criar Mundo / Atuação-Criar Mundo.
- Consultar o status da compilação (a cada 3–5 segundos) até
ready: Aventura-Consultar Status de Compilação do Mundo / Direção-Consultar Status de Compilação do Mundo / Atuação-Consultar Status de Compilação do Mundo. - Trocar por um ticket: Com a Chave de API primária, chame Aventura-Obter Credencial de Viagem / Direção-Obter Credencial de Viagem / Atuação-Obter Credencial de Viagem para obter um
ticketde uso único. - Entregar credenciais ao cliente: Envie o
ticketjuntamente com a Chave de API temporária (usada como otokendo SDK) para o cliente.
2. Experiência em Tempo Real (SDK do Cliente)
O SDK gerencia a conexão RTC, a reprodução de vídeo e os comandos de interação.
-
Inicializar o SDK:
initialize+updateToken— injete o API Host e a Chave de API temporária. -
Iniciar a sessão:
startTravel(ticket); o SDK entra na sala e estabelece a conexão automaticamente. -
Anexar o vídeo: Adicione a visualização retornada por
attachVideo()ao seu layout. Para Atuação, defina a orientação do contêiner de acordo com oaspectRatioretornado ao entrar na sala. -
Interação em tempo real:
- Aventura: Chame
sendCommandpara enviar comandos de direção / câmera / ação. - Direção: Chame
sendInstructpara enviar instruções de texto que conduzem a história. - Atuação: Chame
sendInstructpara enviar instruções de texto.
- Aventura: Chame
-
Controle de sessão:
- Aventura: Pausa e retrocesso não são suportados.
- Direção: Suporta
pause,rewinderesume. - Atuação: Suporta
pauseeresume;rewindnão é suportado.
-
Encerrar a sessão:
endTravellibera o RTC e os recursos.
3. Recuperar Artefatos (API Aberta do Servidor)
Após o término da Viagem, consulte com a Chave de API primária em Aventura-Consultar Artefatos de Viagem / Direção-Consultar Artefatos de Viagem / Atuação-Consultar Artefatos de Viagem até composeStatus = ready. Para entrega externa, recomendamos video.withInstructionAndWatermark (composto com instruções e marca d'água).
Próximos Passos
- Baixar SDKs e Demos: Pacotes SDK, guias de integração, referências de API e demos de código aberto para cada plataforma.