CreateMediaConvertTask による非同期メディア処理タスクの作成 - IMM

非同期メディアトランスコーディングジョブを作成します。このジョブでは、メディアのトランスコード、メディアの連結、動画フレームのキャプチャ、およびアニメーション画像の生成をサポートします。

操作説明

本 API を使用する前に、Intelligent Media Management の課金モデルおよび料金についてご確認ください。
本 API を呼び出す前に、現在のリージョンに利用可能なプロジェクトが存在することを確認してください。詳細については、「プロジェクト管理」をご参照ください。
重要非同期タスクの完了時間は保証されません。
デフォルトでは、本 API はメディアトランスコードに対して単一の動画、音声、または字幕ストリームのみを処理します。ストリーム数は設定可能です。
メディアの連結では、本 API は最大 11 個のメディアファイルをサポートします。メディアトランスコード、フレームキャプチャ、その他の操作に関する設定パラメーターは、連結されたメディア全体に適用されます。
これは非同期 API です。タスク開始後、タスク情報は 7 日間のみ保持され、その後は取得できません。タスク情報を表示するには、GetTask または ListTasks から返される TaskId を使用してください。また、Notification パラメーターを設定することで、タスク完了通知を受信できます。

今すぐお試しください

この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

テスト

RAM 認証

下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。
API：アクションを具体的に実行するための API。
アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。
リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。
- リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。
- リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。
条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。
依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

imm:CreateMediaConvertTask

create

*Project

