このトピックでは、SubmitHighlightExtractionJob 操作のリクエストパラメーターと、GetSmartHandleJob 操作によって返されるレスポンスパラメーターについて説明します。
注:この操作では、すべてのメディアアセットの Object Storage Service (OSS) URL のリージョンは、呼び出す OpenAPI エンドポイントのリージョンと同じである必要があります。
サポートされているリージョン:中国 (上海)、中国 (北京)、中国 (杭州)、中国 (深圳)、米国 (西部)、シンガポール。Strategy.EnableActionRecog および Strategy.CustomActions パラメーターに対応する アクションタグ認識 機能は、現在 中国 (上海) リージョンでのみ利用可能です。
現在、字幕や人の声がない動画素材はサポートされていません。動画素材がこの要件を満たしていることを確認してください。
使用方法
SubmitHighlightExtractionJob 操作を呼び出して、複数の動画素材からハイライトクリップを抽出できます。主要な API パラメーターの詳細については、「InputConfig パラメーターの説明」および「OutputConfig パラメーターの説明」をご参照ください。
GetSmartHandleJob 操作を呼び出して、ハイライト抽出タスクの詳細をクエリできます。タスク結果の主要なパラメーターの詳細については、「AiResult パラメーターの説明」をご参照ください。
InputConfig パラメーターの説明
InputConfig を設定して、動画素材やハイライト分割構成などのパラメーターを指定できます。
パラメーター | タイプ | 説明 | 必須 |
MediaArray | List<Media> |
重要 字幕や人の声が含まれていない動画素材はサポートされていません。 | はい |
Strategy | ハイライトクリップ抽出ポリシーの設定:
| いいえ |
Strategy パラメーターの説明
パラメーター | タイプ | 説明 | 必須 |
Count | Integer | 単一の素材から抽出するハイライトクリップの数。値は [1, 10] の範囲内である必要があります。デフォルト値は 5 です。 | いいえ |
ClipDuration | Float | 各ハイライトクリップの期待される持続時間 (秒)。値は [3, 60] の範囲内である必要があります。デフォルト値は 15 です。各ハイライトクリップの実際の持続時間は、この値を中心に変動する場合があります。 | いいえ |
EnableActionRecog | Boolean | アクション認識を有効にするかどうかを指定します。デフォルト値は false です。 説明 アクション認識は、中国 (上海) リージョンでのみサポートされています。 | いいえ |
CustomActions | List<String> | カスタムアクションタグ。システムは、提供されたタグ名に基づいてタグを優先的にマッピングします。例:["Fight", "Cry"]。配列には最大 50 個のタグを含めることができます。各タグには最大 5 文字を含めることができます。 説明 アクション認識は、中国 (上海) リージョンでのみサポートされています。 | いいえ |
HighlightDescription | String |
| いいえ |
FaceInfo |
| いいえ |
FaceInfo パラメーターの説明
パラメーター | タイプ | 説明 | 必須 |
ImageInfoList | List<ImageInfo> | キャラクター (顔) 写真のリスト。リストには最大 200 枚の写真を含めることができます。 | いいえ |
ImageInfo パラメーターの説明
パラメーター | タイプ | 説明 | 例 | 必須 |
Name | String | キャラクター (顔) の名前。 | Daniel | はい |
ImageURL | String | キャラクター (顔) 写真のストレージの場所。アドレスは公開アクセス可能な URL である必要があります。顔画像には 1 人だけが含まれ、顔が鮮明で、大きな障害物や欠落部分がないことを確認してください。 | http://[your-cdn-domain]/[your-file-path]/face1.png | はい、いずれか 1 つが必須です。 |
ImageId | String | イメージメディアアセットの ID。 | ****9d46c886b45481030f6e**** |
Media パラメーターの説明
パラメーター | タイプ | 説明 | 必須 |
MediaId | String | メディアアセットの ID。 | 2 つのうち 1 つを指定する必要があります。 両方を指定した場合、MediaId が優先されます。 |
MediaURL | String | OSS 内のメディアアセットの URL。ご自身の OSS バケットのみがサポートされています。 |
パラメーターの例
{
"MediaArray": [
{
"MediaId": "1cb94770da*******75e6e6c5486302"
}
],
"Strategy": {
"Count": 5,
"ClipDuration": 15,
"EnableActionRecog": true,
"CustomActions": ["Fight","Cry"],
"HighlightDescription":"強い感情表現、高いコントラスト、集中したプロットの対立、劇的なハイライトを特徴とするシーンを優先します。例としては、男性主人公 XXX が怒りや保護欲などの激しい感情を表現するシーン、対照的なアイデンティティや行動によって緊張が生み出されるシーン、家族の確執などの中心的な対立を軸に物語が展開するシーン、視聴者の没入感を高め、話題を生み出すために珍しい対話やプロットのひねりが起こるシーンなどがあります。",
"FaceInfo":{"ImageInfoList":[{"Name":"Ning X","ImageURL":"http://[your-cdn-domain]/[your-file-path]/face1.png"}]}
}
}OutputConfig パラメーターの説明
OutputConfig を設定して、最終的な動画の出力場所や命名規則などの合成パラメーターを指定できます。
パラメーター | タイプ | 説明 | 必須 | 例 |
NeedExport | ブール値 | クリップを直接エクスポートするかどうかを指定します。 有効値:
| いいえ。デフォルト値は false です。 | false |
OutputMediaTarget | String | NeedExport = true の場合に必須です。 出力ファイルのターゲットタイプ。
| いいえ。デフォルト値は oss-object です。 | oss-object |
エンドポイント | String | S3 互換のエンドポイント。
デフォルト値は、同じリージョン内の OSS エンドポイントです。 | いいえ | https://oss-cn-shanghai.aliyuncs.com |
Bucket | String | NeedExport = true の場合に必須です。 S3 互換のストレージバケット。
| いいえ | your bucket |
オブジェクトキー | String | NeedExport = true の場合に必須です。 S3 互換のオブジェクトの名前。 サポートされているプレースホルダー:
| いいえ | dir/to/testOutput_{index}.mp4 |
ExportAsNewMedia | ブール値 | NeedExport = true の場合にオプションです。 出力を新しいメディアアセットとしてエクスポートするかどうかを指定します。 このパラメーターは、OutputMediaTarget が oss-object に設定されている場合にのみサポートされます。 | いいえ。デフォルト値は false です。 | false |
幅 | Integer | NeedExport = true の場合にオプションです。 出力動画の幅 (ピクセル単位)。このパラメーターを指定しない場合、出力動画の幅はソース動画の幅と同じになります。 | いいえ | 1280 |
高さ | Integer | NeedExport = true の場合にオプションです。 出力動画の高さ (ピクセル単位)。このパラメーターを指定しない場合、出力動画の高さはソース動画の高さと同じになります。 | いいえ | 720 |
JSONObject | NeedExport = true の場合にオプションです。 Crf や Codec などの出力動画ストリームの構成。 | いいえ | { "Bitrate": 3000 } |
パラメーターの例
{
"NeedExport": true,
"OutputMediaTarget": "oss-object",
"Endpoint": "https://oss-cn-shanghai.aliyuncs.com"
"Bucket": "your-bucket",
"ObjectKey": "dir/to/testOutput_{index}.mp4",
"ExportAsNewMedia": false,
"Width": 1280,
"Height": 720,
"Video": {
"Bitrate": 3000
}
}GetSmartHandleJob
GetSmartHandleJob 操作を呼び出して、ハイライト抽出タスクの結果を取得します。次のセクションでは、AiResult のパラメーターについて説明します。
AiResult パラメーターの説明
{
"HighlightResults": [
{
"Media": "MediaId1", // InputConfig で URL が指定されている場合、ここでも URL が返されます。
"TimeRanges": [
{
"In": 20,
"Out": 30,
"Tags": ["Fight","Cry"], // 検出されたアクションタグ。
"OutputURL": "http://your bucket.oss-cn-shanghai.aliyuncs.com/output_0.mp4", // needExport が true に設定されている場合にのみ返されます。
"MediaId": "MediaId11", // ExportAsNewMedia が true に設定されている場合にのみ返されます。
}
]
},
{
"Media": "MediaId2", // InputConfig で URL が指定されている場合、ここでも URL が返されます。
"TimeRanges": [
{
"In": 2,
"Out": 10,
"Tags": ["Run","Shout"],
"OutputURL": "http://your bucket.oss-cn-******.aliyuncs.com/output_1.mp4" // needExport が true に設定されている場合にのみ返されます。
},
{
"In": 40,
"Out": 50,
"OutputURL": "http://your bucket.oss-cn-******.aliyuncs.com/output_2.mp4" // needExport が true に設定されている場合にのみ返されます。
}
]
}
]
}