Interroger le cycle de vie du Travel Acting, le statut du streaming côté serveur, les instructions textuelles envoyées et les informations de chapitre ; vous pouvez également signaler simultanément le heartbeat de pull-stream ou de lecture du client.
Scope
Interroger le cycle de vie du Travel Acting, le statut de streaming côté serveur, les instructions textuelles envoyées et les informations de chapitre ; vous pouvez également signaler le signal de présence de pull-stream ou de lecture du client en même temps. Avant d'effectuer l'appel, 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-acting/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 Travel chiffré Acting. Renvoyé par Enter Travel. | |
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 pas de données. Chaque élément contient instruction (texte de l'instruction), relativeStartTimeMs / relativeEndTimeMs (millisecondes relatives), startTime / endTime (secondes de la chronologie) et status (statut d'exécution).chapters arrayLa liste des chapitres ; null lorsque la détection de chapitres n'a pas été déclenchée. Chaque élément contient chapterId, title, brief, actRange, startTime, endTime et chapterImage.characterActions array<string> | nullActing ne prend pas en charge le contrôle d'action SDK ; renvoie un tableau vide ; null lorsque failed.environmentActions array<string> | nullActing ne prend pas en charge le contrôle d'action d'environnement SDK ; renvoie un tableau vide ; null lorsque failed.errorCode stringRenvoyé uniquement lorsque status=failed ; un code de raison d'échec structuré. Voir Error codes pour les valeurs.errorMessage stringRenvoyé avec errorCode ; une description de l'échec en anglais. Effectuez une branche sur errorCode, et non sur errorMessage. |
États préalables et notes d'appel
- Une interrogation toutes les 2–5 secondes est recommandée.
runningetpausedpermettent tous deux d'appeler Send Process Instruction ; l'envoi d'une instruction dans l'étatpausedne reprend pas automatiquement le Travel.- Ce point de terminaison ne retourne pas
mode,aspectRatio,playUrl,bgmUrl, nisessionId; la configuration du streaming et l'orientation du lecteur sont basées 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.- Acting ne prend pas en charge le
sendCommandSDK ; ne créez pas de contrôles de direction ou d'action basés sur les deux tableaux d'actions vides. failedest un état terminal et aucune vidéo ne sera produite ; affichez la raison de l'échec basée surerrorCode, et ne l'affichez pas comme « pas encore terminé ».
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 :
- Send Process Instruction : piloter la performance ultérieure du personnage.
- Pause Travel / Resume Travel.
- End Travel : interroger les artefacts après la fin.