オンライン編集プロジェクトを作成します。プロジェクトのタイトル、説明、タイムライン、サムネイルなどの構成を指定できます。
操作説明
-
動画編集の完成品の再生時間に基づいて課金されます。詳細については、「動画編集」およびライブ編集をご参照ください。処理に失敗した場合は、課金されません。
-
編集プロジェクトを作成後、メディア編集合成タスクを送信するには、SubmitMediaProducingJob — 編集合成ジョブの送信 を呼び出します。ライブ編集タスクを送信するには、SubmitLiveEditingJob — ライブ編集タスクの送信 を呼び出します。
今すぐお試しください
テスト
RAM 認証
|
アクション |
アクセスレベル |
リソースタイプ |
条件キー |
依存アクション |
|
ice:CreateEditingProject |
*All Resource
|
なし | なし |
リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| Title |
string |
必須 |
オンライン編集プロジェクトのタイトルです。 |
example |
| Description |
string |
任意 |
オンライン編集プロジェクトの説明です。 |
描述 |
| Timeline |
string |
任意 |
オンライン編集プロジェクトのタイムライン(JSON 形式)です。 |
{"VideoTracks":[{"VideoTrackClips":[{"MediaId":"****4d7cf14dc7b83b0e801c****"},{"MediaId":"****4d7cf14dc7b83b0e801c****"}]}]} |
| CoverURL |
string |
任意 |
オンライン編集プロジェクトのサムネイル URL です。 |
https://example.com/example.png |
| TemplateId |
string |
任意 |
テンプレート ID です。このパラメーターを使用すると、タイムラインを簡単に迅速に構築できます。注意:Timeline と TemplateId のいずれか一方のみを指定できます。TemplateId を指定する場合は、ClipsParam も必ず指定してください。 |
****96e8864746a0b6f3**** |
| ClipsParam |
string |
任意 |
テンプレートに対応する素材パラメーター(JSON 形式)です。TemplateId を指定する場合は、ClipsParam も必ず指定してください。詳細については、「標準テンプレートの作成と使用」および「高度なテンプレートの作成と使用」をご参照ください。 |
见模板使用文档 |
| TemplateType |
string |
任意 |
テンプレートの種類です。テンプレートベースのオンライン編集プロジェクトを作成する場合に必須のパラメーターです。デフォルト値:Timeline。有効な値は以下のとおりです。
列挙値:
|
Timeline |
| MaterialMaps |
string |
任意 |
プロジェクトに関連付けられた素材です。複数の素材 ID はカンマ (,) で区切ります。各タイプにつき最大 10 個の素材 ID をサポートします。 |
{"video":"*****2e057304fcd9b145c5cafc*****", "image":"****8021a8d493da643c8acd98*****,*****cb6307a4edea614d8b3f3c*****", "liveStream": "[{\"appName\":\"testrecord\",\"domainName\":\"test.alivecdn.com\",\"liveUrl\":\"rtmp://test.alivecdn.com/testrecord/teststream\",\"streamName\":\"teststream\"}]", "editingProject": "*****9b145c5cafc2e057304fcd*****"} |
| BusinessConfig |
string |
任意 |
プロジェクトのビジネス構成です。通常の編集プロジェクトでは、このパラメーターを無視できます。 ライブストリーム編集プロジェクトの場合、以下のルールに従ってください:OutputMediaConfig.StorageLocation は必須です。OutputMediaConfig.Path は任意です。このオプションを指定しない場合、ライブストリームクリップはデフォルトでルートディレクトリに保存されます。 OutputMediaTarget の有効な値は、vod-media および oss-object です。OutputMediaTarget を指定しない場合、デフォルト値として oss-object が使用されます。 OutputMediaTarget を vod-media に設定した場合、OutputMediaConfig.Path の設定は適用されません。 |
{ "OutputMediaConfig" : { "StorageLocation": "test-bucket.oss-cn-shanghai.aliyuncs.com", "Path": "test-path" }, "OutputMediaTarget": "oss-object", "ReservationTime": "2021-06-21T08:05:00Z" } |
| ProjectType |
string |
任意 |
編集プロジェクトの種類です。有効な値は、EditingProject および LiveEditingProject です。EditingProject は通常の編集プロジェクトを示し、LiveEditingProject はライブストリーム編集プロジェクトを示します。 |
LiveEditingProject |
レスポンスフィールド
|
フィールド |
型 |
説明 |
例 |
|
object |
レスポンスパラメーターです。 |
||
| RequestId |
string |
リクエスト ID です。 |
******3B-0E1A-586A-AC29-742247****** |
| Project |
object |
オンライン編集プロジェクトの情報です。 |
|
| ProjectId |
string |
オンライン編集プロジェクトの ID です。 |
****01bf24bf41c78b2754cb3187**** |
| Title |
string |
オンライン編集プロジェクトのタイトルです。 |
example_title |
| Description |
string |
オンライン編集プロジェクトの説明です。 |
example_description |
| Timeline |
string |
オンライン編集プロジェクトのタイムライン(JSON 形式)です。 このパラメーターを空欄のままにした場合、空のタイムラインが作成され、オンライン編集プロジェクトの持続時間はゼロになります。 |
{"VideoTracks":[{"VideoTrackClips":[{"MediaId":"****4d7cf14dc7b83b0e801c****"},{"MediaId":"****4d7cf14dc7b83b0e801c****"}]}]} |
| TemplateId |
string |
テンプレート ID です。 |
****96e8864746a0b6f3**** |
| ClipsParam |
string |
テンプレートの素材パラメーターです。 |
见模板使用文档 |
| CoverURL |
string |
オンライン編集プロジェクトのサムネイル URL です。 |
http://example-bucket.oss-cn-shanghai.aliyuncs.com/example.png?Expires= |
| Status |
integer |
オンライン編集プロジェクトのステータスです。 有効な値は以下のとおりです。 ・1:下書き ・2:編集中 ・3:生成中 ・4:生成済み ・5:生成失敗 ・7:削除済み |
2 |
| StatusName |
string |
オンライン編集プロジェクトのステータスです。詳細については、ステータス一覧をご参照ください。 |
Editing |
| CreateTime |
string |
オンライン編集プロジェクトが作成された時刻です。 |
2021-01-08T16:52:07Z |
| ModifiedTime |
string |
オンライン編集プロジェクトが最後に編集された時刻です。 |
2021-01-08T16:52:07Z |
| Duration |
number |
オンライン編集プロジェクトの持続時間です。 |
3.4200000 |
| CreateSource |
string |
オンライン編集プロジェクトの作成方法です。有効な値は以下のとおりです。 ・OpenAPI ・AliyunConsole ・WebSDK ・LiveEditingOpenAPI ・LiveEditingConsole |
WebSDK |
| ModifiedSource |
string |
オンライン編集プロジェクトの編集方法です。有効な値は以下のとおりです。 ・OpenAPI ・AliyunConsole ・WebSDK ・LiveEditingOpenAPI ・LiveEditingConsole |
WebSDK |
| TemplateType |
string |
オンライン編集プロジェクトのテンプレート種別です。有効な値は以下のとおりです。 ・Timeline ・VETemplate |
Timeline |
| BusinessConfig |
string |
プロジェクトのビジネス構成です。通常の編集プロジェクトでは、このパラメーターを無視できます。 |
{ "OutputMediaConfig" : { "StorageLocation": "test-bucket.oss-cn-shanghai.aliyuncs.com", "Path": "test-path" }, "OutputMediaTarget": "oss-object", "ReservationTime": "2021-06-21T08:05:00Z" } |
| ProjectType |
string |
編集プロジェクトの種類です。デフォルト値:EditingProject。有効な値は以下のとおりです。 ・EditingProject:通常の編集プロジェクト。 ・LiveEditingProject:ライブストリーム編集プロジェクト。 |
LiveEditingProject |
| BusinessStatus |
string |
プロジェクトのビジネスステータスです。通常の編集プロジェクトでは、このパラメーターを無視できます。有効な値は以下のとおりです。
|
Reserving |
例
成功レスポンス
JSONJSON
{
"RequestId": "******3B-0E1A-586A-AC29-742247******",
"Project": {
"ProjectId": "****01bf24bf41c78b2754cb3187****",
"Title": "example_title",
"Description": "example_description",
"Timeline": "{\"VideoTracks\":[{\"VideoTrackClips\":[{\"MediaId\":\"****4d7cf14dc7b83b0e801c****\"},{\"MediaId\":\"****4d7cf14dc7b83b0e801c****\"}]}]}",
"TemplateId": "****96e8864746a0b6f3****",
"ClipsParam": "见模板使用文档",
"CoverURL": "http://example-bucket.oss-cn-shanghai.aliyuncs.com/example.png?Expires=&OSSAccessKeyId=&Signature=&security-token=",
"Status": 2,
"StatusName": "Editing",
"CreateTime": "2021-01-08T16:52:07Z",
"ModifiedTime": "2021-01-08T16:52:07Z",
"Duration": 3.42,
"CreateSource": "WebSDK",
"ModifiedSource": "WebSDK",
"TemplateType": "Timeline",
"BusinessConfig": "{ \"OutputMediaConfig\" : { \"StorageLocation\": \"test-bucket.oss-cn-shanghai.aliyuncs.com\", \"Path\": \"test-path\" }, \"OutputMediaTarget\": \"oss-object\", \"ReservationTime\": \"2021-06-21T08:05:00Z\" }",
"ProjectType": "LiveEditingProject",
"BusinessStatus": "Reserving"
}
}
エラーコード
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。