Skip to main content

Référence de l'API HappyOyster Web SDK

HappyOysterEngine configure l'hôte et le modèle Open Platform, met à jour le jeton de clé API temporaire Model Studio et crée des sessions Travel. Travel est l'objet de session retourné par createTravel() ; la session est rejointe et démarrée uniquement après l'appel de travel.start(). Prend en charge les modes aventure, réalisation et jeu d'acteur.

HappyOysterEngine configure l'hôte Open Platform, met à jour le jeton de clé API temporaire Model Studio et crée des sessions Travel. Travel est l'objet de session retourné par createTravel(). La session est rejointe et démarrée uniquement après l'appel de travel.start().

Terminologie de base

Terme

Signification

Remarques

token

Jeton de clé API temporaire Model Studio : lors de l'appel aux services Model Studio depuis des environnements non approuvés tels que des navigateurs ou des applications mobiles, générez une clé API temporaire via un backend sécurisé pour éviter d'exposer une clé API permanente. Le SDK envoie ce jeton à Open Platform en tant qu'identifiant HTTP Bearer.

Obtenir les identifiants d'authentification

ticket

Identifiant de session Travel du monde HappyOyster : votre backend appelle l'API d'identification en utilisant l'authentification AK (en-tête de passerelle) pour obtenir un identifiant de session Travel à courte durée de vie (ticket) que le client utilise pour entrer dans une salle. L'API vérifie la propriété du monde mais ne crée pas d'enregistrement Travel réel.

Obtenir les identifiants d'authentification

Vue d'ensemble

Le SDK fournit les objets principaux suivants :

HappyOysterEngine

API

Description

new HappyOysterEngine(config)

Crée une instance Engine.

updateToken(token)

Met à jour le token de clé API temporaire Model Studio utilisé par les requêtes API Open Platform suivantes.

createTravel(config)

Crée une session Travel.

HappyOysterEngine.version

La version actuelle du SDK.

HappyOysterEngine.metadata

Le nom du package SDK actuel, sa version et son canal de distribution.

Voyage

API

Description

start()

Démarre la session Travel actuelle.

on("statusChanged", handler)

S'abonne aux changements de statut de session.

on("firstFrameGenerated", handler)

S'abonne aux notifications d'URL de première image.

on("travelInfoReady", handler)

S'abonne aux métadonnées de session disponibles immédiatement après l'entrée dans le travel.

onError(handler)

S'abonne aux erreurs d'exécution de session.

can(action)

Vérifie si l'action spécifiée peut actuellement être appelée.

getInfo()

Obtient les métadonnées de session disponibles ; retourne null avant qu'elles ne soient disponibles.

sendCommand(params)

Envoie une commande de contrôle en temps réel.

sendInstruct(params)

Envoie des instructions Directing ou du contenu de prompt.

pause()

Met en pause la session actuelle.

resume()

Reprend une session en pause.

rewind(params)

Rembobine une session Directing au moment spécifié.

end()

Termine la session actuelle et libère ses ressources.

Autres exports

Export

Description

ErrorCode

L'objet constant de codes d'erreur exporté par le SDK.

isSdkError(error)

Vérifie si une erreur inconnue est une erreur standard du SDK.

Types

Types publics tels que SDKConfig, Travel, StartTravelResult et AdventureCommand.

Exemple

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 est le point d'entrée du SDK Web. Il configure l'hôte Open Platform, gère le jeton de clé API temporaire Model Studio utilisé par les requêtes suivantes et crée des sessions Travel.
Une instance Engine ne gère actuellement qu'un seul Travel actif à la fois. Terminez le Travel actuel avant de démarrer une nouvelle session.Une fois qu'un jeton est défini soit dans le constructeur, soit via updateToken(), le SDK récupère en interne la configuration Feature Gate. Cela permet à la plateforme de désactiver le SDK à distance ou d'exiger que les anciennes versions effectuent une mise à niveau. Si la requête échoue, le SDK adopte un comportement permissif et ne bloque pas l'expérience normale.

API

Description

new HappyOysterEngine(config)

Crée une instance Engine avec l'hôte API et le modèle requis, ainsi qu'un jeton et un niveau de journalisation facultatifs.

