Skip to main content

Referência da API do Web SDK HappyOyster

HappyOysterEngine configura o host e o modelo da Open Platform, atualiza o token temporário de chave de API do Model Studio e cria sessões Travel. Travel é o objeto de sessão retornado por createTravel(); a sessão é acessada e iniciada somente após chamar travel.start(). Suporta os modos adventure, directing e acting.

HappyOysterEngine configura o host da Open Platform, atualiza o token temporário de chave de API do Model Studio e cria sessões Travel. Travel é o objeto de sessão retornado por createTravel(). A sessão é acessada e iniciada somente após travel.start() ser chamado.

Terminologia Principal

Termo

Significado

Observações

token

Token temporário de chave de API do Model Studio: ao chamar serviços do Model Studio a partir de ambientes não confiáveis, como navegadores ou aplicativos móveis, gere uma chave de API temporária por meio de um backend seguro para evitar a exposição de uma chave de API permanente. O SDK envia este token para a Open Platform como uma credencial HTTP Bearer.

Obter credenciais de autenticação

ticket

Credencial de Travel do mundo HappyOyster: seu backend chama a API de credenciais usando autenticação AK (cabeçalho do gateway) para obter uma credencial de Travel de curta duração (ticket) que o cliente usa para entrar em uma sala. A API verifica a propriedade do mundo, mas não cria um registro real de Travel.

Obter credenciais de autenticação

Visão geral

O SDK fornece os seguintes objetos principais:

HappyOysterEngine

API

Descrição

new HappyOysterEngine(config)

Cria uma instância do Engine.

updateToken(token)

Atualiza o token de chave de API temporária do Model Studio usado pelas solicitações subsequentes à API da Open Platform.

createTravel(config)

Cria uma sessão Travel.

HappyOysterEngine.version

A versão atual do SDK.

HappyOysterEngine.metadata

O nome do pacote SDK atual, versão e canal do pacote.

Viagem

API

Descrição

start()

Inicia a sessão Travel atual.

on("statusChanged", handler)

Inscreve-se nas alterações de status da sessão.

on("firstFrameGenerated", handler)

Inscreve-se nas notificações de URL do primeiro quadro.

on("travelInfoReady", handler)

Inscreve-se nos metadados da sessão disponíveis imediatamente após entrar no travel.

onError(handler)

Inscreve-se nos erros de tempo de execução da sessão.

can(action)

Verifica se a ação especificada pode ser chamada atualmente.

getInfo()

Obtém metadados da sessão disponíveis; retorna null antes que estejam disponíveis.

sendCommand(params)

Envia um comando de controle em tempo real.

sendInstruct(params)

Envia instruções de Direção ou conteúdo de prompt.

pause()

Pausa a sessão atual.

resume()

Retoma uma sessão pausada.

rewind(params)

Retrocede uma sessão de Direção para o tempo especificado.

end()

Encerra a sessão atual e libera seus recursos.

Outras Exportações

Exportação

Descrição

ErrorCode

O objeto constante de códigos de erro exportado pelo SDK.

isSdkError(error)

Verifica se um erro desconhecido é um erro padrão do SDK.

Tipos

Tipos públicos como SDKConfig, Travel, StartTravelResult e AdventureCommand.

Exemplo

import { HappyOysterEngine, isSdkError } from '@happy-oyster/js-sdk'

const engine = new HappyOysterEngine({
  APIHost: 'open-platform.example.com',
  model: 'happyoyster-1.0-adventure', // Required; Adventure model shown as an example
  token: 'bailian-temporary-api-key-token',
  logLevel: 'warn',
  streamReadyTimeout: 15_000,
})

const videoElement = document.getElementById('player') as HTMLVideoElement
const travel = engine.createTravel({
  ticket: 'travel-ticket',
  videoElement,
  maxExperienceTimeSec: 90,
})

const unsubscribeStatus = travel.on('statusChanged', (status) => {
  console.log('Travel status:', status)
})

const unsubscribeFirstFrame = travel.on('firstFrameGenerated', (firstFrame) => {
  console.log('First frame URL:', firstFrame)
})

const unsubscribeInfo = travel.on('travelInfoReady', (info) => {
  console.log('Travel info is ready before RTC playback:', info)
})

const unsubscribeError = travel.onError((error) => {
  console.error('Travel error:', error)
})

