Adding category file
- Print
- PDF
Adding category file
- Print
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
VOD Station provides an API to add encoding files to categories.
Requests
PUT https://vodstation.apigw.ntruss.com/api/v2/category/{categoryId}/add-files
Request headers
Header name | Description |
---|---|
x-ncp-apigw-timestamp | This is the number of milliseconds that have elapsed since January 1, 1970 00:00:00 UTC If the time difference compared to the API Gateway server is more than 5 minutes, then the request is considered invalid. x-ncp-apigw-timestamp:{Timestamp |
x-ncp-iam-access-key | Access key ID value issued by the NAVER Cloud Platform portalx-ncp-iam-access-key:{Sub Account Access Key} |
x-ncp-apigw-signature-v2 | Signature encrypted with the Access Key ID value and Secret Keyx-ncp-apigw-signature-v2:{API Gateway Signature} |
Content-Type | Specify the request body content type as application/jsonContent-Type: application/json |
Request body
API field names in the request body are case sensitive.
Field name | Requirement status | Type | Restrictions | Default value | Description |
---|---|---|---|---|---|
bucketName | Yes | String | You must enter the name of the bucket where the input file has been uploaded, httpDownload URL or bucketName, and filePath. | ||
pathList | Yes | Array(String) | Support for up to 100 input files | You must enter the detailed path of the input file including the file name, httpDownload URL or bucketName, and filePath. | |
httpDownloadUrlList | Yes | Array(String) | Support for up to 100 input files, http url format, Only receive inputs consisting of AVI, MOV, MP4, MP3, 3GP, MPG, MPEG, M4V, VOB, WMV, ASF, MKV, FLV, WEBM, GIF, AV1, MXF extensions. | You must enter the detailed path of the input file including the file name, httpDownload URL or bucketName, and filePath. | |
notificationUrl | No | String | Callback URL settings for the input file (Overwrite Category notificationUrl Field) | ||
output | No | Object | Output settings for the input file (overwrites the Category output field) | ||
output.bucketName | Yes | String | Output bucket name | ||
output.filePath | Yes | String | Detailed path to upload the output file | ||
output.thumbnailBucketName | Optional | String | If not entered, follow the category settings. | Thumbnail output bucket name | |
output.thumbnailFilePath | Optional | String | If not entered, follow the category settings. Enter between 1 and 256 characters. (English letters, numbers, and special characters except for < > : " / \ ? * % are allowed.) | Detailed path to upload the thumbnail output file | |
output.accessControl | No | String | PUBLIC_READ, PRIVATE | PRIVATE | Disclosure scope of the output file |
output.thumbnailAccessControl | No | String | PUBLIC_READ, PRIVATE | PRIVATE | Disclosure scope of the output thumbnail |
output.withoutCategoryName | No | Boolean | true, false | false | Whether a category name folder is created in the output path |
setAdvancedOptions | No | Boolean | true, false | false | Whether advanced settings are set separately |
advancedOptions | No | Object | NULL | Advanced settings | |
advancedOptions.trimming | No | Object | NULL | Output file trimming settings | |
advancedOptions.trimming.startTimeCode | Yes | String | Format: "HH:MM:SS.S" | - Trimming start point Enter the value to fit the timecode format. | |
advancedOptions.trimming.endTimeCode | Yes | String | Format: "HH:MM:SS.S", A smaller value than the startTimeCode can't be entered. | - Trimming end point Enter the value to fit the timecode format. | |
advancedOptions.imageOverlay | No | Object | NULL | Image overlay settings | |
advancedOptions.imageOverlay.input | Yes | Object | Input image | ||
advancedOptions.imageOverlay.input.bucketName | Yes | String | Name of the bucket where the input image has been uploaded | ||
advancedOptions.imageOverlay.input.filePath | Yes | String | Detailed path of the input image including the file name | ||
advancedOptions.imageOverlay.position | Yes | Object | Location settings of image to be inserted | ||
advancedOptions.imageOverlay.position.x | Yes | Integer | Location of x-axis | ||
advancedOptions.imageOverlay.position.y | Yes | Integer | Location of y-axis | ||
advancedOptions.imageOverlay.size | Yes | Obejct | Size settings of image to be inserted | ||
advancedOptions.imageOverlay.size.width | Yes | Integer | Image width | ||
advancedOptions.imageOverlay.size.height | Yes | Integer | Image height |
Responses
Field name | Type | Description | Remarks |
---|---|---|---|
content[] | Array(Object) | VOD Station OPEN API response object | |
content[].id | Integer | File encoding job ID | |
content[].bucketName | String | Name of the bucket where the input file has been uploaded | |
content[].pathList | Array(String) | Detailed path of the input file including the file name | |
content[].httpDownloadUrl | Array(String) | HTTP URL to download from outside | |
content[].status | String | File encoding status | COMPLETE, WAITING, RUNNING, FAILURE, CANCELED |
content[].notificationUrl | String | Callback URL settings | |
content[].output | Object | Output settings | |
content[].output.bucketName | String | Output bucket name | |
content[].output.filePath | String | Detailed path to upload the input file | |
content[].output.thumbnailBucketName | String | Thumbnail output bucket name | |
content[].output.thumbnailFilePath | String | Thumbnail output file upload detailed path | |
content[].output.accessControl | String | Disclosure scope of the output file | |
content[].output.thumbnailAccessControl | String | Disclosure scope of the output thumbnail | |
content[].output.withoutCategoryName | Boolean | Whether a category name folder is created in the output path | |
content[].advancedOptions | Object | Advanced settings | |
content[].advancedOptions.trimming | Object | Output file trimming settings | |
content[].advancedOptions.trimming.startTimeCode | String | Trimming start point | |
content[].advancedOptions.trimming.endTimeCode | String | Trimming end point | |
content[].advancedOptions.imageOverlay | Object | Image overlay settings | |
content[].advancedOptions.imageOverlay.input | Object | Input image | |
content[].advancedOptions.imageOverlay.input.bucketName | String | Name of the bucket where the input image has been uploaded | |
content[].advancedOptions.imageOverlay.input.filePath | String | Detailed path of the input image | |
content[].advancedOptions.imageOverlay.position | Object | Location settings of image to be inserted | |
content[].advancedOptions.imageOverlay.position.x | Integer | Location of x-axis | |
content[].advancedOptions.imageOverlay.position.y | Integer | Location of y-axis | |
content[].advancedOptions.imageOverlay.size | Obejct | Size settings of image to be inserted | |
content[].advancedOptions.imageOverlay.size.width | Integer | Image width | |
content[].advancedOptions.imageOverlay.size.height | Integer | Image height |
Examples
Request examples
PUT https://vodstation.apigw.ntruss.com/api/v2/category/10095/add-files
PUT /api/v2/category/10095/add-files
HOST: vodstation.apigw.ntruss.com
Content-Type: application/json
x-ncp-apigw-timestamp:1521787414578
x-ncp-iam-access-key:6uxz1nKkcYwUjWRG5Q1V7NsW0i5jErlu2NjBXXgy
x-ncp-apigw-signature-v2:iJFK773KH0WwQ79PasqJ+ZGixtpDQ/abS57WGQdld2M==
{
"bucketName": "vs-input",
"pathList": [
"SampleVideo_1280x720_5mb.mp4", "/1-path/SampleVideo_1920x1080_5m.mp4"
]
}
Response examples
HTTP/1.1 200 OK
Server: nginx
Date: Wed, 12 Sep 2018 09:53:32 GMT
Content-Type: application/json;charset=utf-8
Connection: keep-alive
Access-Control-Allow-Origin: *
x-ncp-trace-id: 36c9k60om4p3238cpmc9gm4cj4
{
"content": [
{
"id": 10240,
"bucketName": "vs-input",
"filePath": "SampleVideo_1280x720_5mb.mp4",
"status": "WAITING"
},
{
"id": 10241,
"bucketName": "vs-input",
"filePath": "/1-path/SampleVideo_1920x1080_5m.mp4",
"status": "WAITING"
}
]
}
Was this article helpful?