updateToken(token)

Met à jour le token de clé API temporaire Model Studio utilisé par les requêtes Open Platform suivantes.

createTravel(config)

Crée une session Travel qui n'a pas encore démarré.

new HappyOysterEngine

Crée une instance HappyOysterEngine.

Signature

new HappyOysterEngine(config: SDKConfig)

Paramètres

SDKConfig

Champ

Type

Obligatoire

Description

APIHost

string

Oui

Hôte API Open Platform. Il doit s'agir d'un hôte nu, tel que open-platform.example.com, sans https://, sans schéma ni chemin.

model

string

Oui

Identifiant du modèle Open Platform à utiliser. Obligatoire, sans valeur par défaut. Fixe pour ce Engine et partagé par tous ses Travels.

token

string

Non

Jeton de clé API temporaire Model Studio défini lors de la construction. Il peut également être défini ultérieurement avec updateToken().

logLevel

LogLevel

Non

Niveau de journalisation du SDK. La valeur par défaut est none.

streamReadyTimeout

number

Non

Délai d'attente pour que <video> devienne lisible, s'arrête ou reprenne, en millisecondes. La valeur par défaut est 15000.

Définissez model sur un identifiant de modèle, tel que happyoyster-1.0-adventure, un modèle Adventure. Utilisez l'identifiant de modèle correspondant à votre environnement de service cible. Le SDK ne choisit pas un modèle à partir du mode d'expérience et ne le déduit pas du ticket. Un Engine a une combinaison APIHost + model fixe. Réutilisez-le pour des Travels successifs ciblant le même service et le même modèle. Avant de changer l'une ou l'autre valeur, terminez le Travel actif et utilisez un Engine configuré pour la nouvelle cible. Créez le monde et émettez son ticket par rapport à la même cible de service.

Retourne

Retourne une instance HappyOysterEngine.

Erreurs

Si config est manquant, ou si APIHost, model, token, logLevel ou streamReadyTimeout a un type ou une valeur invalide, une SdkError avec le code ErrorCode.INVALID_ARGUMENT (10010001) est levée de manière synchrone. Passer une URL complète, une chaîne vide ou une valeur avec un chemin comme APIHost est invalide. model est obligatoire et doit être une chaîne non vide après suppression des espaces ; null, les valeurs non chaînes et les chaînes contenant uniquement des espaces sont invalides. L'omettre ou passer undefined déclenche également une erreur d'argument ; le SDK n'a pas de modèle par défaut.

HappyOysterEngine.updateToken

Met à jour le token de clé API temporaire Model Studio utilisé par les requêtes API Open Platform suivantes.

Signature

updateToken(token: string): void

Paramètres

Champ

Type

Obligatoire

Description

token

string

Oui

Token de clé API temporaire Model Studio. Passer une chaîne vide efface le token actuel.

Retourne

Ne retourne rien.

Erreurs

Si token n'est pas une chaîne, une SdkError avec le code ErrorCode.INVALID_ARGUMENT (10010001) est levée de manière synchrone.

HappyOysterEngine.createTravel

Crée une instance de session Travel sans la démarrer.

Signature

createTravel(config: CreateTravelConfig): Travel

Paramètres

CreateTravelConfig

Champ

Type

Obligatoire

Description

ticket

string

Oui

Ticket utilisé pour démarrer le Travel ultérieurement.

videoElement

HTMLVideoElement

Oui

L'élément <video> utilisé pour rendre la vidéo de la session. Il doit être fourni lors de la création du Travel.

maxExperienceTimeSec

60 | 90 | 120

Non

Durée maximale de l'expérience Aventure, en secondes. Les sessions Réalisation et Jeu d'acteur ignorent ce champ. En cas d'omission, le serveur applique sa valeur par défaut.

Retourne

Retourne une session Travel créée mais pas encore démarrée. L'appelant doit ensuite exécuter await travel.start() pour entrer dans la session et attendre que la vidéo devienne lisible. Chaque instance HappyOysterEngine ne peut avoir qu'un seul Travel actif à la fois. Appelez await travel.end() avant de créer un autre Travel.