try {
  const { encryptedTravelId, mode, creationModel, firstFrame, maxExperienceTimeSec, aspectRatio } = await travel.start()

  // Adventure (mode 1)
  await travel.sendCommand({
    translation: 'Front',
    rotation: 'Mouse_Left',
    interaction: 'Jump',
  })

  // Directing (mode 2) or Acting (mode 3; not scriptlist)
  await travel.sendInstruct({ content: 'Turn the camera toward the castle and have the protagonist start running' })

  await travel.pause()
  await travel.resume()
} catch (err) {
  if (isSdkError(err)) {
    console.error('SDK error:', err.code, err.message)
  } else {
    console.error('Unexpected error:', err)
  }
} finally {
  unsubscribeStatus()
  unsubscribeFirstFrame()
  unsubscribeInfo()
  unsubscribeError()
  await travel.end()
}

engine.updateToken('new-bailian-temporary-api-key-token')

HappyOysterEngine

HappyOysterEngine é o ponto de entrada do Web SDK. Ele configura o host da Open Platform, gerencia o token temporário de chave de API do Model Studio usado pelas solicitações subsequentes e cria sessões Travel.
Uma instância de Engine gerencia atualmente apenas um Travel ativo por vez. Encerre o Travel atual antes de iniciar uma nova sessão.Depois que um token é definido no construtor ou por meio de updateToken(), o SDK busca internamente a configuração do Feature Gate. Isso permite que a plataforma desative remotamente o SDK ou exija que versões mais antigas sejam atualizadas. Se a solicitação falhar, o SDK falha de forma aberta e não bloqueia a experiência normal.

API

Descrição

new HappyOysterEngine(config)

Cria uma instância de Engine com o host de API e o modelo obrigatórios, além de token e nível de log opcionais.

updateToken(token)

Atualiza o token de chave de API temporária do Model Studio usado pelas solicitações subsequentes à Open Platform.

createTravel(config)

Cria uma sessão Travel que ainda não foi iniciada.

new HappyOysterEngine

Cria uma instância de HappyOysterEngine.

Assinatura

new HappyOysterEngine(config: SDKConfig)

Parâmetros

SDKConfig

Campo

Tipo

Obrigatório

Descrição

APIHost

string

Sim

Host da API da Open Platform. Deve ser um host simples, como open-platform.example.com, sem https://, esquema ou caminho.

model

string

Sim

Identificador do modelo da Open Platform a ser usado. Obrigatório, sem valor padrão. Fixo para este Engine e compartilhado por todos os seus Travels.

token

string

Não

Token temporário de chave de API do Model Studio definido durante a construção. Também pode ser definido posteriormente com updateToken().

logLevel

LogLevel

Não

Nível de log do SDK. O padrão é none.

streamReadyTimeout

number

Não

Tempo limite para aguardar <video> tornar-se reproduzível, parar ou retomar, em milissegundos. O padrão é 15000.

Defina model como um identificador de modelo, como happyoyster-1.0-adventure, um modelo Adventure. Use o identificador de modelo para o ambiente de serviço de destino. O SDK não escolhe um modelo a partir do mode da experiência nem o infere a partir do ticket. Um Engine possui um APIHost + model fixo. Reutilize-o para Travels sucessivos direcionados ao mesmo serviço e modelo. Antes de alternar qualquer um dos valores, encerre o Travel ativo e use um Engine configurado para o novo alvo. Crie o mundo e emita seu ticket para o mesmo alvo de serviço.

Retornos

Retorna uma instância de HappyOysterEngine.

Erros

Se config estiver ausente, ou se APIHost, model, token, logLevel ou streamReadyTimeout tiver um tipo ou valor inválido, um SdkError com código ErrorCode.INVALID_ARGUMENT (10010001) será lançado sincronamente. Passar uma URL completa, uma string vazia ou um valor com caminho como APIHost é inválido. model é obrigatório e deve ser uma string não vazia após remoção de espaços; null, valores não string e strings contendo apenas espaços em branco são inválidos. Omiti-lo ou passar undefined também gera um erro de argumento; o SDK não possui modelo padrão.

HappyOysterEngine.updateToken

Atualiza o token de chave de API temporária do Model Studio usado pelas solicitações subsequentes à API da Open Platform.

Assinatura

updateToken(token: string): void

Parâmetros

Campo

Tipo

Obrigatório

Descrição

token

string

Sim

Token de chave de API temporária do Model Studio. Passar uma string em branco limpa o token atual.

Retornos

Não retorna nada.

