O ponto de entrada do SDK iOS do HappyOyster é o singleton de nível de processo HappyOysterEngine.shared. Os métodos de negócios são todos async throws, lançando OysterSDKError em caso de falha. Uma única experiência é conduzida por um identificador OysterTravel, abrangendo três modos — aventura, direção e atuação — tanto no UIKit quanto no SwiftUI.
- Este documento é a descrição de recursos externos + referência de interface para o Happy Oyster iOS SDK: ele explica os parâmetros, tempo, uso e exemplos curtos de cada tipo e método público, um por um.
- Para o fluxo de integração completo (configuração do projeto, configuração de dependências, coordenação do lado do servidor, execução de ponta a ponta), consulte a documentação do projeto de exemplo; não é repetido aqui.
1. Conceitos principais
Primeiro, alguns termos para facilitar a leitura do restante.
Conceito | Descrição |
|---|---|
token | Token de autenticação HTTP (chave de API temporária do Bailian). Seu servidor a troca por meio da API do Bailian e a entrega; ela é injetada através de |
ticket | Credencial de teste de uso único. Seu servidor a troca por meio da plataforma aberta |
World | Um mundo de IA, contendo personagens e cenários. Criado e gerenciado pelo seu servidor; o SDK não está envolvido. |
Travel | Uma única experiência em tempo real, correspondente a um identificador |
Status da sessão |
|
Modo |
|
2. Visão geral
Após integrar este SDK, seu aplicativo pode entrar em "mundos" gerados em tempo real pela IA e ter uma experiência de vídeo interativo em tempo real em três modos — adventure, directing ou acting: iniciar a experiência → reprodução em tempo real → interação em tempo real → controle de processo (pause/resume/rewind/end) → callbacks de status e erro.
Cada modo suporta um conjunto diferente de capacidades. Conduza sua UI a partir do mode retornado por start():
Capacidade |
|
|
|
|---|---|---|---|
| Sim | Não | Não |
| Não | Sim | Sim |
| Não | Sim | Sim |
| Não | Sim | Não — oculte o ponto de entrada |
| Sim | Sim | Sim |
| Aplicado | Ignorado | Ignorado |
acting são priorizados para retrato: start() retorna um aspectRatio (9:16 / 16:9) para a sessão. Use-o para escolher a orientação do player e o tamanho do contêiner antes de puxar o fluxo (veja a §8).import HappyOysterSDK; os pontos de entrada principais são de dois tipos.
HappyOysterEngine — o ponto de entrada de orquestração, um singleton de nível de processo HappyOysterEngine.shared.
Método / Propriedade | Descrição |
|---|---|
| Inicializar o tempo de execução e registrar automaticamente o mecanismo em tempo real (uma vez, antes de |
| Injetar / atualizar o token de autenticação HTTP |
| Criar um identificador de sessão com uma credencial de uso único |
| Liberar recursos (pode |
| A versão atual do SDK |
OysterTravel — o identificador de sessão para uma experiência, criado por createTravel(ticket:).
Método / Propriedade | Descrição |
|---|---|
| Visualização de reprodução (UIKit / SwiftUI) |
| Fluxo de push de mudança de status + erro / status atual observável |
| Conectar e reproduzir (opcionalmente, solicitar a duração máxima de uma experiência de aventura) |
| Instrução de texto do modo Direção |
| Controle do modo Aventura |
| Pausar / retomar ( |
| Retroceder (apenas quando pausado) |
| Encerrar (idempotente, certifique-se de chamá-lo) |
| Liberar / restaurar temporariamente o microfone |
OysterLog para assumir o registro interno do SDK; HappyOysterEngine.version para ler a versão; OysterVideoView é a visualização de reprodução do SwiftUI (equivalente a videoView). O uso é descrito mais adiante.
Ciclo de vida: inicializar → injetar token → criar sessão → montar vídeo + assinar eventos → iniciar reprodução → interagir → encerrar. O SDK não é responsável por criar ou gerenciar mundos (feito pelo seu servidor), nem expõe detalhes de comunicação em tempo real de baixo nível.
3. Início Rápido
Um fluxo completo da inicialização ao encerramento, com comentários passo a passo. Os detalhes de cada API estão na §6.
4. Requisitos
Item | Requisito |
|---|---|
Sistema operacional mínimo | iOS 15.0+ (todos os tipos públicos são marcados com |
Linguagem | Swift ( |
Concorrência | Acesso à thread principal (os tipos de entrada são marcados com |
Rede | Acesso à rede pública necessário |
Permissões |
|
Info.plist deve fornecer NSMicrophoneUsageDescription, caso contrário, iniciar a captura em tempo real causará uma falha. Quando você precisar de acesso exclusivo ao microfone (por exemplo, reconhecimento de fala), use pauseLocalAudioCapture() / resumeLocalAudioCapture() para liberá-lo e restaurá-lo temporariamente (veja a §6.2).
5. Integração e Autenticação
5.1 Integração e Dependências
import HappyOysterSDK é tudo o que você precisa no nível do código. O SDK é distribuído como um binário pré-compilado (xcframework) por meio de subspecs do CocoaPods, publicado no CocoaPods Trunk público — declare as dependências no seu Podfile:
AliVCSDK_ARTC é obrigatório sempre que você puxar HappyOysterSDK/StreamAliRTC: se estiver faltando, o SDK retorna silenciosamente ao Loopback — ele pode se conectar e alcançar running, mas mostra uma tela preta sem erro.5.2 Modelo de Autenticação
O SDK não obtém nem atualiza tokens, mantendo as coisas leves. A autenticação tem duas camadas, e o integrador gerencia seus ciclos de vida:
- Token de autenticação HTTP (chave de API temporária do Bailian): Seu servidor a troca por meio da API do Bailian e a entrega; ela é injetada através de
updateToken(_:). Alguns serviços internos do SDK chamam o gateway do Bailian diretamente, carregando este token para autenticação — portanto, deve ser uma chave de API temporária emitida pelo Bailian, não um token do seu próprio serviço de negócios. O SDK mantém apenas a mais recente, não a persiste nem a atualiza; após ela expirar, você a troca novamente e a reinjeta. - Credencial de teste de uso único
ticket: Seu servidor a troca por meio da plataforma abertaget-travel-credential(prefixotk_, válida por 30 minutos, uso único), usada como o argumentocreateTravel(ticket:); ela se torna inválida assim que a experiência termina (normal ou anormalmente) ou expira, e não pode ser reutilizada.
start / pause / resume / rewind / sendInstruct / sendCommand) são rejeitadas com 108001 e qualquer experiência em andamento é encerrada pelo SDK (veja a §9). OysterSDKError.raw carrega um motivo legível por humanos; solicite ao usuário que atualize quando a versão for muito baixa.updateToken(_:). Há dois lugares onde você precisa determinar se o token expirou:
- Ao chamar APIs como
engine.createTraveloutravel.start, trate o erro e verifique os tipos de erro de token expirado/inválido (101001/101002); após injetar um novo token, chame novamente a API correspondente. - Ao ouvir o evento
.errordeOysterTravelEvent, verifique os tipos de erro de token expirado/inválido, solicite o token novamente e injete-o.
6. Referência da API
Existem dois tipos de entrada, ambos @MainActor e @available(iOS 15.0, *). Os métodos de negócios são async throws e lançam OysterSDKError em caso de falha; os métodos com valores de retorno são todos marcados com @discardableResult.
6.1 HappyOysterEngine
Um singleton de nível de processo, o ponto de entrada de orquestração. init não é público — use sempre HappyOysterEngine.shared; não o instancie você mesmo (o mecanismo subjacente em tempo real também é um singleton de processo).
initialize(config:)
- Propósito: Inicializar o tempo de execução e registrar automaticamente o mecanismo em tempo real (nenhum registro manual necessário pelo host).
- Parâmetros:
config.apiHosté a URL do gateway Bailian, não o seu servidor de negócios, e é obrigatória; em ambientes de pré-lançamento/teste, você deve passar explicitamente o gateway correspondente, caso contrário, as solicitações falharão (por exemplo,106001, o domínio não pode ser resolvido).config.modelé o nome do modelo versionado habilitado para sua conta e também é obrigatório, sem padrão — o Happy Oyster é dividido em submodelos por modo, portanto, o SDK não pode inferir qual usar. Ambos devem pertencer à mesma conta e região do token injetado. Outros campos estão na §8OysterConfig. - Um modelo atende a um
mode: cada modelo por modo tem sua própria rota de gateway, portanto, uma únicainitializeatende apenas a mundos desse únicomode. Se o seu aplicativo oferece mundos em vários modos, basta chamarinitialize()novamente com o modelo correspondente antes de entrar em um mundo de um modo diferente — enquanto ocioso, a configuração mais recente prevalece, nenhumacleanup()é necessária e o token injetado é mantido; enquanto uma Travel está em andamento, a chamada é ignorada, portanto,end()primeiro. Um modelo que não corresponde aomodedo mundo é rejeitado pelo gateway comAccessDenied, normalizado para106003. - Quando usar: Chame uma vez antes de
createTravel, o mais cedo possível após o início do aplicativo. - Retorna:
Bool— se oconfigque você passou teve efeito. Éfalseem dois casos: a configuração é inválida (apiHost/modelem branco ou não formando uma URL de gateway válida), ou uma Viagem está em andamento, então a chamada foi ignorada. Em ambos os casos, o tempo de execução permanece inalterado. - Nota: Enquanto ocioso, chamá-lo novamente reconfigura o tempo de execução com a nova configuração (alternar
apiHost/modelnão precisa decleanup(), e o token injetado é mantido); é uma operação nula com apenas um aviso enquanto uma Travel está em andamento, portanto,end()primeiro. Uma configuração inválida deixa o tempo de execução inalterado. Não useisReadypara saber se uma re-initializefoi bem-sucedida — se for rejeitada, a configuração anterior ainda estará em vigor eisReadypermanecerátrue;isReadyresponde "o mecanismo está utilizável agora", o valor de retorno responde "a configuração que acabei de passar teve efeito".
OysterLog
- Propósito: Configurar e assumir o registro interno do SDK, imprimindo-o em seu próprio módulo de registro. Fornece
setMinimumLevel(_:)para definir o nível esetHandler(_:)para saída personalizada (veja o exemplo da §3).
updateToken(_:)
- Propósito: Injetar / atualizar o token de autenticação HTTP (Chave de API temporária do Bailian, §5.2).
- Quando usar: Após
initialize, pode ser chamado a qualquer momento; troque e chame novamente após o token expirar ou após receber um erro relacionado à autenticação (101001/101002). - Nota: Operação nula com um aviso quando não inicializado via
initialize.
createTravel(ticket:)
- Propósito: Criar um único identificador de sessão com um
ticketde uso único. - Parâmetro:
ticketé uma credencial de uso único; uma vez criada, é considerada ocupada para esta experiência. - Quando usar: Chame antes de cada nova experiência; o identificador retornado ainda não está conectado e você deve chamar
travel.start()depois. O vídeo é obtido do identificador retornado (veja a §6.2). - Nota (
throwssíncrono): lança100001se não estiverinitialized; lança103004se chamado novamente antes que a Viagem anterior tenhaend()ed (cada mecanismo permite apenas uma Viagem ativa por vez).
cleanup()
- Propósito: Liberar recursos do SDK (encerrar a viagem ativa, configuração de tempo de execução, token).
- Quando usar: Ao sair completamente do SDK ou quando precisar alterar o
config. - Nota:
async— internamente, ele deterministicamente chamaend()na viagem ativa atual primeiro, depois desmonta o tempo de execução, não deixando nada como fire-and-forget. Após a liberação, você pode chamarinitializenovamente.
6.2 OysterTravel
O identificador de sessão criado por createTravel; uso único, invalidado assim que um estado terminal (end / encerramento do lado do servidor / falha) é alcançado, exigindo um novo createTravel por meio do mecanismo. Também é um ObservableObject (@Published status, pode direcionar diretamente o SwiftUI).
videoView / OysterVideoView(travel:)
- Propósito: A entrada de renderização para a imagem remota — "o SDK fornece a visualização, o host a posiciona". Para UIKit, use
travel.videoView; para SwiftUI, useOysterVideoView(travel:). - Quando usar: Disponível assim que o identificador é criado (o acesso repetido retorna a mesma visualização); monte-o em qualquer hierarquia e, assim que o mecanismo estiver pronto, ele renderiza automaticamente. A montagem antes ou depois de
start()funciona em ambos os casos, sem tela preta. - Nota: Quando a sessão termina, o SDK libera automaticamente a vinculação de renderização; remova a visualização da hierarquia conforme necessário.
events / status / isEnded
- Propósito:
eventsé o fluxo de push de mudanças de status + erros;statusé o status externo atual observável;isEndedé um sinalizador legível sincronamente para o estado terminal. - Quando usar: Recomenda-se começar a consumir
events**antes de **start(), para evitar a perda de status iniciais. - Nota: Cada acesso a
eventsretorna um fluxo independente, suportando multi-assinatura; cancelar a assinatura = encerrar a iteraçãofor await(ou destruir aTaskmantida). No SwiftUI, você pode observar diretamente ostatuscom@StateObject/@ObservedObject(os erros ainda chegam através deevents). Veja a §7.
start() / start(maxExperienceTimeSec:)
- Propósito: Use o
ticketcapturado no momento da criação para trocar pela configuração de viagem + ingresso no RTC e conectar para reproduzir. Em caso de sucesso, o SDK estabelece automaticamente a conexão em tempo real e inicia a pesquisa interna de status, expondo o status através deevents. - Parâmetro:
maxExperienceTimeSec(opcional) — solicita a duração máxima (em segundos) desta experiência de aventura. O valor é enviado ao servidor como está; os valores permitidos, a duração efetiva real e o tempo de término automático são todos decididos pelo servidor — o SDK não realiza validação local. Passarnil(ou chamar ostart()sem parâmetros) usa a duração padrão do servidor. O modo de direção ignora este parâmetro. Quando o tempo acaba, o servidor encerra a experiência e o host recebe o estado terminalendedviaevents(o mesmo que um término no lado do servidor, consulte a §7). - Retorna:
OysterStartTravelData(mode/version/encryptedTravelId, etc., veja a §8), que determina a UI de interação. - Erros:
401010/401011(credencial inválida/usada),403002(mundo não pronto),403007(especificação de serviço não habilitada, por exemplo, acting),429001/429002(limite de simultaneidade / capacidade esgotada),500001(falha de recurso/servidor),103004(início simultâneo). - O
modedo mundo doticketdeve corresponder aomodelpassado parainitialize(responsabilidade do chamador): com modelos por modo, cada modelo tem sua própria rota de gateway, estart()envia oticketpara a rota do modelo atualmente inicializado. O SDK não verifica e não pode verificar isso para você de antemão —modeé entregue pela resposta a esta própria chamada destart()(OysterStartTravelData.mode); antes da chamada, o SDK mantém apenas umticketopaco e um nome de modelo, sem modo para comparar, e inferir o modo a partir do nome do modelo seria adivinhar um esquema de nomenclatura de propriedade do servidor, o que o SDK não faz. Portanto: antes de entrar em um mundo de um modo diferente, chameinitialize()novamente com o modelo correspondente (enquanto ocioso, a configuração mais recente prevalece — nenhumacleanup()é necessária e o token é mantido; enquanto uma Travel está em andamento, a chamada é ignorada, portanto,end()primeiro). Em caso de incompatibilidade, estestart()falha no gateway; ao diagnosticar, verifique primeiro se omodelatual e omodedo mundo doticketpertencem um ao outro e, em seguida, consulte os códigos de erro de credencial acima. - Nota (encerramento automático sem fluxo): O servidor envia um "tempo limite sem fluxo" (padrão ~30s). Se, após a conexão, nenhum fluxo for recebido dentro dessa duração (nunca alcança
running), o SDK encerra automaticamente a experiência, faz a transição parafailede expõe105006via.errordeevents(fatal; lide com isso retornando à tela pré-início, sem necessidade de cronometrar você mesmo).
pause() / resume()
- Propósito: Pausar / retomar a experiência (idempotente).
- Quando usar: Suportado pelos mundos
directingeacting; não suportado poradventure. Use omoderetornado porstart()para decidir com antecedência se deve mostrar um botão de pausa.pauserequer que o estado atual sejarunning;resumerequerpaused. - Erros:
103001(nenhuma experiência ativa),103002(estado/versão não permitidos),103003(incompatibilidade de modo).
rewind(toSec:)
- Propósito: Retroceder para os segundos especificados. Em caso de sucesso, o SDK entra novamente automaticamente com o rtcConfig original e retorna à reprodução.
- Quando usar: **Só pode ser iniciado no estado **
paused, e apenas por mundosdirecting—actingeadventurenão suportam retrocesso, portanto, oculte o ponto de entrada de retrocesso nesses modos e não o chame. - Erros:
103001,103002.
end()
- Propósito: Encerrar a experiência (idempotente, pode ser chamado repetidamente). Após uma chamada bem-sucedida ou uma saída anormal, o SDK desconecta automaticamente a conexão em tempo real, para a pesquisa e libera todos os recursos da sessão; o
ticketé invalidado ao mesmo tempo, e o identificador entra em um estado terminal. - Quando usar / Nota: Seja o usuário saindo ativamente ou a experiência terminando passivamente (expiração do temporizador, recebimento de
.ended/.failed, destruição da página), certifique-se de que um únicoend()seja alcançado, caso contrário, os recursos remotos podem não ser liberados prontamente. Recomenda-se direcionar todos os caminhos de saída para o mesmo método de limpeza idempotente.
sendInstruct(content:) (modo de direção)
- Propósito: Enviar uma instrução de texto para conduzir o enredo.
- Quando usar: Modo de direção; enviado diretamente quando
running, armazenado em cache quandopausede reenviado com o primeiro quadro após retomar pararunningvia reconexão. - Erros:
103001,103002,103003(chamado no modo aventura),403004(moderação de conteúdo),404000(viagem não encontrada).
sendCommand(_:) / flushCommands() (modo aventura)
sendCommand: Envia comandos de controle de direção/visualização/ação (veja a §8OysterAdventureCommand; fire-and-forget, sem retorno, não lança exceções). Efetivo apenas no modo adventure quandorunning. A entrada externa pode ser de alta frequência a cada quadro, e o SDK faz limitação internamente (amostragem de vitória do mais recente, fusão de quadros na taxa de linha do RTC); o host não precisa fazer limitação por conta própria. Note que a resposta do servidor aos comandos em si tem latência, então o tempo efetivo real não é fixo.flushCommands: Chamado no momento da "liberação da tecla / liberação da entrada", reenviando imediatamente o último comando já aguardando na fila; uma operação puramente nula quando não há nenhum comando pendente, não gerando nenhum novo comando.- Erros (todos exibidos via
.errordeevents, nãothrows): nenhuma experiência ativa103001; chamado no modo de direção103003; canal em tempo real não pronto / falha no envio105004.
pauseLocalAudioCapture() / resumeLocalAudioCapture()
- Propósito: Liberar / restaurar temporariamente a ocupação da captura do microfone local pelo SDK.
- Quando usar: Quando algo como reconhecimento de fala precisar de acesso exclusivo ao microfone, use
pauseprimeiro eresumedepois.
7. Eventos e Status
Os eventos estão anexados a OysterTravel.events e são o canal de push ativo do SDK para você, usados para expor situações não acionadas por suas próprias chamadas (por exemplo, problemas com a conexão em tempo real gerenciada internamente ou a pesquisa de status).
- SwiftUI:
OysterTravelé umObservableObject; use diretamente@StateObject/@ObservedObjectpara observarstatuse conduzir a UI; os erros ainda vêm deevents. - Imperativo / UIKit: em uma
Task,for await event in travel.events { ... }, eswitchsobre.statusChanged/.error; cancele aTaskmantida quando terminar.
OysterTravelStatus (5 estados de processo + 2 estados terminais):
Status | Descrição | Tratamento típico |
|---|---|---|
| após criar, antes de iniciar | — |
| conectando / reconectando (conexão / reconexão interna) | mostrar dica de conexão / reconexão |
| stream pronto, interativo (reprodução interna) | mostrar imagem e controles |
| pausa aceita, aguardando confirmação do servidor | mostrar "pausando…" |
| pausado (confirmado) | mostrar estado pausado (apenas |
| encerrado (encerramento ativo ou pelo servidor). Terminal | encerrar e fechar a página |
| falhou. Terminal | mostrar erro e encerrar |
ended / failed, a sessão foi encerrada e todas as operações da sessão (pause/resume/sendCommand…) não têm mais efeito. Os callbacks podem ser acionados na thread principal, para que você possa atualizar a UI diretamente.8. Modelos de dados
@available(iOS 15.0, *). Os valores de retorno/parâmetros abaixo são saídas do SDK, construídos internamente no local com tipos nativos do Swift (Date / TimeInterval / OysterTravelStatus); eles não Codable são e não expõem detalhes do formato de rede (snake_case) — a decodificação do formato de rede acontece dentro do SDK.- Nota: os rawValues dos comandos estão em lower camelCase (por exemplo,
front/mouseLeft/jump); os valores de enumeração acima são autoritativos. - Nota:
modeé externamenteadventure(wander) /directing(história) /acting(interpretação de papéis); a definição deOysterModeValueé autoritativa. - Nota:
aspectRatioé uma string aberta (atualmente9:16/16:9, mais podem ser adicionadas). Analise-a comowidth:heighte compare a proporção em vez de corresponder a valores conhecidos.
9. Códigos de erro
O SDK relata erros uniformemente como OysterSDKError, e o tipo é sempre distinguido por code — não julgue o tipo por "qual caminho o erro veio": o mesmo code pode ser lançado por um método de negócio (async throws) ou exposto via .error de events. Para correspondência tipada, use error.kind (veja a §8 OysterErrorKind).
Códigos de erro: servidor 4xxxxx/5xxxxx, cliente-local 1xxxxx.
Códigos de Erro do Servidor (comuns)
code | Significado | Tratamento sugerido |
|---|---|---|
| Parâmetros inválidos (valor de enum inválido, etc.) | Verifique os parâmetros da solicitação ou a versão do SDK |
| Credencial da experiência ( | Solicite ao servidor que reemita a credencial |
| Credencial da experiência ( | Credencial de uso único; reemitir |
| O mundo não existe, foi excluído ou não pertence ao desenvolvedor atual (incluindo um mundo excluído após a emissão da credencial) | Escolha um World válido novamente |
| Estado do World não está pronto | Aguarde o World estar pronto antes de iniciar |
| A API permite apenas a chave de API primária | Uma chave temporária não pode ser usada para esta API |
| Conteúdo de entrada rejeitado pela moderação de conteúdo; aplica-se às instruções de texto de | Altere a entrada e tente novamente |
| A especificação de serviço solicitada não está habilitada | Não tente novamente como se a capacidade estivesse cheia; mude para uma especificação habilitada (normalmente: a conta não tem especificação de atuação) |
| Configuração de capacidade temporariamente indisponível | Tente novamente mais tarde |
| O recurso não existe (propriedade do mundo/wander ou nenhum artefato) | Verificar ID / status |
| A solicitação entra em conflito com o estado atual do recurso | Verifique o estado da experiência |
| Limite de concorrência atingido para esta especificação | Tente novamente após o término de uma sessão existente (não confunda com |
| Capacidade disponível insuficiente | Tente novamente mais tarde |
| Erro interno do sistema | Tente novamente mais tarde / reporte |
| Falha na alocação de recursos de inferência ou no serviço interno | Tente novamente mais tarde |
Códigos de Erro do Cliente Local
code | Significado | O SDK encerra a sessão automaticamente | Tratamento sugerido |
|---|---|---|---|
| Chamado antes da inicialização do SDK; também cobre um | Não (lançado sincronamente, rejeitando esta chamada) |
|
| Token de autenticação HTTP não injetado | Não | tente novamente após |
| Token de autenticação HTTP inválido / rejeitado | Não | troque o token e tente novamente com |
| Nenhuma experiência ativa no momento | Não (rejeitando esta chamada) |
|
| O estado/versão atual não permite esta operação | Não (rejeitando esta chamada) | verificar estado da experiência / |
| Incompatibilidade de modo (por exemplo, | Não (rejeitando esta chamada) | escolha a API correta por |
| Criação/início concorrente da experiência | Não (lançado sincronamente) | serializar chamadas, |
| Falha na conexão em tempo real | Sim | encerrar e reiniciar |
| Tempo limite de entrada em tempo real | Sim | encerrar e reiniciar |
| Tempo limite ao aguardar o primeiro quadro de vídeo | Sim | encerrar e reiniciar |
| Canal em tempo real não está pronto / falha no envio | depende (falha no envio ativo; o heartbeat é apenas para relatório) | enviar após |
| Tempo limite de callback (padrão 30s) | Não | tente novamente e aumente |
| Nenhum stream após a entrada; o SDK encerra a experiência automaticamente | Sim | encerrar e reiniciar |
| Erro de rede local | Não | tente novamente |
| Falha ao analisar a resposta | depende | atualize o SDK / reporte |
| Nenhum código de erro reconhecível / código de erro de string de proxy | Não | tente novamente |
| Desativado remotamente pelo interruptor de recursos do servidor (desligamento total ou versão muito antiga; motivo em | Sim | Siga o motivo em |
OysterSDKError não tem isFatal). Semanticamente, "fatal" significa especificamente se o SDK encerra ativamente a sessão (desconectar o RTC, liberar toda a sessão) —
- Erros que encerram automaticamente a sessão (por exemplo,
105001/105002/105003/105006/108001): o host percebe isso a partir do estado terminal da máquina de estados (status → failed, exposto via.statusChangeddeevents), e retorna para a tela antes de "iniciar experiência" de acordo, sem necessidade de julgar a própria fatalidade. - Erros de rejeição de chamada (
100001/103001/103002/103003/103004): lançados sincronamente / a chamada é rejeitada quando você chama ativamente; eles não encerram a sessão. - Outros erros não fatais (por exemplo,
101001/101002/105005/106001/106003): eles não encerram a sessão; tente novamente conforme sugerido ou continue após reinjetar o token.
106001 pode ter duas causas: um erro de rede local ou um apiHost incorreto. Se tentar novamente não recuperar a solicitação, verifique se apiHost está configurado corretamente.106003 aparecendo após você definir model geralmente significa que o nome/versão do modelo está errado ou não está habilitado para sua conta: verifique o modelo junto com o apiHost e o token, que devem pertencer à mesma conta e região — o gateway rejeita uma incompatibilidade com AccessDenied, normalizado para este código.