Erreurs

createTravel() déclenche une SdkError de manière synchrone dans les cas suivants :

ErrorCode

Description

10010001

config, ticket, videoElement ou maxExperienceTimeSec est invalide

10010101

Un Travel est déjà actif ; appelez d'abord travel.end()

Les erreurs de démarrage sont exposées par travel.start().

Travel

Travel représente une session créée par HappyOysterEngine.createTravel(). Elle est initialement inactive. Après l'appel de travel.start(), le SDK entre dans la session et attend que la vidéo devienne lisible. Travel prend en charge le démarrage, la mise en pause, la reprise, le rembobinage et la fin d'une session ; l'envoi de contrôles et d'invites en temps réel ; ainsi que l'abonnement aux changements d'état et aux erreurs d'exécution.

Méthodes

Méthode

Description

start()

Démarre la session Travel actuelle.

on("statusChanged", handler)

S'abonne aux changements de statut de session.

on("firstFrameGenerated", handler)

S'abonne aux notifications d'URL de première image.

on("travelInfoReady", handler)

S'abonne aux métadonnées de session disponibles immédiatement après l'entrée dans le travel.

onError(handler)

S'abonne aux erreurs d'exécution de session.

can(action)

Vérifie si l'action spécifiée peut actuellement être appelée.

getInfo()

Obtient les métadonnées de session disponibles ; retourne null avant qu'elles ne soient disponibles.

sendCommand(params)

Envoie une commande de contrôle en temps réel.

sendInstruct(params)

Envoie des instructions Directing ou du contenu de prompt.

pause()

Met en pause la session actuelle.

resume()

Reprend une session en pause.

rewind(params)

Rembobine la session actuelle au moment spécifié.

end()

Termine la session actuelle et libère ses ressources.

Statut

Statut

Description

idle

La session n'a pas démarré.

prepare

La session démarre et attend que la vidéo devienne lisible.

running

La session est en cours d'exécution.

paused

La session est en pause et peut être reprise ou rembobinée.

completed

La session s'est terminée normalement et ses ressources ont été libérées.

Événements

Abonnez-vous aux événements avec travel.on(event, handler). La méthode retourne une fonction de désabonnement.

Événement

Callback

Description

statusChanged

(status: TravelStatus) => void

Le statut de la session a changé.

firstFrameGenerated

(firstFrame: string) => void

Émis pendant start() lorsque Open Platform retourne une URL de première image non vide ; avant que start() ne se résolve et que la vidéo ne devienne lisible.

travelInfoReady

(info: TravelInfo) => void

Émis après le retour de enter-travel et avant la connexion RTC. getInfo() retourne les mêmes données ; si une première image existe, firstFrameGenerated suit.

error

(error: unknown) => void

Une erreur d'exécution de session.

Travel.can

Vérifie si une action est disponible pour le statut actuel et la capacité de la session.

Signature

can(action: TravelAction): boolean

Paramètres

Champ

Type

Obligatoire

Description

action

TravelAction

Oui

Action à vérifier : start / sendCommand / sendInstruct / pause / resume / rewind / end.

Retourne

Retourne une boolean. true signifie que l'action est actuellement disponible ; false signifie que l'état, le mode ou la capacité de session actuel ne répond pas à ses préconditions.

Disponibilité

action

Disponibilité

start

Travel est toujours idle, n'a pas été fermé et n'a jamais été démarré.

sendCommand

running, avec le mode Travel défini sur Adventure (1).

sendInstruct

running ou paused, avec le mode défini sur Réalisation (2) ou Jeu d'acteur (3), et non scriptlist.

pause

running, et la session actuelle prend en charge la mise en pause.

resume

paused, et la session actuelle prend en charge la reprise.

rewind

paused dans une session Directing qui prend en charge le rembobinage ; Acting ne le prend pas en charge.

end

Le Travel n'a pas été fermé.

Erreurs

Cette méthode ne déclenche pas d'erreurs métier. Les actions inconnues retournent false.

Travel.start

Démarre la session Travel actuelle.

Signature

start(): Promise<StartTravelResult>

Paramètres