Erros

Se token não for uma string, um SdkError com código ErrorCode.INVALID_ARGUMENT (10010001) será lançado sincronamente.

HappyOysterEngine.createTravel

Cria uma instância de sessão Travel sem iniciá-la.

Assinatura

createTravel(config: CreateTravelConfig): Travel

Parâmetros

CreateTravelConfig

Campo

Tipo

Obrigatório

Descrição

ticket

string

Sim

Ticket usado para iniciar o Travel posteriormente.

videoElement

HTMLVideoElement

Sim

O elemento <video> usado para renderizar o vídeo da sessão. Ele deve ser fornecido ao criar o Travel.

maxExperienceTimeSec

60 | 90 | 120

Não

Duração máxima da experiência Adventure, em segundos. As sessões Directing e Acting ignoram este campo. Quando omitido, o servidor aplica seu valor padrão.

Retornos

Retorna uma sessão Travel criada, mas ainda não iniciada. O chamador deve então executar await travel.start() para entrar na sessão e aguardar até que o vídeo se torne reproduzível. Cada instância de HappyOysterEngine pode ter apenas um Travel ativo por vez. Chame await travel.end() antes de criar outro Travel.

Erros

createTravel() lança um SdkError sincronamente nos seguintes casos:

ErrorCode

Descrição

10010001

config, ticket, videoElement ou maxExperienceTimeSec é inválido

10010101

Um Travel já está ativo; chame travel.end() primeiro

Erros de inicialização são expostos por travel.start().

Travel

Travel representa uma sessão criada por HappyOysterEngine.createTravel(). Ela está inicialmente inativa. Após travel.start() ser chamado, o SDK entra na sessão e aguarda até que o vídeo se torne reproduzível. Travel suporta iniciar, pausar, retomar, retroceder e encerrar uma sessão; enviar controles e prompts em tempo real; e inscrever-se em alterações de status e erros de tempo de execução.

Métodos

Método

Descrição

start()

Inicia a sessão Travel atual.

on("statusChanged", handler)

Inscreve-se nas alterações de status da sessão.

on("firstFrameGenerated", handler)

Inscreve-se nas notificações de URL do primeiro quadro.

on("travelInfoReady", handler)

Inscreve-se nos metadados da sessão disponíveis imediatamente após entrar no travel.

onError(handler)

Inscreve-se nos erros de tempo de execução da sessão.

can(action)

Verifica se a ação especificada pode ser chamada atualmente.

getInfo()

Obtém metadados da sessão disponíveis; retorna null antes que estejam disponíveis.

sendCommand(params)

Envia um comando de controle em tempo real.

sendInstruct(params)

Envia instruções de Direção ou conteúdo de prompt.

pause()

Pausa a sessão atual.

resume()

Retoma uma sessão pausada.

rewind(params)

Retrocede a sessão atual para o tempo especificado.

end()

Encerra a sessão atual e libera seus recursos.

Status

Status

Descrição

idle

A sessão não foi iniciada.

prepare

A sessão está iniciando e aguardando o vídeo ficar reproduzível.

running

A sessão está em execução.

paused

A sessão está pausada e pode ser retomada ou retrocedida.

completed

A sessão terminou normalmente e seus recursos foram liberados.

Eventos

Inscreva-se em eventos com travel.on(event, handler). O método retorna uma função de cancelamento de inscrição.

Evento

Callback

Descrição

statusChanged

(status: TravelStatus) => void

O status da sessão foi alterado.

firstFrameGenerated

(firstFrame: string) => void

Emitido durante start() quando a Open Platform retorna uma URL de primeiro quadro não vazia; antes de start() ser resolvido e o vídeo tornar-se reproduzível.

travelInfoReady

(info: TravelInfo) => void

Emitido após o retorno de enter-travel e antes da conexão RTC. getInfo() retorna os mesmos dados; se existir um primeiro quadro, firstFrameGenerated será emitido em seguida.

error

(error: unknown) => void

Um erro de runtime da sessão.

Travel.can

Verifica se uma ação está disponível para o status atual e capacidade da sessão.

Assinatura

can(action: TravelAction): boolean

Parâmetros

Campo

Tipo

Obrigatório

Descrição

action

TravelAction

Sim

Ação a verificar: start / sendCommand / sendInstruct / pause / resume / rewind / end.

Retornos

Retorna um boolean. true significa que a ação está disponível no momento; false significa que o status atual, modo ou capacidade da sessão não atende às suas pré-condições.

