Fluxo de Integração
Seu servidor prepara mundos e exporta artefatos através do HappyOyster APIs abertas; o SDK do cliente lida com a conexão RTC e a interação em tempo real.
HappyOyster segue um servidor + cliente divisão: seu servidor gerencia mundos e artefatos por meio de APIs abertas, e o SDK do cliente oferece a experiência em tempo real. Antes de começar, conclua Obter credenciais de autenticação.
- APIs abertas do lado do servidor são divididas por modo de experiência em Aventura, Direção e Atuação. Escolha os endpoints que correspondem ao seu modo.
- Um Mundo e uma Viagem estão estritamente vinculados ao modelo que os criou; retornos de acesso entre modelos
403001(mundo) ou404000(viagem). - O SDK é não é responsável para criar ou gerenciar mundos; ele oferece apenas a experiência em tempo real do lado do cliente.
1. Prepare um mundo (API aberta do servidor)
-
Crie um mundo: Defina um mundo reutilizável. Os parâmetros necessários diferem de acordo com o modo:
- Aventura: HappyOyster-Adventure-Create Mundo.
perspective,promptefirstFrameImagesão necessários. - Direção: HappyOyster-Directing-Create Mundo. Suporta
simple(orientado por prompt) escriptlist(orientado por script estruturado; o conteúdo do script é editado via HappyOyster-Directing-Update Roteiro). - Atuação: HappyOyster-Acting-Create Mundo.
promptefirstFrameImagesão obrigatórios;aspectRatioé opcional (padrão9:16, também suporta16:9).
- Aventura: HappyOyster-Adventure-Create Mundo.
-
Pesquise o status da compilação (a cada 3–5 segundos é recomendado) até atingir
ready: -
Entregar credenciais ao cliente: conforme descrito em Obter credenciais de autenticação, obtenha a chave de API temporária e o ingresso e entregue ambos ao cliente.
2. Experiência em tempo real (SDK do cliente)
O SDK do cliente usa a chave de API temporária e ticket entregue pelo seu servidor para executar a experiência em tempo real. Ele lida com a conexão RTC, reprodução de vídeo, pesquisa de status e comandos de interação – você não precisa trabalhar diretamente com o protocolo subjacente em tempo real. Uma viagem (sessão de experiência) geralmente passa pelos estágios "inicializar → preparar → executar → (opcionalmente pausar/retroceder) → finalizar"; os valores exatos de status são por SDK — consulte a referência correspondente da API do SDK.
As etapas abaixo descrevem ações genéricas. Os nomes dos métodos diferem ligeiramente entre os SDKs da Web, Android e iOS — verifique a referência correspondente da API do SDK para assinaturas exatas e ordem de chamadas.
-
Inicialize o SDK: injete o host da API e o
modelpara o seu modo de experiência e, em seguida, injete a chave de API temporária viaupdateToken. -
Iniciar a sessão: Comece a viagem com um
ticket; o SDK entra na sala e estabelece a conexão RTC automaticamente. No modo Aventura,maxExperienceTimeSecé opcional (60/90/120segundos; padrão60). -
Anexe o vídeo: recupere a visualização do vídeo do SDK e coloque-a no seu layout. Para o modo Atuação, defina a orientação do contêiner de acordo com o
aspectRatiodevolvido ao entrar na sala (retrato9:16ou paisagem16:9); o vídeo remoto é vinculado ao clipe para preencher, portanto, uma orientação incompatível corta a imagem em vez de adicionar barras de caixa de correio. -
Interação em tempo real (as capacidades diferem de acordo com o modo):
- Aventura: Envie comandos direcionais/câmera/ação via
sendCommand. - Direção: No
simplesubmodo, envie instruções de texto viasendInstructpara conduzir a história. Noscriptlistsubmodo, a história é conduzida por um roteiro estruturado; o script é editado no servidor via HappyOyster-Directing-Update Roteiro esendInstructé não suportado na camada SDK. - Atuação: Envie instruções de texto via
sendInstruct;sendCommandé não suportado.
- Aventura: Envie comandos direcionais/câmera/ação via
-
Controle de sessão:
- Pausa/retomar: Disponível apenas para Direção e Atuação. Chamar no Adventure é rejeitado pelo SDK com
103003. - Retroceder: Disponível apenas para direção. A convocação para atuação ou aventura também é rejeitada com
103003.
- Pausa/retomar: Disponível apenas para Direção e Atuação. Chamar no Adventure é rejeitado pelo SDK com
-
Encerrar a sessão: Terminar a viagem; o SDK desconecta o RTC e libera recursos automaticamente. Observe o estado do terminal e os erros da sessão por meio do status e dos eventos de erro do SDK.
3. Recuperar artefatos (API aberta do servidor)
Após o término da experiência, seu servidor chama o HappyOyster Abra APIs para recuperar o vídeo composto.
-
Artefatos de consulta: Pesquise com a chave de API primária até
composeStatuséready. Escolha o endpoint que corresponde ao seu modo: -
Obtenha o vídeo: Para entrega externa, recomendamos
video.withInstructionAndWatermark(composto com instruções e marca d’água).
Próximas etapas
- Baixar SDKs e demonstrações: pacotes SDK, guias de integração, referências de API e demonstrações de código aberto para cada plataforma.