Aucun paramètre.

Retourne

Retourne une Promise<StartTravelResult>, qui se résout après le démarrage de la session et lorsque la vidéo devient lisible. Après le retour de enter-travel, le SDK émet travelInfoReady avant de connecter le RTC. Les abonnés tardifs peuvent appeler travel.getInfo() ; cela retourne null avant que les métadonnées ne soient disponibles. Si la réponse inclut une firstFrame non vide, firstFrameGenerated suit tout de même.

StartTravelResult

Champ

Type

Description

encryptedTravelId

string

ID de la session Travel actuelle.

mode

number

Mode de session : 1 = Aventure (exploration du monde), 2 = Réalisation (réalisation en temps réel), 3 = Jeu d'acteur.

creationModel

string

Modèle de création de monde ; les valeurs courantes sont simple et scriptlist.

firstFrame

string | null

URL de l'image de la première image ; null si le serveur n'en retourne pas.

maxExperienceTimeSec

60 | 90 | 120 | null

Durée maximale de l'expérience Aventure, en secondes. null pour les sessions Réalisation et Jeu d'acteur ou lorsque le serveur ne retourne pas ce champ.

aspectRatio

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

Format d'image Acting ; null pour les autres modes ou lorsque le serveur ne le retourne pas.

Erreurs

start() est rejeté et émet un événement error dans les cas suivants. Utilisez isSdkError(err) pour vérifier l'erreur et lire err.code et err.message.

ErrorCode

Description

10010002

La fonctionnalité SDK est désactivée (SDK_FEATURE_DISABLED)

10020101

Impossible de démarrer : l'état actuel ne le permet pas, Open Platform n'est pas configuré ou l'entrée dans la session a échoué

10020102

Impossible de démarrer : la configuration de session retournée par le serveur est incomplète

10020103

Impossible de démarrer : échec de la connexion au flux vidéo ou échec de la requête de flag de fonctionnalité SDK

10020104

Impossible de démarrer : délai d'attente dépassé pour le flux vidéo (utilise la plus grande valeur entre streamReadyTimeout et le noStreamAutoEndTimeoutSec du serveur)

10020105

Impossible de démarrer : délai d'attente dépassé pour que la vidéo devienne lisible (contrôlé par streamReadyTimeout ; par défaut : 15 secondes)

10000001–10000012

Erreur de paramètre, de ressource ou de serveur Open Platform

Travel.on("statusChanged")

S'abonne aux changements de statut de session.

Signature

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

Paramètres

Champ

Type

Obligatoire

Description

handler

(status: TravelStatus) => void

Oui

Callback invoqué lorsque le statut change.

Retourne

Retourne une fonction de désabonnement. TravelStatus est l'une des valeurs suivantes : idle / prepare / running / paused / completed.

Erreurs

Cette méthode ne déclenche pas d'erreurs métier.

Travel.on("firstFrameGenerated")

S'abonne aux notifications d'URL de première image.

Signature

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

Paramètres

Champ

Type

Obligatoire

Description

handler

(firstFrame: string) => void

Oui

Callback invoqué lorsque l'URL de la première image est disponible.

Retourne

Retourne une fonction de désabonnement.

Comportement

Émis uniquement pendant travel.start(). Après que le SDK a appelé enter-travel d'Open Platform et reçu une firstFrame non vide, il émet l'événement immédiatement — généralement après statusChanged("prepare") mais avant que start() ne se résolve et que la vidéo ne devienne lisible. L'événement n'est pas émis si la réponse ne contient aucune URL de première image.

Erreurs

Cette méthode ne déclenche pas d'erreurs métier.

Travel.onError

S'abonne aux erreurs d'exécution de session.

Signature

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

Paramètres

Champ

Type

Obligatoire

Description

handler

(error: unknown) => void

Oui

Callback invoqué lorsqu'une erreur d'exécution se produit.

Retourne

Retourne une fonction de désabonnement. Utilisez isSdkError pour restreindre l'objet d'erreur à SdkError.

Erreurs

Cette méthode ne déclenche pas d'erreurs métier.

Travel.sendCommand

Envoie une commande de contrôle en temps réel.