Disponibilidade

action

Disponibilidade

start

Travel ainda está idle, não foi fechado e nunca foi iniciado.

sendCommand

running, com o modo Travel definido como Aventura (1).

sendInstruct

running ou paused, com modo definido como Directing (2) ou Acting (3), e não scriptlist.

pause

running, e a sessão atual suporta pausa.

resume

paused, e a sessão atual suporta retomada.

rewind

paused em uma sessão de Direção que suporta retrocesso; Atuação não suporta.

end

A Travel não foi fechada.

Erros

Este método não lança erros de negócio. Ações desconhecidas retornam false.

Travel.start

Inicia a sessão Travel atual.

Assinatura

start(): Promise<StartTravelResult>

Parâmetros

Sem parâmetros.

Retornos

Retorna um Promise<StartTravelResult>, que é resolvido após o início da sessão e quando o vídeo se torna reproduzível. Após o retorno de enter-travel, o SDK emite travelInfoReady antes de conectar o RTC. Assinantes tardios podem chamar travel.getInfo(); ele retorna null antes que os metadados estejam disponíveis. Se a resposta incluir um firstFrame não vazio, firstFrameGenerated ainda será emitido.

StartTravelResult

Campo

Tipo

Descrição

encryptedTravelId

string

ID da sessão Travel atual.

mode

number

Modo de sessão: 1 = Adventure (exploração de mundo), 2 = Directing (direção em tempo real), 3 = Acting.

creationModel

string

Modelo de criação de Mundo; valores comuns são simple e scriptlist.

firstFrame

string | null

URL da imagem do primeiro quadro; null se o servidor não retornar uma.

maxExperienceTimeSec

60 | 90 | 120 | null

Duração máxima da experiência Adventure, em segundos. null para sessões Directing e Acting ou quando o servidor não retorna este campo.

aspectRatio

"9:16" | "16:9" | null

Proporção de aspecto da Atuação; null para outros modos ou quando o servidor não a retorna.

Erros

start() é rejeitado e emite um evento error nos seguintes casos. Use isSdkError(err) para verificar o erro e ler err.code e err.message.

ErrorCode

Descrição

10010002

Recurso do SDK está desabilitado (SDK_FEATURE_DISABLED)

10020101

Não foi possível iniciar: o status atual não permite, a Open Platform não está configurada ou a entrada na sessão falhou

10020102

Não foi possível iniciar: a configuração da sessão retornada pelo servidor está incompleta

10020103

Não foi possível iniciar: falha na conexão do fluxo de vídeo ou falha na solicitação de sinalizador de recurso do SDK

10020104

Não foi possível iniciar: tempo limite esgotado ao aguardar o stream de vídeo (usa o maior valor entre streamReadyTimeout e noStreamAutoEndTimeoutSec do servidor)

10020105

Não foi possível iniciar: tempo limite esgotado ao aguardar o vídeo tornar-se reproduzível (controlado por streamReadyTimeout; padrão: 15 segundos)

10000001–10000012

Erro de parâmetro, recurso ou servidor da Open Platform

Travel.on("statusChanged")

Inscreve-se nas alterações de status da sessão.

Assinatura

on("statusChanged", handler: (status: TravelStatus) => void): () => void

Parâmetros

Campo

Tipo

Obrigatório

Descrição

handler

(status: TravelStatus) => void

Sim

Callback invocado quando o status é alterado.

Retornos

Retorna uma função de cancelamento de inscrição. TravelStatus é um dos seguintes: idle / prepare / running / paused / completed.

Erros

Este método não lança erros de negócio.

Travel.on("firstFrameGenerated")

Inscreve-se nas notificações de URL do primeiro quadro.

Assinatura

on("firstFrameGenerated", handler: (firstFrame: string) => void): () => void

Parâmetros

Campo

Tipo

Obrigatório

Descrição

handler

(firstFrame: string) => void

Sim

Callback invocado quando a URL do primeiro quadro está disponível.

Retornos

Retorna uma função de cancelamento de inscrição.

Comportamento

Emitido apenas durante travel.start(). Depois que o SDK chama o enter-travel da Open Platform e recebe um firstFrame não vazio, ele emite o evento imediatamente — geralmente após statusChanged("prepare"), mas antes de start() ser resolvido e o vídeo tornar-se reproduzível. O evento não é emitido se a resposta não contiver uma URL de primeiro quadro.

