O cliente usa o ticket para criar uma Travel real e obter a configuração de entrada RTC, a versão de capacidade do Acting e a proporção de aspecto do player. Uma chamada bem-sucedida cria a Travel.
Escopo
O cliente usa o ticket para criar uma Travel real e obter a configuração de entrada RTC, a versão de capacidade do Acting e a proporção de aspecto do player. Antes de chamar, confirme o seguinte:
- Autenticação: A API Key primária não é obrigatória; o
ticketcompleta a validação de entrada na sala. Para saber como obtê-lo, veja Obter credenciais de autenticação. - Pré-requisitos: O
ticketé obtido em Obter Credencial da Travel, não está expirado nem foi usado, e o status do seu Mundo éready. - Chamador: Chamado pelo seu cliente.
Solicitação HTTP
- Singapore
- EUA (Virgínia)
POST https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/api/v2/apps/happyoyster-1.0-acting/openapi/v1/travels/enter-travelSubstitua {WorkspaceId} pelo seu ID do Workspace real.Parâmetros da solicitação |
|
Content-Typestring(Obrigatório)Tipo de conteúdo da solicitação. Este parâmetro deve ser definido como application/json. | |
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.
| |
Corpo da solicitação | |
ticket string (Obrigatório)Uma credencial de uso único, não expirada e não utilizada, obtida em Obter Credencial da Travel. Reutilizar o mesmo ticket retorna 401011. |
O Acting não consome
maxExperienceTimeSec; não o passe. Se um nível inválido ainda for passado, 400000 será retornado antes do roteamento do modelo.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 stringO ID criptografado da Travel recém-criada. Usado para consultas subsequentes de Status da Travel, pausa, retomada, término e artefatos.encryptedWorldId stringO ID criptografado do Mundo ao qual esta Travel corresponde.mode integerSempre 3 para Acting.creationModel stringSempre simple para Acting.playUrl nullAinda não disponível; fixado em null.firstFrame stringURL do primeiro quadro do Mundo.rtcConfig objectConfiguração de entrada RTC; null quando não há canal de streaming disponível, caso em que o cliente não pode iniciar a reprodução com base nela.
stringA versão de entrada na sala do Acting, fixada em actingV2. As interfaces de controle devem ser chamadas de acordo com esta versão.aspectRatio stringProporção de aspecto. O cliente deve definir a orientação do player adequadamente antes de puxar o fluxo:
integerTempo limite de término automático sem fluxo em segundos, padrão de 30; a resposta real prevalece. Se rtcStatus não entrar no estado de streaming dentro deste tempo após entrar na sala, chame Encerrar Travel com failCode=TRAVEL_NO_STREAM_AUTO_END.maxExperienceTimeSec nullO Acting não usa a duração máxima da experiência; fixado em null. |
Estados pré-requisitos e notas de chamada
- O Mundo correspondente ao
ticketdeve estarready, e o ticket não deve estar expirado nem usado. - Uma chamada bem-sucedida cria a Travel; reutilizar o mesmo
ticketretorna401011. - Quando o recurso ou especificação do Acting não está habilitado,
403007é retornado e nenhuma Travel é criada. versiondeve ser tratado comoactingV2; não chame interfaces de controle de acordo com outra versão de capacidade.- O cliente deve ler
aspectRatioantes de estabelecer o pull do fluxo ou o contêiner de renderização: use um contêiner retrato para9:16e um contêiner paisagem para16:9. - Não passe
maxExperienceTimeSec. O Acting não encerra automaticamente por este campo, e o cliente não deve usá-lo para implementar uma contagem regressiva. rtcConfig=nullsignifica que não há atualmente nenhum canal de streaming disponível, e o cliente não pode iniciar a reprodução com base nele.
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 entrar na sala com sucesso:
- Consultar Status da Travel: sondar a cada 2–5 segundos; você pode enviar instruções quando a Travel estiver
runningoupaused. - Enviar Instrução de Processo: conduzir a performance de role-play subsequente.
- Pausar Travel / Retomar Travel: controlar o ritmo de execução conforme necessário.
- Encerrar Travel: ao encerrar, ela entra em
completede o processamento de artefatos começa.