Signature

sendCommand(params: AdventureCommand): Promise<void>

Paramètres

AdventureCommand

Champ

Type

Obligatoire

Description

translation

string

Non

Direction du mouvement. La valeur par défaut est None en cas d'omission.

rotation

string

Non

Rotation de la vue. La valeur par défaut est None en cas d'omission.

interaction

string

Non

Action d'interaction. La valeur par défaut est None en cas d'omission.

Référence des commandes de contrôle

translation — Direction du mouvement
Décrit le mouvement du personnage, prenant en charge huit directions et leurs combinaisons.

Valeur

Direction

"Front"

Avant

"Back"

Arrière

"Left"

Gauche

"Right"

Droite

"Front_Left"

Avant-gauche

"Front_Right"

Avant-droite

"Back_Left"

Arrière-gauche

"Back_Right"

Arrière-droite

"None"

Immobile

rotation — Rotation de la vue
Simule une rotation de vue basée sur la souris dans huit directions.

Valeur

Direction

"Mouse_Up"

Haut

"Mouse_Down"

Bas

"Mouse_Left"

Gauche

"Mouse_Right"

Droite

"Mouse_Up_Left"

Haut-gauche

"Mouse_Up_Right"

Haut-droite

"Mouse_Down_Left"

Bas-gauche

"Mouse_Down_Right"

Bas-droite

"None"

None

interaction — Action d'interaction

Valeur

Action

"Jump"

Saut

"Attack"

Attaque

"Crouch"

Accroupi

"Sprint"

Sprint

"None"

None

Retourne

Retourne un Promise<void> qui se résout après la soumission de la commande.

Erreurs

sendCommand() est rejeté dans les cas suivants :

ErrorCode

Description

10010001

params ou un paramètre de mouvement, de rotation ou d'interaction est invalide

10020501

Le statut actuel ou le mode de session n'autorise pas les commandes, ou la commande de flux vidéo a échoué

Travel.sendInstruct

Envoie des instructions Directing ou du contenu de prompt.

Signature

sendInstruct(params: InstructData): Promise<void>

Paramètres

InstructData

Champ

Type

Obligatoire

Description

content

string

Oui

Contenu du prompt à envoyer.

Retourne

Retourne une Promise<void> qui se résout après que Open Platform a reçu et traité l'instruction.

Erreurs

sendInstruct() est rejeté et émet un événement error dans les cas suivants :

ErrorCode

Description

10020101

La session n'a pas démarré

10020601

Échec de l'envoi de l'instruction Directing

10000001–10000012

Erreur de paramètre, de ressource ou de serveur Open Platform

Travel.pause

Met en pause la session actuelle.

Signature

pause(): Promise<void>

Paramètres

Aucun paramètre.

Retourne

Retourne un Promise<void> qui se résout après l'arrêt de la lecture vidéo.

Erreurs

pause() est rejeté dans les cas suivants :

ErrorCode

Description

10020201

L'état actuel, le mode de session ou la capacité de session ne permet pas la mise en pause, ou la demande de mise en pause a échoué

10020202

Délai d'attente dépassé pour que le backend signale le flux vidéo comme étant en pause (15 secondes)

10000001–10000012

Erreur de paramètre, de ressource ou de serveur Open Platform

Travel.resume

Reprend une session en pause.

Signature

resume(): Promise<void>

Paramètres

Aucun paramètre.

Retourne

Retourne un Promise<void> qui se résout après que la vidéo redevient lisible.

Erreurs

resume() est rejeté dans les cas suivants :

ErrorCode

Description

10020301

L'état actuel, le mode de session ou la capacité de session ne permet pas la reprise, ou la demande de reprise a échoué

10020302

Délai d'attente dépassé pour que la vidéo redevienne lisible (15 secondes)

10000001–10000012

Erreur de paramètre, de ressource ou de serveur Open Platform

Travel.rewind

Rembobine la session actuelle au moment spécifié.

Signature

rewind(params: RewindTravelParams): Promise<RewindTravelResult>

Paramètres

RewindTravelParams

Champ

Type

Obligatoire

Description

rewindToSec

