Consultar o ciclo de vida da Viagem Adventure, o status de streaming no lado do servidor e o conjunto de ações do mundo atual; você também pode relatar o heartbeat de pull-stream ou reprodução do cliente ao mesmo tempo.
Escopo
Consultar o ciclo de vida da Viagem Adventure, o status de streaming no lado do servidor e o conjunto de ações do mundo atual; você também pode relatar o heartbeat de pull-stream ou reprodução do cliente ao mesmo tempo. Antes de chamar, confirme o seguinte:
- Autenticação: A Chave de API primária não é obrigatória; tanto a chave primária quanto uma temporária podem chamá-la. Para saber como obtê-las, veja Obter credenciais de autenticação.
- Pré-requisitos: Consulte com o
encryptedTravelIdretornado por Entrar na Viagem. - Chamador: Tanto seu servidor quanto seu cliente podem fazer a chamada. Recomenda-se consultar a cada 2–5 segundos.
Solicitação HTTP
- Singapore
- China (Pequim)
- EUA (Virgínia)
GET https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/api/v2/apps/happyoyster-1.0-adventure/openapi/v1/travels/statusSubstitua {WorkspaceId} pelo seu ID do Workspace real.Parâmetros da solicitação |
|
Authorization string (Obrigatório)Autenticação por Chave de API. A Chave de API primária não é obrigatória; tanto a chave primária quanto uma temporária podem chamá-lo.
| |
Parâmetros de consulta | |
encryptedTravelId string (Obrigatório)O ID criptografado da Viagem Adventure. Retornado por Entrar na Viagem. | |
clientStreamStatus string (Opcional)O status de recebimento de fluxo RTC ou reprodução do cliente, sem distinção entre maiúsculas e minúsculas. Valores não reconhecidos são ignorados. Valores permitidos:
| |
clientStreamStatusTimeMs long (Opcional)O timestamp em milissegundos da mudança de estado do cliente. Usado em conjunto com clientStreamStatus. |
Parâmetros de resposta |
|
code integerCódigo de retorno. 0 indica sucesso; diferente de zero é um código de erro. | |
message stringMensagem de erro. null em caso de sucesso. | |
data objectDados da resposta. null em caso de falha.
Propriedades encryptedTravelId stringTravel ID criptografado.status stringStatus do ciclo de vida da Viagem:
paused; não crie uma máquina de estados baseada em pausar / retomar.rtcStatus stringStatus de streaming RTC do lado do servidor; diferente do clientStreamStatus relatado pelo cliente.updateTime stringÚltima hora de atualização, no formato ISO 8601.userInstructions null | arrayO Adventure não suporta HTTP instruct, e as ações de exploração não são refletidas neste campo; geralmente null ou [], e pode ser ignorado.chapters arrayA lista de capítulos; null quando nenhum dado de capítulo foi gerado.characterActions arrayIDs de ação disponíveis para o personagem / sujeito atual; [] quando não há recomendação. Geralmente 2–4 são retornados. Ações comuns:
arrayIDs de ação de interação com o ambiente disponíveis para a cena atual; [] quando não há recomendação. O servidor seleciona 0–3 de um conjunto fixo de ações por cena e pode retornar um array vazio. Ações comuns:
|
Estados pré-requisitos e notas de chamada
- Sondar a cada 2–5 segundos.
- As capacidades do produto Adventure não possuem estado
paused; não crie uma máquina de estados baseada em pausar / retomar. characterActionseenvironmentActionssão dicas de ações disponíveis; o controle real ainda é enviado via SDKsendCommand.- Este endpoint não retorna
mode,playUrl,bgmUrlousessionId; a configuração de streaming é baseada na resposta de Entrar na viagem. clientStreamStatusé o heartbeat de reprodução do lado do cliente, ertcStatusé o status de streaming do lado do servidor; eles não são intercambiáveis.- O Adventure não suporta HTTP
instruct,pause,resume,rewindouupdate-script; não integre os seguintes caminhos como capacidades HTTP disponíveis:/travels/instruct,/travels/pause,/travels/resume,/travels/rewind,/travels/update-script.
Códigos de erro
Se a chamada do modelo falhar e retornar um erro, consulte Códigos de Erro do HappyOyster para resolvê-lo.
Próximos passos
Após a Viagem tornar-se running:
- O cliente envia controles de direção, ponto de vista e ação via SDK
sendCommand(você pode primeiro ler o conjunto de ações retornado por este endpoint). - Encerrar Travel: encerre a sessão e processe os artefatos.