Interroger le cycle de vie du Voyage Directing, le statut du streaming côté serveur, les instructions textuelles exécutées et les informations sur les chapitres ; vous pouvez également signaler le heartbeat de pull-stream ou de lecture du client en même temps.
Scope
Interroger le cycle de vie du Voyage Directing, le statut du streaming côté serveur, les instructions textuelles exécutées et les informations sur les chapitres ; vous pouvez également signaler le heartbeat de pull-stream ou de lecture du client en même temps. Avant d'appeler, confirmez les points suivants :
- Authentification : La clé API principale n'est pas requise ; la clé principale ou une clé API temporaire peut l'appeler. Pour savoir comment les obtenir, voir Obtenir les identifiants d'authentification.
- Prérequis : Interrogez avec l'
encryptedTravelIdrenvoyé par Enter Travel. - Appelant : Votre serveur ou votre client peut l'appeler. Il est recommandé d'effectuer une interrogation toutes les 2 à 5 secondes.
Requête HTTP
- Singapore
- États-Unis (Virginie)
GET https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/api/v2/apps/happyoyster-1.0-directing/openapi/v1/travels/statusRemplacez {WorkspaceId} par votre véritable ID d'espace de travail.Paramètres de la requête |
|
Authorization string (Requis)Authentification par clé API. La clé API principale n'est pas requise ; la clé principale ou une clé API temporaire peut l'appeler.
| |
Paramètres de requête | |
encryptedTravelId string (Obligatoire)L'ID de Voyage chiffré Directing. Retourné par Entrer dans le voyage. | |
clientStreamStatus string (Facultatif)Le statut de pull-stream RTC ou de lecture du client, insensible à la casse. Les valeurs non reconnues sont ignorées. Valeurs autorisées :
| |
clientStreamStatusTimeMs long (Facultatif)L'horodatage en millisecondes du changement d'état du client. Utilisé conjointement avec clientStreamStatus. |
Paramètres de réponse |
|
code integerCode de retour. 0 indique un succès ; une valeur non nulle correspond à un code d'erreur. | |
message stringMessage d'erreur. null en cas de succès. | |
data objectDonnées de réponse. null en cas d'échec.
Propriétés encryptedTravelId stringIdentifiant de voyage chiffré.status stringStatut du cycle de vie du Travel :
stringStatut de streaming RTC côté serveur ; différent du clientStreamStatus signalé par le client.updateTime stringHeure de dernière mise à jour, au format ISO 8601.userInstructions arrayLa liste des instructions textuelles ; null lorsqu'il n'y a aucune donnée. Chaque élément contient instruction, relativeStartTimeMs / relativeEndTimeMs (millisecondes relatives), startTime / endTime (secondes de la chronologie) et status.chapters arrayLa liste des chapitres ; null lorsque la détection des chapitres n'a pas encore été déclenchée. Chaque élément contient chapterId, title, brief, actRange, startTime, endTime et chapterImage.characterActions arrayFixé à un tableau vide pour le modèle Directing.environmentActions arrayFixé à un tableau vide pour le modèle Directing. |
États préalables et notes d'appel
- Interroger toutes les 2 à 5 secondes.
- Dans l'état
running, vous pouvez appeler les points de terminaison de contrôle pris en charge seloncreationModel: le mode standard prend en chargeinstruct,pause,resume,rewindetend; le mode script prend en chargeupdate-script,pause,resume,rewindetend. - Ce point de terminaison ne retourne pas
mode,aspectRatio,playUrl,bgmUrl, nisessionId; la configuration du streaming est basée sur la réponse de Enter Travel. clientStreamStatusest le signal de présence de lecture côté client, etrtcStatusest le statut de streaming côté serveur ; ils ne sont pas interchangeables.
Codes d'erreur
Si l'appel du modèle échoue et renvoie une erreur, consultez Codes d'erreur HappyOyster pour la résoudre.
Étapes suivantes
Lorsque le Travel est running ou paused :
- Mode standard : Envoyer une instruction de processus.
- Mode script : Mise à jour complète du script.
- Commun : Pause / Reprise / Rembobinage / Fin.