number

Oui

Temps cible en secondes. Seuls les multiples de 4 sont pris en charge (par exemple, 4, 8 ou 12). Le serveur arrondit les autres valeurs à l'entier inférieur (par exemple, 7 devient 4).

Retourne

Retourne une Promise<RewindTravelResult> qui se résout une fois le rembobinage terminé et la lecture reprise.

RewindTravelResult

Champ

Type

Description

resumedAtSec

number

Le temps réel en secondes auquel le serveur a repris la lecture.

Erreurs

rewind() est rejeté et émet un événement error dans les cas suivants :

ErrorCode

Description

10020101

La session n'a pas démarré

10020401

Impossible de rembobiner : la session doit d'abord être mise en pause et la lecture vidéo arrêtée, ou la demande de rembobinage ou la reconnexion RTC a échoué

10020402

Délai d'attente dépassé pour la reprise de la vidéo après rembobinage (15 secondes)

10000001–10000012

Erreur de paramètre, de ressource ou de serveur Open Platform

Travel.end

Termine la session actuelle et libère ses ressources.

Signature

end(): Promise<void>

Paramètres

Aucun paramètre.

Retourne

Retourne un Promise<void> qui se résout après la fin du nettoyage.

Erreurs

Les erreurs de nettoyage ne sont pas déclenchées vers l'appelant ; end() fait de son mieux pour libérer les ressources.

Gestion des erreurs

Le SDK expose les erreurs d'exécution via des rejets de Promise ou des événements error. Les erreurs sont des objets SdkError ; utilisez isSdkError(err) et lisez err.code et err.message. Les erreurs Open Platform reconnues correspondent à la plage 10000001–10000012, et err.message contient le message de la plateforme. Consultez la section Erreurs de chaque API Travel pour les codes spécifiques aux méthodes.

Référence des ErrorCode

Plages de codes d'erreur :
  • 100000xx : Erreurs Open Platform mappées
  • 1001xxxx : Erreurs client Engine
  • 1002xxxx : Erreurs client Travel

code

name

Description

10000001

OPEN_PLATFORM_PARAM_INVALID

Paramètres de requête invalides (retournés par Open Platform)

10000002

OPEN_PLATFORM_RESOURCE_NOT_FOUND

Ressource introuvable (Travel manquant, non possédé, dans un autre espace de travail ou artefact non prêt)

10000003

OPEN_PLATFORM_WORLD_NOT_OWNED

Le monde n'existe pas, a été supprimé ou n'appartient pas au développeur actuel

10000004

OPEN_PLATFORM_SYSTEM_ERROR

Erreur système

10000005

OPEN_PLATFORM_TICKET_INVALID

Le ticket est invalide ou expiré

10000006

OPEN_PLATFORM_TICKET_USED

Le ticket a déjà été utilisé (identifiant à usage unique)

10000007

OPEN_PLATFORM_WORLD_NOT_READY

Le monde n'est pas prêt et ne peut pas être rejoint

10000008

OPEN_PLATFORM_INFERENCE_ALLOCATE_FAILED

