Votre serveur prépare les mondes et exporte les artefacts via les Open API HappyOyster ; le SDK client gère la connexion RTC et l'interaction en temps réel.
HappyOyster suit une architecture serveur + client : votre serveur gère les mondes et les artefacts via les Open API, et le SDK client fournit l'expérience en temps réel. Avant de commencer, complétez Obtenir les identifiants d'authentification.
Le SDK gère la connexion RTC, la lecture vidéo et les commandes d'interaction.
Après la fin du voyage, interrogez avec la clé API principale sur Aventure-Interroger les artefacts de voyage / Réalisation-Interroger les artefacts de voyage / Jeu d'acteur-Interroger les artefacts de voyage jusqu'à
- Les Open API côté serveur sont divisées par mode d'expérience en Aventure, Réalisation et Jeu d'acteur. Choisissez les points de terminaison correspondant à votre mode.
- Un Monde et un Voyage sont strictement liés au modèle qui les a créés ; l'accès inter-modèles renvoie
403001(monde) ou404000(voyage). - Le SDK n'est pas responsable de la création ou de la gestion des mondes ; il fournit uniquement l'expérience en temps réel côté client.
1. Préparer un monde (Open API serveur)
- Créer un monde, en utilisant le point de terminaison correspondant à votre mode : Aventure-Créer un monde / Réalisation-Créer un monde / Jeu d'acteur-Créer un monde.
- Interroger l'état de construction (toutes les 3–5 secondes) jusqu'à
ready: Avenue-Interroger l'état de construction du monde / Réalisation-Interroger l'état de construction du monde / Jeu d'acteur-Interroger l'état de construction du monde. - Échanger contre un ticket : Avec la clé API principale, appelez Aventure-Obtenir l'identifiant de voyage / Réalisation-Obtenir l'identifiant de voyage / Jeu d'acteur-Obtenir l'identifiant de voyage pour obtenir un
ticketà usage unique. - Fournir les identifiants au client : Envoyez le
ticketainsi que la clé API temporaire (utilisée commetokendu SDK) au client.
2. Expérience en temps réel (SDK client)
Le SDK gère la connexion RTC, la lecture vidéo et les commandes d'interaction.
-
Initialiser le SDK :
initialize+updateToken— injectez l'hôte API et la clé API temporaire. -
Démarrer la session :
startTravel(ticket); le SDK entre dans la salle et établit la connexion automatiquement. -
Attacher la vidéo : Ajoutez la vue renvoyée par
attachVideo()à votre mise en page. Pour le mode Jeu d'acteur, définissez l'orientation du conteneur selon leaspectRatiorenvoyé lors de l'entrée dans la salle. -
Interaction temps réel :
- Aventure : Appelez
sendCommandpour envoyer des commandes de direction / caméra / action. - Réalisation : Appelez
sendInstructpour envoyer des instructions textuelles qui font avancer l'histoire. - Jeu d'acteur : Appelez
sendInstructpour envoyer des instructions textuelles.
- Aventure : Appelez
-
Contrôle de session :
- Aventure : La pause et le rembobinage ne sont pas pris en charge.
- Réalisation : Prend en charge
pause,rewindetresume. - Jeu d'acteur : Prend en charge
pauseetresume;rewindn'est pas pris en charge.
-
Terminer la session :
endTravellibère le RTC et les ressources.
3. Récupérer les artefacts (Open API serveur)
Après la fin du voyage, interrogez avec la clé API principale sur Aventure-Interroger les artefacts de voyage / Réalisation-Interroger les artefacts de voyage / Jeu d'acteur-Interroger les artefacts de voyage jusqu'à composeStatus = ready. Pour une diffusion externe, nous recommandons video.withInstructionAndWatermark (composé avec instructions et filigrane).
Étapes suivantes
- Télécharger les SDK et les démos : packages SDK, guides d'intégration, références API et démos open source pour chaque plateforme.