acs:imm:{#regionId}:{#accountId}:project/{#ProjectName}

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
ProjectName	string	必須	プロジェクト名。プロジェクト名の取得方法については、「プロジェクトの作成」をご参照ください。	test-project
Sources	array<object>	必須	ソースメディアファイルのリスト。複数のファイルを指定した場合、URI の順序で連結されます。
	array<object>	任意	ソースメディアファイル。
URI	string	任意	ソースファイルの OSS URI。URI は `oss://${Bucket}/${Object}` 形式である必要があります。ここで、`${Bucket}` はプロジェクトと同じリージョンにある OSS バケットの名前、`${Object}` はファイル拡張子を含むオブジェクトの完全なパスです。	oss://test-bucket/test-object
StartTime	number	任意	トランスコード開始時刻（秒単位）。有効な値： `0`（デフォルト）：メディアファイルの先頭からトランスコードを開始します。 `n`（0 より大きい値）：メディアファイルの先頭から `n` 秒経過後にトランスコードを開始します。	0
Duration	number	任意	トランスコード対象のメディアの持続時間（秒単位）。`0`（デフォルト）を指定すると、ファイル末尾までトランスコードが継続されます。	0
Subtitles	array<object>	任意	追加する字幕のリスト。デフォルトでは空です。
	object	任意	字幕情報。
URI	string	任意	字幕ファイルの OSS URI。URI は `oss://${Bucket}/${Object}` 形式である必要があります。ここで、`${Bucket}` はプロジェクトと同じリージョンにある OSS バケットの名前、`${Object}` はファイル拡張子を含むオブジェクトの完全なパスです。サポートされる字幕フォーマットには、`srt`、`vtt`、`mov_text`、`ass`、`dvd_sub`、`pgs` があります。	oss://test-bucket/test-object
TimeOffset	number	任意	字幕のタイムオフセット（秒単位）。デフォルト値：`0`。	10.5
Language	string	任意	字幕の言語（ISO 639-2 言語コードで指定）。デフォルトでは空です。	eng
Attached	boolean	任意	`true` の場合、このソースメディアファイルは同期化された音声または動画ストリームとして出力に追加されます。デフォルト値：`false`。説明 `Attached` を `true` に設定することは、アライメント基準として使用されるソースファイル（`AlignmentIndex` で指定）に対してはできません。	false
AlignMode	string	任意	追加された音声および動画ストリームのアライメントポリシー。有効な値： `false`（デフォルト）：アライメントを行いません。 `loop`：音声または動画コンテンツをループして、持続時間を一致させます。 `pad`：音声の場合はサイレンス、動画の場合は黒いフレームを挿入して、持続時間を一致させます。説明 `Attached` を `true` に設定した場合のみ、本パラメーターが有効です。	false
DisableVideo	boolean	任意	`true` の場合、このソースからのビデオストリームを無効化します。デフォルト値：`false`。 true：無効化。 false（デフォルト）：有効化。	false
DisableAudio	boolean	任意	`true` の場合、このソースからの音声ストリームを無効化します。デフォルト値：`false`。 true：無効化。 false（デフォルト）：有効化。	false
Targets	array<object>	必須	メディア処理ジョブのリスト。複数のジョブを設定できます。
	array<object>	任意	単一のメディア処理ジョブとその出力を定義します。
URI	string	任意	トランスコード後の出力ファイルの OSS URI。 URI は `oss://${Bucket}/${Object}` 形式である必要があります。ここで、`${Bucket}` はプロジェクトと同じリージョンにある OSS バケットの名前、`${Object}` はオブジェクトの完全なパスです。 URI にファイル拡張子が含まれている場合、すべての出力メディアファイルがこの URI に保存されます。複数のファイルが生成された場合、それらは互いに上書きされます。 URI にファイル拡張子が含まれていない場合、出力 URI は URI、Container、および Segment パラメーターによって決定されます。たとえば、URI が `oss://examplebucket/outputVideo` の場合： Container が `mp4` で Segment が未設定の場合、出力ファイルは `oss://examplebucket/outputVideo.mp4` に保存されます。 Container が `ts` で Segment の `Format` が `hls` の場合、`oss://examplebucket/outputVideo.m3u8` に M3U8 ファイルが生成され、`oss://examplebucket/outputVideo` をプレフィックスとする複数の TS ファイルも生成されます。	oss://test-bucket/test-target-object.mp4
Container	string	任意	出力ファイルのメディアコンテナ。サポートされるコンテナは以下のとおりです：動画／音声コンテナ：`mp4`、`mkv`、`mov`、`asf`、`avi`、`mxf`、`ts`、`flv` 音声専用コンテナ：`mp3`、`aac`、`flac`、`oga`、`ac3`、`opus` 重要 `Container` と `URI` は同時に指定する必要があります。字幕抽出、フレームキャプチャ、アニメーション画像生成などのタスクを実行する場合は、`Container` と `URI` の両方を省略してください。これらのパラメーターを省略すると、メディアコンテナは作成されず、`Segment`、`Video`、`Audio`、`Speed` は無視されます。	mp4
Speed	number	任意	出力メディアの再生速度設定。有効な値：[0.5, 1.0]。デフォルト値：`1.0`。説明このパラメーターは再生速度のメタデータフラグを設定するものであり、メディアを異なる速度で再エンコードする（いわゆるスピードトランスコード）処理ではありません。	1.0
Segment	object	任意	メディアセグメント分割の設定。デフォルトでは、メディアセグメント分割は無効化されています。
Format	string	任意	メディアセグメント分割方式。有効な値： `hls` `dash`	hls
Duration	number	任意	各セグメントの持続時間（秒単位）。	30
StartNumber	integer	任意	セグメントの開始シーケンス番号。このパラメーターは HLS のみで有効です。デフォルト値：`0`。	5
Video	TargetVideo	任意	動画処理パラメーター。重要このパラメーターを省略した場合、最初の動画ストリームがトランスコードなしで出力にパススルーされます。
Audio	TargetAudio	任意	音声処理パラメーター。重要このパラメーターを省略した場合、最初の音声ストリームがトランスコードなしで出力にパススルーされます。
Subtitle	TargetSubtitle	任意	字幕処理パラメーター。重要このパラメーターを省略した場合、最初の字幕ストリームが出力にパススルーされます。
Image	TargetImage	任意	フレームキャプチャ、スプライトシートキャプチャ、およびアニメーション画像生成のための構成。
StripMetadata	boolean	任意	`true` の場合、出力ファイルからメタデータ（例：`title`、`album`）を削除します。デフォルト値：`false`。
Data	object	任意
Stream	array	任意
	integer	任意
AttachedPicture	object	任意
Stream	array	任意
	integer	任意
UserData	string	任意	非同期通知で返されるカスタムデータ。ビジネスロジックとの関連付けに使用できます。最大長：2,048 バイト。	{"ID": "testuid","Name": "test-user","Avatar": "http://test.com/testuid"}
Tags	object	任意	非同期ジョブの検索およびフィルターに使用できるカスタムタグ。	{"test":"val1"}
CredentialConfig	CredentialConfig	任意	このパラメーターは任意であり、高度なアクセス制御シナリオでのみ必要です。ロールチェイニングの構成です。詳細については、「ロールチェイニングを使用して他エンティティのリソースにアクセスする」をご参照ください。
Notification	Notification	任意	非同期通知の構成です。このオブジェクトの詳細については、Notification データ型をご参照ください。非同期通知メッセージの形式については、「非同期通知メッセージの形式」をご参照ください。
AlignmentIndex	integer	任意	メディアファイルを連結する場合、このパラメーターは Sources リスト内のプライマリメディアファイルのインデックスを指定します。プライマリファイルは、その `Video` および `Audio` ストリームからデフォルトトランスコーディングパラメーター（解像度やフレームレートなど）を提供します。デフォルト値は `0` であり、これは `Sources` リスト内の最初のメディアファイルに対応します。	0

レスポンスフィールド

フィールド	型	説明	例
	object	応答オブジェクト。
RequestId	string	リクエスト ID。	CA995EFD-083D-4F40-BE8A-BDF75FFFE0B6
EventId	string	イベント ID。	0ED-1Bz8z71k5TtsUejT4UJ16Es****
TaskId	string	タスク ID。	MediaConvert-adb1ee28-c4c9-42a7-9f54-3b8eadcb****

例

成功レスポンス

JSONJSON

{
  "RequestId": "CA995EFD-083D-4F40-BE8A-BDF75FFFE0B6",
  "EventId": "0ED-1Bz8z71k5TtsUejT4UJ16Es****",
  "TaskId": "MediaConvert-adb1ee28-c4c9-42a7-9f54-3b8eadcb****"
}

エラーコード

完全なリストについては、「エラーコード」をご参照ください。

変更履歴

完全なリストについては、「変更履歴」をご参照ください。