クライアントは ticket を使用して実際の Travel を作成し、RTC 参加設定、Acting 機能バージョン、およびプレーヤーのアスペクト比を取得します。呼び出しが成功すると Travel が作成されます。
スコープ
クライアントは ticket を使用して実際の Travel を作成し、RTC 参加設定、Acting 機能バージョン、およびプレーヤーのアスペクト比を取得します。呼び出す前に、以下を確認してください：
- 認証：プライマリ API Key は必須ではありません。
ticketが入室検証を完了します。取得方法については、認証情報の取得 を参照してください。 - 前提条件：
ticketは Travel 資格情報の取得 から取得したものであり、未期限切れかつ未使用で、World のステータスがreadyである必要があります。 - 呼び出し元：クライアントから呼び出します。
HTTP リクエスト
- Singapore
- 米国（バージニア）
POST https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/api/v2/apps/happyoyster-1.0-acting/openapi/v1/travels/enter-travel{WorkspaceId} を実際の ワークスペースID に置き換えます。リクエストパラメーター |
|
Content-Typestring（必須）リクエストのコンテンツタイプ。このパラメータは application/json に設定する必要があります。 | |
Authorization string （必須）API キー認証です。プライマリ API キーは必須ではなく、プライマリまたは一時 API キーのいずれかで呼び出せます。
| |
リクエストボディ | |
ticket string （必須）Travel 資格情報の取得 から取得した、未期限切れかつ未使用の単発資格情報です。同じ ticket を再利用すると 401011 が返されます。 |
Acting は
maxExperienceTimeSec を消費しません。渡さないでください。無効なティアが渡された場合でも、モデルルーティングの前に 400000 が返されます。レスポンスパラメーター |
|
code integerリターンコード。0 は成功を意味し、ゼロ以外の値はエラーコードです。 | |
message stringエラーメッセージ。成功時は null です。 | |
data objectレスポンスデータ。失敗時は null です。
プロパティ encryptedTravelId string新しく作成された暗号化 Travel ID です。後続の Travel ステータスのクエリ、一時停止、再開、終了、およびアーティファクトクエリに使用されます。encryptedWorldId stringこの Travel に対応する暗号化 World ID です。mode integerActing では常に 3 です。creationModel stringActing では常に simple です。playUrl nullまだ利用できません。null に固定されています。firstFrame stringWorld の初回フレーム URL です。rtcConfig objectRTC 参加設定です。利用可能なストリーミングチャンネルがない場合は null となり、その場合クライアントはそれに基づいて再生を開始できません。
stringActing の入室バージョンで、actingV2 に固定されています。制御インターフェースはこのバージョンに従って呼び出す必要があります。aspectRatio stringアスペクト比です。クライアントはストリームのプル前に、これに応じてプレーヤーの向きを設定する必要があります：
integerストリームなし自動終了タイムアウト（秒単位）、デフォルトは 30 です。実際のレスポンスが優先されます。入室後この時間内に rtcStatus がストリーミング状態にならない場合、failCode=TRAVEL_NO_STREAM_AUTO_END を指定して End Travel を呼び出してください。maxExperienceTimeSec nullActing は最大体験時間を使用しません。null に固定されています。 |
前提条件となるステータスと呼び出しに関する注意事項
ticketに対応する World はreadyである必要があり、チケットは未期限切れかつ未使用である必要があります。- 呼び出しが成功すると Travel が作成されます。同じ
ticketを再利用すると401011が返されます。 - Acting 機能または仕様が有効になっていない場合、
403007が返され、Travel は作成されません。 versionはactingV2として扱う必要があります。別の機能バージョンに従って制御インターフェースを呼び出さないでください。- クライアントは、ストリームプルまたはレンダリングコンテナの確立前に
aspectRatioを読み取る必要があります。9:16の場合は縦向きコンテナを、16:9の場合は横向きコンテナを使用してください。 maxExperienceTimeSecを渡さないでください。Acting はこのフィールドによって自動終了せず、クライアントはこれを使用してカウントダウンを実装してはなりません。rtcConfig=nullは、現在利用可能なストリーミングチャンネルがないことを意味し、クライアントはそれに基づいて再生を開始できません。
エラーコード
モデルの呼び出しに失敗してエラーが返された場合は、HappyOyster エラーコードを参照して解決してください。
次のステップ
入室成功後：
- Travel ステータスのクエリ：2〜5 秒ごとにポーリングします。Travel が
runningまたはpausedのときに指示を送信できます。 - プロセス指示の送信：後続のロールプレイパフォーマンスを駆動します。
- Travel の一時停止 / Travel の再開：必要に応じて実行ペースを制御します。
- Travel の終了：終了時に
completedに入り、アーティファクト処理が開始されます。