Erros

Este método não lança erros de negócio.

Travel.onError

Inscreve-se nos erros de tempo de execução da sessão.

Assinatura

onError(handler: (error: unknown) => void): () => void

Parâmetros

Campo

Tipo

Obrigatório

Descrição

handler

(error: unknown) => void

Sim

Callback invocado quando ocorre um erro de tempo de execução.

Retornos

Retorna uma função de cancelamento de inscrição. Use isSdkError para restringir o objeto de erro a SdkError.

Erros

Este método não lança erros de negócio.

Travel.sendCommand

Envia um comando de controle em tempo real.

Assinatura

sendCommand(params: AdventureCommand): Promise<void>

Parâmetros

AdventureCommand

Campo

Tipo

Obrigatório

Descrição

translation

string

Não

Direção do movimento. O padrão é None quando omitido.

rotation

string

Não

Rotação da visualização. O padrão é None quando omitido.

interaction

string

Não

Ação de interação. O padrão é None quando omitido.

Referência de Comandos de Controle

translation — Direção de Movimento
Descreve o movimento do personagem, suportando oito direções e combinações.

Valor

Direção

"Front"

Frente

"Back"

Para trás

"Left"

Esquerda

"Right"

Direita

"Front_Left"

Frente-esquerda

"Front_Right"

Frente-direita

"Back_Left"

Trás-esquerda

"Back_Right"

Trás-direita

"None"

Parado

rotation — Rotação da Visualização
Simula a rotação da visualização baseada no mouse em oito direções.

Valor

Direção

"Mouse_Up"

Cima

"Mouse_Down"

Baixo

"Mouse_Left"

Esquerda

"Mouse_Right"

Direita

"Mouse_Up_Left"

Cima-esquerda

"Mouse_Up_Right"

Cima-direita

"Mouse_Down_Left"

Baixo-esquerda

"Mouse_Down_Right"

Baixo-direita

"None"

None

interaction — Ação de Interação

Valor

Ação

"Jump"

Pular

"Attack"

Atacar

"Crouch"

Agachar

"Sprint"

Correr

"None"

None

Retornos

Retorna um Promise<void> que é resolvido após o envio do comando.

Erros

sendCommand() é rejeitado nos seguintes casos:

ErrorCode

Descrição

10010001

params ou um parâmetro de movimento, rotação ou interação é inválido

10020501

O status atual ou o modo da sessão não permite comandos, ou o comando do fluxo de vídeo falhou

Travel.sendInstruct

Envia instruções de Direção ou conteúdo de prompt.

Assinatura

sendInstruct(params: InstructData): Promise<void>

Parâmetros

InstructData

Campo

Tipo

Obrigatório

Descrição

content

string

Sim

Conteúdo do prompt a ser enviado.

Retornos

Retorna um Promise<void> que é resolvido após a Open Platform receber e processar a instrução.

Erros

sendInstruct() é rejeitado e emite um evento error nos seguintes casos:

ErrorCode

Descrição

10020101

A sessão não foi iniciada

10020601

Falha ao enviar a instrução de Direção

10000001–10000012

Erro de parâmetro, recurso ou servidor da Open Platform

Travel.pause

Pausa a sessão atual.

Assinatura

pause(): Promise<void>

Parâmetros

Sem parâmetros.

Retornos

Retorna um Promise<void> que é resolvido após a parada da reprodução do vídeo.

Erros

pause() é rejeitado nos seguintes casos:

ErrorCode

Descrição

10020201

O status atual, o modo de sessão ou a capacidade da sessão não permite pausar, ou a solicitação de pausa falhou

10020202

Tempo esgotado ao aguardar o backend relatar o fluxo de vídeo como pausado (15 segundos)

10000001–10000012

Erro de parâmetro, recurso ou servidor da Open Platform

Travel.resume

Retoma uma sessão pausada.

Assinatura

resume(): Promise<void>

Parâmetros

Sem parâmetros.

Retornos

Retorna um Promise<void> que é resolvido após o vídeo ficar reproduzível novamente.

Erros

resume() é rejeitado nos seguintes casos:

ErrorCode

Descrição

10020301

O status atual, o modo de sessão ou a capacidade da sessão não permite retomar, ou a solicitação de retomada falhou

10020302

Tempo esgotado ao aguardar o vídeo ficar reproduzível novamente (15 segundos)

10000001–10000012

