Alibaba Cloud Model Studio:HappyOyster-Acting-Enter Travel API リファレンス

クライアントは ticket を使用して実際の Travel を作成し、RTC 参加設定、Acting 機能バージョン、およびプレーヤーのアスペクト比を取得します。呼び出しが成功すると Travel が作成されます。

スコープ

クライアントは ticket を使用して実際の Travel を作成し、RTC 参加設定、Acting 機能バージョン、およびプレーヤーのアスペクト比を取得します。呼び出す前に、以下を確認してください：

• 認証：プライマリ API Key は必須ではありません。ticket が入室検証を完了します。取得方法については、認証情報の取得 を参照してください。
• 前提条件：ticket は Travel 資格情報の取得 から取得したものであり、未期限切れかつ未使用で、World のステータスが ready である必要があります。
• 呼び出し元：クライアントから呼び出します。

HTTP リクエスト

curl --location 'https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/api/v2/apps/happyoyster-1.0-acting/openapi/v1/travels/enter-travel' \
    -H "Authorization: Bearer $DASHSCOPE_API_KEY" \
    -H 'Content-Type: application/json' \
    -d '{
    "ticket": "{ticket}"
}'

{
    "code": 0,
    "message": null,
    "data": {
        "encryptedTravelId": "trvl_a1b2****",
        "encryptedWorldId": "enc_a1b2****",
        "mode": 3,
        "creationModel": "simple",
        "playUrl": null,
        "firstFrame": "https://cdn.happyoyster.com/frames/acting_world_xyz789.jpg",
        "rtcConfig": {
            "channelId": "stream_abc123",
            "appId": "18bca2e3218c46aebf8ff3a32fb12311",
            "token": "007eJxTYOh...",
            "userId": "user_1"
        },
        "version": "actingV2",
        "aspectRatio": "9:16",
        "noStreamAutoEndTimeoutSec": 30,
        "maxExperienceTimeSec": 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 に入り、アーティファクト処理が開始されます。