Skip to main content

HappyOyster-Directing-TravelリワインドAPIリファレンス

Travelを指定されたビデオタイムスタンプまでリワインドし、実際の到達地点から実行を再開します。Travelはまず一時停止状態に入る必要があります。

スコープ

Travelを指定されたビデオタイムスタンプまでリワインドし、実際の到達地点から実行を再開します。呼び出す前に、以下を確認してください：
  • 認証：プライマリ API キーは必須ではありません。プライマリまたは一時 API キーのいずれかで呼び出せます。取得方法については、認証情報の取得 を参照してください。
  • 前提条件：Travelはまずpaused状態に入る必要があります。running状態のまま直接リワインドすることはできません。Travelステータスの照会でConfirmしてください。
  • 呼び出し元：サーバーまたはクライアントのいずれからも呼び出すことができます。

HTTP リクエスト

  • Singapore
  • 米国（バージニア）
POST https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/api/v2/apps/happyoyster-1.0-directing/openapi/v1/travels/rewind{WorkspaceId} を実際の ワークスペースID に置き換えます。

リクエストパラメーター

  • Travelのリワインド
curl --location 'https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/api/v2/apps/happyoyster-1.0-directing/openapi/v1/travels/rewind' \
    -H "Authorization: Bearer $DASHSCOPE_API_KEY" \
    -H 'Content-Type: application/json' \
    -d '{
    "encryptedTravelId": "{encryptedTravelId}",
    "rewindToSec": 84.0,
    "userAgent": "your-client/1.2.0"
}'
Content-Typestring（必須）リクエストのコンテンツタイプ。このパラメータは application/json に設定する必要があります。
Authorization string （必須）API キー認証です。プライマリ API キーは必須ではなく、プライマリまたは一時 API キーのいずれかで呼び出せます。
  • プライマリ API Key：sk- で始まります（例：sk-xxx）。
  • 一時 API キー：st- で始まり、例は st-xxx です。
リクエストボディ
encryptedTravelId string （必須）リワインド対象のDirecting暗号化Travel ID。Travelへの入場によって返されます。
rewindToSec number (必須)ターゲットとなるビデオ時間（秒単位）。0以上の値を指定します。4の倍数（4、8、12など）を推奨します。サーバーはMath.round(rewindToSec / 4) × 4を使用して最も近い4秒境界に丸めます。実際の到達地点は、レスポンス内のresumedAtSec / actualRewindToSecによって決定されます。userAgent string （任意）SDK またはクライアントのバージョン識別子です。空でない文字列であり、HTTP User-Agent よりも優先されます。

レスポンスパラメーター

  • リワインド成功
{
    "code": 0,
    "message": null,
    "data": {
        "encryptedTravelId": "trvl_a1b2****",
        "status": "running",
        "resumedAtSec": 84.0,
        "actualRewindToSec": 84.0
    }
}
code integerリターンコード。0 は成功を意味し、ゼロ以外の値はエラーコードです。
message stringエラーメッセージ。成功時は null です。
data objectレスポンスデータ。失敗時は null です。

プロパティ

encryptedTravelId string暗号化されたTravel ID。status stringリワインド完了後のステータス。runningを返します。resumedAtSec number再生が再開される実際の秒数。リクエストされた値からわずかにずれる場合があります。actualRewindToSec number実際のリワインド到達地点。resumedAtSecと同一です。

前提条件となるステータスと呼び出しに関する注意事項

  • Travelはまずpaused状態に入る必要があります。running状態のまま直接リワインドすることはできません。
  • Travelの一時停止には約3秒の非同期確認バリアがあります。一時停止レスポンスを受信した後でも、このエンドポイントを呼び出す前にTravelステータスの照会をポーリングし、外部から見えるステータスがすでにpausedになっていることを確認する必要があります。
  • スクリプトは4秒単位のBlockで構成されています。rewindToSecには4の倍数（4、8、12など）を指定することを推奨します（例：6 → 8）。
  • 実際の到達地点はresumedAtSec / actualRewindToSecによって決定されます。

エラーコード

モデルの呼び出しに失敗してエラーが返された場合は、HappyOyster エラーコードを参照して解決してください。

次のステップ

リワインド後、Travelはrunning状態に戻ります：