Classic/VPC 환경에서 이용 가능합니다.
카테고리에 인코딩 파일을 추가합니다.
요청
요청 형식을 설명합니다. 요청 형식은 다음과 같습니다.
메서드 | URI |
---|---|
PUT | /api/v2/category/{categoryId}/add-files |
요청 헤더
VOD Station API에서 공통으로 사용하는 헤더에 대한 정보는 VOD Station 요청 헤더를 참조해 주십시오.
요청 경로 파라미터
요청 경로 파라미터에 대한 설명은 다음과 같습니다.
필드 | 타입 | 필수 여부 | 설명 |
---|---|---|---|
categoryId |
String | Required | 카테고리 아이디
|
요청 바디
요청 바디에 대한 설명은 다음과 같습니다.
필드 | 타입 | 필수 여부 | 설명 |
---|---|---|---|
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 | - | 파일 인코딩 작업 아이디
|
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"
}
]
}