Acting Travelのライフサイクル、サーバー側のストリーミングステータス、送信されたテキスト指示、およびチャプター情報をクエリします。同時にクライアントのプルストリームまたは再生ハートビートを報告することもできます。
スコープ
Acting Travelのライフサイクル、サーバー側のストリーミングステータス、送信済みのテキスト指示、およびチャプター情報をクエリします。同時にクライアントのプルストリームまたは再生ハートビートを報告することもできます。呼び出す前に、以下を確認してください。
- 認証：プライマリ API キーは必須ではありません。プライマリまたは一時 API キーのいずれかで呼び出せます。取得方法については、認証情報の取得 を参照してください。
- 前提条件：Enter Travel によって返された
encryptedTravelIdを使用してクエリします。 - 呼び出し元：サーバーまたはクライアントのいずれからも呼び出すことができます。2〜5秒ごとにポーリングすることをお勧めします。
HTTP リクエスト
- Singapore
- 米国（バージニア）
GET https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/api/v2/apps/happyoyster-1.0-acting/openapi/v1/travels/status{WorkspaceId} を実際の ワークスペースID に置き換えます。リクエストパラメーター |
|
Authorization string （必須）API キー認証です。プライマリ API キーは必須ではなく、プライマリまたは一時 API キーのいずれかで呼び出せます。
| |
クエリパラメータ | |
encryptedTravelId string （必須）Acting暗号化Travel IDです。Enter Travelによって返されます。 | |
clientStreamStatus string （任意）クライアントのRTCプルストリームまたは再生ステータスです。大文字小文字は区別されません。認識できない値は無視されます。許可される値は以下の通りです。
| |
clientStreamStatusTimeMs long （任意）クライアントの状態変更のミリ秒タイムスタンプです。clientStreamStatusと一緒に使用します。 |
レスポンスパラメーター |
|
code integerリターンコード。0 は成功を意味し、ゼロ以外の値はエラーコードです。 | |
message stringエラーメッセージ。成功時は null です。 | |
data objectレスポンスデータ。失敗時は null です。
プロパティ encryptedTravelId string暗号化されたTravel ID。status stringTravelライフサイクルステータス：
stringサーバー側のRTCストリーミングステータスです。クライアントが報告するclientStreamStatusとは異なります。updateTime string最終更新時刻です。ISO 8601形式です。userInstructions arrayテキスト指示のリストです。データがない場合はnullとなります。各項目には、instruction（指示テキスト）、relativeStartTimeMs / relativeEndTimeMs（相対ミリ秒）、startTime / endTime（タイムライン秒数）、およびstatus（実行ステータス）が含まれます。chapters arrayチャプターリストです。チャプター検出がトリガーされていない場合はnullです。各アイテムにはchapterId、title、brief、actRange、startTime、endTime、chapterImageが含まれます。characterActions array<string> | nullActing は SDK アクション制御をサポートしていません。空の配列を返します。failed の場合は null となります。environmentActions array<string> | nullActing は SDK 環境アクション制御をサポートしていません。空の配列を返します。failed の場合は null となります。errorCode stringstatus=failedの場合にのみ返される構造化された失敗理由コードです。値についてはエラーコードを参照してください。errorMessage stringerrorCode と一緒に返される英語の失敗説明です。errorMessage ではなく errorCode に基づいて分岐してください。 |
前提条件となるステータスと呼び出しに関する注意事項
- 2〜5秒ごとのポーリングを推奨します。
runningとpausedの両方でSend Process Instructionの呼び出しが可能です。paused状態で指示を送信しても、Travelは自動的には再開されません。- このエンドポイントは
mode、aspectRatio、playUrl、bgmUrl、またはsessionIdを返しません。ストリーミング設定とプレーヤーの向きは、Enter Travelのレスポンスに基づきます。 clientStreamStatusはクライアント側の再生ハートビートであり、rtcStatusはサーバー側のストリーミングステータスです。これらは互換性がありません。- Acting は SDK の
sendCommandをサポートしていません。2つの空のアクション配列に基づいて演出やアクション制御を構築しないでください。 failedは終端状態であり、動画は生成されません。errorCodeに基づいて失敗理由を表示し、「未完了」として表示しないでください。
エラーコード
モデルの呼び出しに失敗してエラーが返された場合は、HappyOyster エラーコードを参照して解決してください。
次のステップ
Travelがrunningまたはpausedの場合：
- Send Process Instruction：後続のキャラクターパフォーマンスを駆動します。
- Pause Travel／Resume Travel。
- End Travel：終了後にアーティファクトをクエリします。