Erro de parâmetro, recurso ou servidor da Open Platform

Travel.rewind

Retrocede a sessão atual para o tempo especificado.

Assinatura

rewind(params: RewindTravelParams): Promise<RewindTravelResult>

Parâmetros

RewindTravelParams

Campo

Tipo

Obrigatório

Descrição

rewindToSec

number

Sim

Tempo alvo em segundos. Apenas múltiplos de 4 são suportados (por exemplo, 4, 8 ou 12). O servidor arredonda outros valores para baixo (por exemplo, 7 torna-se 4).

Retornos

Retorna um Promise<RewindTravelResult> que é resolvido após a conclusão do retrocesso e a retomada da reprodução.

RewindTravelResult

Campo

Tipo

Descrição

resumedAtSec

number

O tempo real em segundos em que o servidor retomou a reprodução.

Erros

rewind() é rejeitado e emite um evento error nos seguintes casos:

ErrorCode

Descrição

10020101

A sessão não foi iniciada

10020401

Não foi possível retroceder: a sessão deve primeiro ser pausada e a reprodução do vídeo interrompida, ou a solicitação de retrocesso ou reconexão RTC falhou

10020402

Tempo esgotado ao aguardar a retomada do vídeo após retrocesso (15 segundos)

10000001–10000012

Erro de parâmetro, recurso ou servidor da Open Platform

Travel.end

Encerra a sessão atual e libera seus recursos.

Assinatura

end(): Promise<void>

Parâmetros

Sem parâmetros.

Retornos

Retorna um Promise<void> que é resolvido após a conclusão da limpeza.

Erros

Erros de limpeza não são lançados para o chamador; end() faz o melhor esforço para liberar recursos.

Tratamento de Erros

O SDK expõe erros de tempo de execução por meio de rejeições de Promise ou eventos error. Os erros são objetos SdkError; use isSdkError(err) e leia err.code e err.message. Erros reconhecidos da Open Platform mapeiam para o intervalo 10000001–10000012, e err.message contém a mensagem da plataforma. Consulte a seção Erros de cada API Travel para obter códigos específicos do método.

Referência de ErrorCode

Intervalos de códigos de erro:
  • 100000xx: Erros mapeados da Open Platform
  • 1001xxxx: Erros do cliente Engine
  • 1002xxxx: Erros do cliente Travel

code

name

Descrição

10000001

OPEN_PLATFORM_PARAM_INVALID

Parâmetros de solicitação inválidos (retornados pela Open Platform)

10000002

OPEN_PLATFORM_RESOURCE_NOT_FOUND

Recurso não encontrado (Travel ausente, não possuído, em outro workspace ou artefato não pronto)

10000003

OPEN_PLATFORM_WORLD_NOT_OWNED

O Mundo não existe, foi excluído ou não pertence ao desenvolvedor atual

10000004

OPEN_PLATFORM_SYSTEM_ERROR

Erro do sistema

10000005

OPEN_PLATFORM_TICKET_INVALID

O ticket é inválido ou expirou

10000006

OPEN_PLATFORM_TICKET_USED

O ticket já foi usado (credencial de uso único)

10000007

OPEN_PLATFORM_WORLD_NOT_READY

O Mundo não está pronto e não pode ser acessado

10000008

OPEN_PLATFORM_INFERENCE_ALLOCATE_FAILED

Falha na alocação de recursos de inferência (capacidade insuficiente, falha na criação de stream, falha na inicialização da sessão, etc.)

10000009

OPEN_PLATFORM_MAIN_API_KEY_REQUIRED

Esta API aceita apenas a chave de API primária (chaves de API temporárias não são suportadas)

10000010

OPEN_PLATFORM_CONTENT_MODERATION

Entrada rejeitada pela moderação de conteúdo

10000011

OPEN_PLATFORM_CONTENT_COPYRIGHT

A imagem de entrada viola direitos autorais ou política de propriedade intelectual

10000012

OPEN_PLATFORM_STATE_CONFLICT

A solicitação entra em conflito com o estado atual do recurso

10010001

INVALID_ARGUMENT

Falha na validação de argumento do cliente SDK (não mapeado da Open Platform)

10010002

SDK_FEATURE_DISABLED

Recurso do SDK está desativado

10010101

ACTIVE_TRAVEL_EXISTS

Uma Travel já está ativa

10020001

STREAM_DISCONNECTED_WHILE_PLAYING

