Consulte o ciclo de vida da Viagem do Directing, o status de streaming no lado do servidor, as instruções de texto executadas e as informações dos capítulos; você também pode relatar o heartbeat de pull-stream ou reprodução do cliente ao mesmo tempo.
Escopo
Consulte o ciclo de vida da Viagem do Directing, o status de streaming no lado do servidor, as instruções de texto executadas e as informações dos capítulos; 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
- EUA (Virgínia)
GET https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/api/v2/apps/happyoyster-1.0-directing/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 de Viagem criptografado do Directing. 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:
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 arrayA lista de instruções de texto; null quando não há dados. Cada item contém instruction, relativeStartTimeMs / relativeEndTimeMs (milissegundos relativos), startTime / endTime (segundos da linha do tempo) e status.chapters arrayA lista de capítulos; null quando a detecção de capítulos ainda não foi acionada. Cada item contém chapterId, title, brief, actRange, startTime, endTime e chapterImage.characterActions arrayFixo como um array vazio para o modelo Directing.environmentActions arrayFixo como um array vazio para o modelo Directing. |
Estados pré-requisitos e notas de chamada
- Sondar a cada 2–5 segundos.
- No status
running, você pode chamar os endpoints de controle suportados de acordo comcreationModel: o modo padrão suportainstruct,pause,resume,rewindeend; o modo de script suportaupdate-script,pause,resume,rewindeend. - Este endpoint não retorna
mode,aspectRatio,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.
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
Quando a Viagem está running ou paused:
- Modo padrão: Enviar Instrução de Processo.
- Modo de script: Atualização completa do script.
- Comum: Pausar / Retomar / Retroceder / Encerrar.