この API を呼び出してメディアトランスコーディングジョブを送信し、非同期トランスコーディングを開始します。
操作説明
注意事項
メディアトランスコーディングは有料機能です。この API を呼び出す前に、ApsaraVideo VOD の課金方法と料金をよく理解していることを確認してください。詳細については、「メディアトランスコーディングの課金」をご参照ください。
これは非同期 API です。ジョブはバックグラウンドでキューに入れられ、非同期で処理されます。結果はコールバックで送信されます。GetTaskDetails 操作を呼び出してジョブステータスをクエリすることもできます。
トランスコーディングジョブは、ステータスが「アップロード済み」、「通常」、または「レビュー中」の動画に対してのみ開始できます。
トランスコーディング結果を取得するには、単一トランスコーディングジョブ完了 および 全トランスコーディングジョブ完了 のイベントに対するメッセージコールバックを受信できます。
この API は、HLS アダプティブビットレートストリーミングのパッケージングジョブにおける字幕 URL の動的置換をサポートしています。パッケージングジョブで字幕処理が不要な場合は、この API を使用しないでください。代わりに、動画のアップロード時に対応するパッケージングテンプレートグループ ID を指定して、パッケージングプロセスを自動的にトリガーします。
今すぐお試しください
テスト
RAM 認証
|
アクション |
アクセスレベル |
リソースタイプ |
条件キー |
依存アクション |
|
vod:SubmitTranscodeJobs |
create |
*All Resource
|
なし | なし |
リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| VideoId |
string |
任意 |
動画 ID。動画 ID は、次のいずれかの方法で取得できます。
|
142710f878bd42508932f660d7b1**** |
| TemplateGroupId |
string |
必須 |
メディアトランスコーディングに使用するトランスコードテンプレートグループの ID。ApsaraVideo VOD コンソールにログインし、[設定管理] >[メディア処理設定] > [トランスコードテンプレートグループ] を選択して、テンプレートグループ ID を表示します。 |
0e408c803baf658ee637790c5d9f**** |
| PipelineId |
string |
任意 |
パイプラインの ID。 |
d3e680e618708erf45fbf2cae7c**** |
| EncryptConfig |
string |
任意 |
暗号化設定。JSON 文字列として指定します。このパラメーターは、HLS 標準暗号化の場合にのみ必要です。 説明
|
{"CipherText":"ZjJmZGViNzUtZWY1Mi00Y2RlLTk3****", "DecryptKeyUri":"http://demo.aliyundoc.com?CipherText=ZjJmZGViNzUtZWY1Mi00Y2RlLTk3****","KeyServiceType":"KMS"} |
| OverrideParams |
string |
任意 |
オーバーライドパラメーター。JSON 文字列として指定します。このパラメーターを使用して、画像ウォーターマークファイル、テキストウォーターマークコンテンツ、字幕ファイル URL、字幕ファイルエンコード形式など、トランスコーディングテンプレートの設定をオーバーライドできます。パラメーター構造の詳細については、「OverrideParams」をご参照ください。 |
{"Watermarks":[{"WatermarkId":"af2afe4761992c47dae973374****","FileUrl":"http://developer.aliyundoc.com/image/image.png"},{"WatermarkId":"e8e5b8038d7ada85b376c2707****","Content":"watermark test"}]} |
| Priority |
string |
任意 |
キュー内のトランスコーディングジョブの優先度。
説明
このパラメーターは、キュー内のすべてのジョブの中での現在のトランスコーディングジョブの優先度にのみ影響します。処理中のジョブの優先度には影響しません。 |
6 |
| UserData |
string |
任意 |
カスタム設定。JSON 文字列として指定します。メッセージコールバックなどの設定を構成できます。詳細については、「UserData」をご参照ください。 説明
メッセージコールバック機能を使用するには、まずコンソールで HTTP コールバック URL を設定し、対応するイベントタイプを選択する必要があります。そうしないと、コールバック設定は有効になりません。 |
{"Extend":{"localId":"****","test":"***"}} |
| SessionId |
string |
任意 |
カスタムのべき等キー。7 日以内に同じべき等キーでリクエストを送信した場合、リクエストは失敗し、エラーが返されます。 キーは最大 50 文字で、大文字、小文字、数字、ハイフン (-)、アンダースコア (_) を使用できます。このパラメーターを指定しないか、空の文字列を渡した場合、システムはリクエストの重複排除を行いません。 |
5c62d40299034bbaa4c195da330**** |
| ReferenceId |
string |
任意 |
ユーザーごとに一意である必要があるカスタム ID。ID は 6~64 文字で、小文字、大文字、数字、ハイフン (-)、アンダースコア (_) を使用できます。 |
123-123 |
レスポンスフィールド
|
フィールド |
型 |
説明 |
例 |
|
object |
レスポンスボディ。 |
||
| TranscodeTaskId |
string |
送信されたトランスコーディングタスクの ID。 |
9f4a0df7da2c8a81c8c0408c84**** |
| RequestId |
string |
リクエスト ID。 |
E4EBD2BF-5EB0-4476-8829-9D94E1B1**** |
| TranscodeJobs |
object |
トランスコーディングジョブのリスト。 |
|
| TranscodeJob |
array<object> |
メディアトランスコーディングジョブの詳細。 説明
このパラメーターは、HLS アダプティブビットレートストリーミングのパッケージングジョブでは返されません。結果を処理するには、非同期コールバックを受信する必要があります。 |
|
|
object |
トランスコーディングジョブの詳細。 |
||
| JobId |
string |
ジョブ ID。 説明
このパラメーターは、HLS アダプティブビットレートストリーミングのパッケージングジョブでは返されません。結果を処理するには、非同期コールバックを受信する必要があります。 |
d8921ce8505716cfe86fb112c4**** |
例
成功レスポンス
JSONJSON
{
"TranscodeTaskId": "9f4a0df7da2c8a81c8c0408c84****",
"RequestId": "E4EBD2BF-5EB0-4476-8829-9D94E1B1****",
"TranscodeJobs": {
"TranscodeJob": [
{
"JobId": "d8921ce8505716cfe86fb112c4****"
}
]
}
}
エラーコード
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。