Fluxo de vídeo desconectado durante a reprodução

10020101

START_REQUEST_FAILED

Falha na solicitação de início da sessão

10020102

START_RTC_CONFIG_MISSING

Configuração do fluxo de vídeo ausente durante a inicialização

10020103

START_JOIN_CHANNEL_FAILED

Falha na conexão do fluxo de vídeo

10020104

START_REMOTE_USER_TIMEOUT

Tempo esgotado ao aguardar o fluxo de vídeo

10020105

START_STREAM_TIMEOUT

Tempo esgotado ao aguardar o vídeo ficar reproduzível

10020201

PAUSE_REQUEST_FAILED

Falha na solicitação de pausa

10020202

PAUSE_STREAM_TIMEOUT

Tempo esgotado ao aguardar a pausa do vídeo

10020301

RESUME_REQUEST_FAILED

Falha na solicitação de retomada

10020302

RESUME_STREAM_TIMEOUT

Tempo esgotado ao aguardar a retomada do vídeo

10020401

REWIND_REQUEST_FAILED

Falha na solicitação de retrocesso

10020402

REWIND_STREAM_TIMEOUT

Tempo esgotado ao aguardar a retomada do vídeo após retrocesso

10020501

SEND_COMMAND_FAILED

Falha ao enviar o comando de controle em tempo real

10020601

INSTRUCT_REQUEST_FAILED

Falha ao enviar a instrução de Direção

10020701

END_REQUEST_FAILED

Falha na solicitação de encerramento da sessão

Outras Exportações

Exportações de runtime

Exportação

Tipo

Descrição

HappyOysterEngine

class

Cliente SDK que configura a Open Platform, atualiza o token e cria sessões Travel.

HappyOysterEngine.version

string

A versão atual do SDK.

HappyOysterEngine.metadata

SDKMetadata

O nome do pacote SDK atual, versão e canal do pacote.

ErrorCode

const

O objeto constante de códigos de erro exportado pelo SDK.

isSdkError

function

Verifica se um erro desconhecido é um erro padrão do SDK.

ErrorCode

O objeto constante de códigos de erro exportado pelo SDK. Compare-o com SdkError.code em vez de espalhar literais numéricos pelo código da aplicação.
import { ErrorCode } from '@happy-oyster/js-sdk'

isSdkError

Verifica se um erro desconhecido é um erro padrão do SDK. Quando retorna true, o TypeScript restringe o erro a SdkError, permitindo acesso seguro a code e message.
isSdkError(error: unknown): error is SdkError
try {
  await travel.start()
} catch (err) {
  if (isSdkError(err) && err.code === ErrorCode.OPEN_PLATFORM_TICKET_INVALID) {
    // Request a new Travel ticket, then create a new Travel.
  }
}

Tipos Públicos

Os seguintes tipos são exportados do ponto de entrada do pacote e podem ser importados diretamente de @happy-oyster/js-sdk. Eles existem apenas no tempo de compilação do TypeScript e não produzem código de tempo de execução.

Tipo

Descrição

SDKConfig

Tipo de parâmetro do construtor HappyOysterEngine.

LogLevel

Níveis de log do SDK: verbose / debug / info / warn / error / none.

SDKMetadata

Metadados do pacote SDK: version, packageName, packageChannel.

SDKPackageChannel

Canais de pacote SDK: internal / public / unknown.

CreateTravelConfig

Tipo de parâmetro de createTravel(config).

StartTravelResult

Metadados da sessão start() retornados quando a Promise é resolvida.

TravelInfo

Metadados da sessão usados por travelInfoReady, getInfo() e StartTravelResult.

TravelAspectRatio

Proporção de aspecto da Atuação: "9:16" / "16:9".

Travel

Contrato de sessão pública createTravel() retornado pelo método.

TravelStatus

Estados locais da sessão SDK: idle / prepare / running / paused / completed.

TravelAction

Nomes de ação suportados por can(action).

AdventureCommand

Tipo de parâmetro de sendCommand(params).

InstructData

Tipo de parâmetro de sendInstruct(params).

RewindTravelParams

Tipo de parâmetro de rewind(params).

RewindTravelResult

Dados de rewind(params) retornados quando a Promise é resolvida.

SDKError

Estrutura de erro do SDK contendo code e message.

SdkError

Tipo de erro combinando Error de tempo de execução e SDKError.

ErrorCodeValue

União de todos os valores de código de erro no objeto ErrorCode.