Classic/VPC環境で利用できます。
カテゴリにエンコードファイルを追加します。
リクエスト
リクエスト形式を説明します。リクエスト形式は次の通りです。
| メソッド | URI |
|---|---|
| PUT | /api/v2/category/{categoryId}/add-files |
リクエストヘッダ
VOD Station APIで共通して使用されるヘッダの詳細は、VOD Stationのリクエストヘッダをご参照ください。
リクエストパスパラメータ
リクエストパスパラメータの説明は次の通りです。
| フィールド | タイプ | 必須の有無 | 説明 |
|---|---|---|---|
categoryId |
String | Required | カテゴリ ID
|
リクエストボディ
リクエストボディの説明は次の通りです。
| フィールド | タイプ | 必須の有無 | 説明 |
|---|---|---|---|
bucketName |
String | Conditional | 入力ファイル保存場所のバケット名
|
pathList |
Array | Conditional | ファイル名を含む入力ファイルのバケットの詳細パス
|
httpDownloadUrlList |
Array | Conditional | ファイル名を含む入力ファイルの HTTP URLパス
|
notification |
String | Optional | 入力ファイルのコールバック(Callback) URL設定
|
output |
Object | Optional | 入力ファイルに対する出力設定 |
output.bucketName |
String | Required | 出力ファイル保存先のバケット名 |
output.filePath |
String | Required | 出力ファイル保存先の詳細パス
|
output.thumbnailBucketName |
String | Optional | サムネイル抽出ファイル保存先のバケット名
|
output.thumbnailFilePath |
String | Optional | サムネイル抽出ファイル保存先の詳細パス
|
output.accessControl |
String | Optional | 出力ファイルの公開範囲
|
output.thumbnailAccessControl |
String | Optional | 抽出サムネイルの公開範囲
|
output.withoutCategoryName |
Boolean | Optional | 出力パスにカテゴリ名のフォルダを作成するか
|
setAdvancedOptions |
Boolean | Optional | 高度な設定
|
advancedOptions |
Object | Optional | 高度な設定 |
advancedOptions.trimming |
Object | Optional | 出力ファイルのトリミング(再生区間)設定 |
advancedOptions.trimming.startTimeCode |
String | Required | トリミング開始点(HH:MM:SS.S) |
advancedOptions.trimming.endTimeCode |
String | Required | トリミング終了点(HH:MM:SS.S)
|
advancedOptions.imageOverlay |
Object | Optional | 画像オーバーレイ(挿入)設定 |
advancedOptions.imageOverlay.input |
Object | Required | 画像の設定 |
advancedOptions.imageOverlay.input.bucketName |
String | Required | 画像が保存されているバケット名 |
advancedOptions.imageOverlay.input.filePath |
String | Required | ファイル名を含む画像の詳細パス |
advancedOptions.imageOverlay.position |
Object | Required | 画像位置の設定 |
advancedOptions.imageOverlay.position.x |
Integer | Required | x軸の位置(ピクセル) |
advancedOptions.imageOverlay.position.y |
Integer | Required | y軸の位置(ピクセル) |
advancedOptions.imageOverlay.size |
Object | Required | 画像サイズの設定 |
advancedOptions.imageOverlay.size.width |
Integer | Required | 画像の幅(ピクセル) |
advancedOptions.imageOverlay.size.height |
Integer | Required | 画像の高さ(ピクセル) |
リクエスト例
リクエストのサンプルコードは次の通りです。
curl --location --request PUT 'https://vodstation.apigw.ntruss.com/api/v2/category/*****/add-files' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
--data '{
"httpDownloadUrlList": [
"https://kr.object.ncloudstorage.com/station-000-input/VODStation2.mp4"
],
"notification": "https://example.com/callback",
"output": {
"bucketName": "station-000",
"filePath": "/",
"thumbnailBucketName": "station-000",
"thumbnailFilePath": "/thumbnail",
"accessControl": "PUBLIC_READ",
"thumbnailAccessControl": "PUBLIC_READ",
"withoutCategoryName": false
},
"setAdvancedOptions": true,
"advancedOptions": {
"trimming": {
"startTimeCode": "00:00:00.0",
"endTimeCode": "00:08:00.9"
},
"imageOverlay": {
"input": {
"bucketName": "station-000",
"filePath": "/VODStation.png"
},
"position": {
"x": 50,
"y": 50
},
"size": {
"width": 50,
"height": 50
}
}
}
}'
レスポンス
レスポンス形式を説明します。
レスポンスボディ
レスポンスボディの説明は次の通りです。
| フィールド | タイプ | 必須の有無 | 説明 |
|---|---|---|---|
content |
Array | - | カテゴリにエンコードファイル追加の結果: content |
content
contentの説明は次の通りです。
| フィールド | タイプ | 必須の有無 | 説明 |
|---|---|---|---|
id |
Integer | - | ファイルエンコードジョブ ID
|
status |
String | - | ファイルエンコード状態
|
output |
Object | Required | カテゴリの出力設定 |
output.bucketName |
String | Required | 出力ファイル保存先のバケット名 |
output.filePath |
String | Required | 出力ファイル保存先の詳細パス |
output.accessControl |
String | - | 出力ファイルの公開範囲
|
output.thumbnailAccessControl |
String | - | 抽出サムネイルの公開範囲
|
output.withoutCategoryName |
Boolean | - | 出力パスにカテゴリ名のフォルダを作成するか
|
output.thumbnailOutput |
Object | - | サムネイル抽出設定情報 |
output.thumbnailOutput.bucketName |
String | - | サムネイル抽出ファイル保存先のバケット名 |
output.thumbnailOutput.filePath |
String | - | サムネイル抽出ファイル保存先の詳細パス |
setAdvancedOptions |
Boolean | - | 高度な設定 |
advancedOptions |
Object | - | 高度な設定情報
|
advancedOptions.trimming |
Object | - | 出力ファイルのトリミング(再生区間)設定 |
advancedOptions.trimming.startTimeCode |
String | - | トリミング開始点(HH:MM:SS.S) |
advancedOptions.trimming.endTimeCode |
String | - | トリミング終了点(HH:MM:SS.S) |
advancedOptions.imageOverlay |
Object | - | 画像オーバーレイ(挿入)設定 |
advancedOptions.imageOverlay.input |
Object | - | 画像の設定情報 |
advancedOptions.imageOverlay.input.bucketName |
String | - | 画像が保存されているバケット名 |
advancedOptions.imageOverlay.input.filePath |
String | - | ファイル名を含む画像の詳細パス |
advancedOptions.imageOverlay.size |
Object | - | 画像のサイズ情報 |
advancedOptions.imageOverlay.size.width |
Integer | - | 画像の幅(ピクセル) |
advancedOptions.imageOverlay.size.height |
Integer | - | 画像の高さ(ピクセル) |
advancedOptions.imageOverlay.position |
Object | - | 挿入する画像位置の設定 |
advancedOptions.imageOverlay.position.x |
Integer | - | x軸の位置(ピクセル) |
advancedOptions.imageOverlay.position.y |
Integer | - | y軸の位置(ピクセル) |
httpDownloadUrl |
String | - | 外部からダウンロードする HTTP URL |
レスポンスステータスコード
VOD Station APIで共通して使用されるレスポンスステータスコードの詳細は、VOD Stationのレスポンスステータスコードをご参照ください。
レスポンス例
レスポンスのサンプルコードは次の通りです。
{
"content": [
{
"id": *******,
"status": "WAITING",
"output": {
"bucketName": "station-000",
"filePath": "/",
"accessControl": "PUBLIC_READ",
"thumbnailAccessControl": "PUBLIC_READ",
"withoutCategoryName": false,
"thumbnailOutput": {
"bucketName": "station-000",
"filePath": "/thumbnail"
}
},
"setAdvancedOptions": true,
"advancedOptions": {
"trimming": {
"startTimeCode": "00:00:00.0",
"endTimeCode": "00:08:00.9"
},
"imageOverlay": {
"input": {
"bucketName": "station-000",
"filePath": "/VODStation.png"
},
"size": {
"width": 50,
"height": 50
},
"position": {
"x": 50,
"y": 50
}
}
},
"httpDownloadUrl": "https://kr.object.ncloudstorage.com/station-000-input/VODStation2.mp4"
}
]
}