Échec de l'allocation des ressources d'inférence (capacité insuffisante, échec de création de flux, échec d'initialisation de session, etc.)

10000009

OPEN_PLATFORM_MAIN_API_KEY_REQUIRED

Cette API accepte uniquement la clé API principale (les clés API temporaires ne sont pas prises en charge)

10000010

OPEN_PLATFORM_CONTENT_MODERATION

Entrée rejetée par la modération de contenu

10000011

OPEN_PLATFORM_CONTENT_COPYRIGHT

L'image d'entrée viole la politique de droit d'auteur ou de propriété intellectuelle

10000012

OPEN_PLATFORM_STATE_CONFLICT

La requête est en conflit avec l'état actuel de la ressource

10010001

INVALID_ARGUMENT

Échec de la validation des arguments du client SDK (non mappé depuis Open Platform)

10010002

SDK_FEATURE_DISABLED

La fonctionnalité SDK est désactivée

10010101

ACTIVE_TRAVEL_EXISTS

Un Travel est déjà actif

10020001

STREAM_DISCONNECTED_WHILE_PLAYING

Flux vidéo déconnecté pendant la lecture

10020101

START_REQUEST_FAILED

Échec de la demande de démarrage de session

10020102

START_RTC_CONFIG_MISSING

Configuration du flux vidéo manquante lors du démarrage

10020103

START_JOIN_CHANNEL_FAILED

Échec de la connexion au flux vidéo

10020104

START_REMOTE_USER_TIMEOUT

Délai d'attente dépassé pour le flux vidéo

10020105

START_STREAM_TIMEOUT

Délai d'attente dépassé pour que la vidéo devienne lisible

10020201

PAUSE_REQUEST_FAILED

Échec de la demande de pause

10020202

PAUSE_STREAM_TIMEOUT

Délai d'attente dépassé pour la mise en pause de la vidéo

10020301

RESUME_REQUEST_FAILED

Échec de la demande de reprise

10020302

RESUME_STREAM_TIMEOUT

Délai d'attente dépassé pour la reprise de la vidéo

10020401

REWIND_REQUEST_FAILED

Échec de la demande de rembobinage

10020402

REWIND_STREAM_TIMEOUT

Délai d'attente dépassé pour la reprise de la vidéo après rembobinage

10020501

SEND_COMMAND_FAILED

Échec de l'envoi de la commande de contrôle en temps réel

10020601

INSTRUCT_REQUEST_FAILED

Échec de l'envoi de l'instruction Directing

10020701

END_REQUEST_FAILED

Échec de la demande de fin de session

Autres exports

Exports d'exécution

Export

Type

Description

HappyOysterEngine

class

Client SDK qui configure Open Platform, met à jour le token et crée des sessions Travel.

HappyOysterEngine.version

string

La version actuelle du SDK.

HappyOysterEngine.metadata

SDKMetadata

Le nom du package SDK actuel, sa version et son canal de distribution.

ErrorCode

const

L'objet constant de codes d'erreur exporté par le SDK.

isSdkError

function

Vérifie si une erreur inconnue est une erreur standard du SDK.

ErrorCode

L'objet constant de codes d'erreur exporté par le SDK. Comparez-le avec SdkError.code au lieu de disperser des littéraux numériques dans le code de l'application.
import { ErrorCode } from '@happy-oyster/js-sdk'

isSdkError

Vérifie si une erreur inconnue est une erreur SDK standard. Lorsqu'elle retourne true, TypeScript réduit l'erreur à SdkError, permettant un accès sécurisé à code et 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.
  }
}

Types publics

Les types suivants sont exportés depuis le point d'entrée du package et peuvent être importés directement depuis @happy-oyster/js-sdk. Ils n'existent qu'au moment de la compilation TypeScript et ne produisent aucun code d'exécution.

Type

Description

SDKConfig

Type de paramètre du constructeur HappyOysterEngine.

LogLevel

Niveaux de journalisation SDK : verbose / debug / info / warn / error / none.

SDKMetadata

Métadonnées du package SDK : version, packageName, packageChannel.

SDKPackageChannel

Canaux de package SDK : internal / public / unknown.

CreateTravelConfig

Type de paramètre de createTravel(config).

StartTravelResult

Métadonnées de session start() retournées lorsque la Promise se résout.

TravelInfo

Métadonnées de session utilisées par travelInfoReady, getInfo() et StartTravelResult.

TravelAspectRatio

Format d'image Acting : "9:16" / "16:9".

Travel

Contrat de session public createTravel() retourné par la méthode.

TravelStatus

États de session SDK locaux : idle / prepare / running / paused / completed.

TravelAction

Noms d'action pris en charge par can(action).

AdventureCommand

Type de paramètre de sendCommand(params).

InstructData

Type de paramètre de sendInstruct(params).

RewindTravelParams

Type de paramètre de rewind(params).

RewindTravelResult

Données rewind(params) retournées lorsque la Promise se résout.

SDKError

Structure d'erreur SDK contenant code et message.

SdkError

Type d'erreur combinant l'Error d'exécution et SDKError.

ErrorCodeValue

Union de toutes les valeurs de codes d'erreur dans l'objet ErrorCode.