このトピックでは、SubmitSegmentationJob 操作を使用してスマートセグメンテーションを実行する方法について説明します。また、GetSmartHandleJob 操作を呼び出してスマートセグメンテーションジョブの結果を取得する際に返されるレスポンスパラメーターについても説明します。課金の詳細については、「スマートセグメンテーションの課金」をご参照ください。
注：メディアアセットの OSS URL で指定されたリージョンは、呼び出す OpenAPI エンドポイントのリージョンと同じである必要があります。
サポートされているリージョン：中国 (上海)、中国 (北京)、中国 (杭州)、中国 (深セン)、米国 (西部)、シンガポール。
注意事項
スマートセグメンテーションの OpenAPI 操作の詳細については、「SubmitSegmentationJob」をご参照ください。主要なパラメーターの説明については、このトピックの「JobParams パラメーター」、「InputConfig パラメーター」、および「OutputConfig パラメーター」をご参照ください。
スマートセグメンテーションジョブの結果をクエリするには、GetSmartHandleJob 操作を呼び出します。ジョブのレスポンスにおける主要なパラメーターの説明については、「AiResult パラメーター」をご参照ください。
JobParams パラメーター
JobParams を設定して、動画ショットセグメンテーションのポリシーを指定できます。
パラメーター | 型 | 説明 | 必須 |
Mode | String | セグメンテーションモード。有効値：
| はい |
Ranges | List<Range> | カスタムセグメンテーションの時間範囲。このパラメーターは、Mode が UserDefined に設定されている場合に必須です。 | いいえ |
Range パラメーター
パラメーター | 型 | 説明 | 必須 |
In | Float | セグメントの開始時刻。単位：秒。例：0。 | はい |
Out | Float | セグメントの終了時刻。単位：秒。例：10。 | はい |
パラメーター例
{
"Mode": "UserDefined",
"Ranges": [
{
"In": 0,
"Out": 10
},
{
"In": 20,
"Out": 30
}
]
}InputConfig パラメーター
InputConfig を設定して、ソース動画素材を指定できます。
パラメーター | 型 | 説明 | 必須 |
Type | String | メディアタイプ。次のいずれかのタイプを選択します：
| はい |
Media | String |
| はい |
パラメーター例
{
"Type": "Media",
"Media": "c5c62d8f0*********12dce8e77dc6d"
}OutputConfig パラメーター
OutputConfig を設定して、出力アドレスや命名規則などのパラメーターを指定できます。
パラメーター | 型 | 説明 | 必須 | 例 |
OutputMediaTarget | String | 出力ファイルのターゲットタイプ。
| はい | oss-object |
Endpoint | String | S3 プロトコルに準拠したエンドポイント。
デフォルト値は、同じリージョンの OSS エンドポイントです。 | いいえ | https://oss-cn-shanghai.aliyuncs.com |
Bucket | String | S3 プロトコルに準拠したストレージバケット。
| はい | test-output |
ObjectKey | String | S3 プロトコルに準拠したオブジェクト名。 サポートされているプレースホルダー：
| はい | dir/to/testOutput_{index}.mp4 |
ExportAsNewMedia | Boolean | 出力を新しいメディアアセットとしてエクスポートするかどうかを指定します。 このパラメーターは、OutputMediaTarget が oss-object に設定されている場合にのみ有効です。 | いいえ。デフォルト値は false です。 | false |
Width | Integer | 出力動画の幅。単位：px。このパラメーターを指定しない場合、ソース動画の幅が使用されます。 | いいえ | 1280 |
Height | Integer | 出力動画の高さ。単位：px。このパラメーターを指定しない場合、ソース動画の高さが使用されます。 | いいえ | 720 |
JSONObject | Crf や Codec などの出力ビデオストリームの構成。 | いいえ | { "Bitrate": 3000 } |
パラメーター例
{
"OutputMediaTarget": "oss-object",
"Endpoint": "https://oss-cn-shanghai.aliyuncs.com",
"Bucket": "test-output",
"ObjectKey": "dir/to/testOutput_{index}.mp4",
"ExportAsNewMedia": false,
"Width": 1280,
"Height": 720,
"Video": {
"Bitrate": 3000
}
}GetSmartHandleJob のレスポンスパラメーター
GetSmartHandleJob 操作を呼び出して、スマートセグメンテーションジョブの結果を取得できます。次のセクションでは、AiResult のパラメーターについて説明します：
AiResult パラメーター
{
"SegmentationResult": {
"OutputEndpoint": "http://oss-cn-shanghai.aliyuncs.com", // S3 プロトコルに準拠したエンドポイント
"OutputBucket": "test-output", // S3 プロトコルに準拠したバケット
"OutputObjectResults": [ // ショットセグメンテーション後の結果
{
"ObjectKey": "testOutput_0.mp4", // S3 プロトコルに準拠したオブジェクト名
"MediaId": "xxx1" // ショットセグメンテーション後に生成されたメディアアセットの ID
},
{
"ObjectKey": "testOutput_0.mp4",
"MediaId": "xxx2"
}
]
}
}