QwenCloudBRASIL
Tradução de apoio para consulta. Código e identificadores técnicos preservados. Consultar referência original ↗

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.

1. Prepare um mundo (API aberta do servidor)

  1. Crie um mundo: Defina um mundo reutilizável. Os parâmetros necessários diferem de acordo com o modo:

  2. Pesquise o status da compilação (a cada 3–5 segundos é recomendado) até atingir ready:

  3. 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.

  1. Inicialize o SDK: injete o host da API e o model para o seu modo de experiência e, em seguida, injete a chave de API temporária via updateToken.

  2. 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 / 120 segundos; padrão 60).

  3. 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 aspectRatio devolvido ao entrar na sala (retrato 9:16 ou paisagem 16: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.

  4. 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 simple submodo, envie instruções de texto via sendInstruct para conduzir a história. No scriptlist submodo, a história é conduzida por um roteiro estruturado; o script é editado no servidor via HappyOyster-Directing-Update Roteiro e sendInstruct é não suportado na camada SDK.
    • Atuação: Envie instruções de texto via sendInstruct; sendCommand é não suportado.
  5. 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.
  6. 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.

  1. Artefatos de consulta: Pesquise com a chave de API primária até composeStatus é ready. Escolha o endpoint que corresponde ao seu modo:

  2. Obtenha o vídeo: Para entrega externa, recomendamos video.withInstructionAndWatermark (composto com instruções e marca d’água).

Próximas etapas