この操作を呼び出して、メディアトランスコーディングジョブを送信し、非同期処理を実行できます。
操作説明
この操作を呼び出す前に、ApsaraVideo VOD の課金方法と料金を理解していることを確認してください。トランスコーディングは有料機能です。課金の詳細については、メディアトランスコーディングの課金をご参照ください。
ステータスが「アップロード済み」、「通常」、または「レビュー中」の動画のみトランスコーディングできます。
トランスコーディング結果を取得するには、単一解像度のトランスコーディング完了および すべてのトランスコーディングジョブ完了のイベントに対するコールバックメッセージを受信できます。
この操作は、HTTP Live Streaming (HLS) アダプティブビットレートストリーミングのパッケージングジョブにおける字幕 URL の動的置換をサポートします。字幕を含まないパッケージングジョブの場合は、この操作を呼び出さないでください。代わりに、動画のアップロード時にパッケージングテンプレートグループ 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 |
任意 |
キュー内のすべてのジョブにおけるトランスコーディングジョブの優先度。
説明
`Priority` パラメーターは、キュー内のすべてのジョブの中での現在のトランスコーディングジョブの優先度にのみ影響します。トランスコード中のジョブの優先度には影響しません。 |
6 |
| UserData |
string |
任意 |
カスタム設定。このパラメーターは JSON 文字列であり、メッセージコールバックなどの設定をサポートします。詳細については、「UserData」をご参照ください。 説明
メッセージコールバック機能を使用するには、ApsaraVideo VOD コンソールで Webhook アドレスを設定し、対応するイベントタイプを選択する必要があります。そうでない場合、コールバック設定は有効になりません。 |
{"Extend":{"localId":"****","test":"***"}} |
| SessionId |
string |
任意 |
カスタム重複排除 ID。同じ重複排除 ID を持つリクエストが 7 日以内に行われた場合、エラーが返されます。 ID は最大 50 文字で、大文字と小文字、数字、ハイフン (-)、アンダースコア (_) を使用できます。このパラメーターを指定しないか、空のままにした場合、重複排除は実行されません。 |
5c62d40299034bbaa4c195da330**** |
| ReferenceId |
string |
任意 |
カスタム ID。ID は 6~64 文字で、小文字、大文字、数字、ハイフン (-)、アンダースコア (_) を使用できます。ID はユーザーごとに一意である必要があります。 |
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****"
}
]
}
}
エラーコード
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。