숏클립 생성

Live Station 의 숏클립 생성을 위한 API 입니다. 생성한 숏클립 목록 조회를 위한 숏클립 목록 조회 API 와 숏클립 상세 정보 조회를 위한 숏클립 정보 조회 API를 제공합니다.

참고

숏클립
- 채널에 설정된 타임머신 (useDVR==true) 설정을 통해 원하는 시점의 숏클립을 생성할 수 있습니다.
- 생성된 스냅샷을 통해 최소 100ms, 최대 4시간 분량의 숏클립을 생성할 수 있습니다.
숏클립 생성
- 생성해둔 스냅샷을 활용해 원하는 특정 구간을 숏클립으로 생성할 수 있습니다.
- 생성된 숏클립은 입력한 Naver Cloud Object Storage 로 자동 업로드됩니다.
- 숏클립은 mp4 포맷으로 제공됩니다.
- startTime, endTime 의 포맷은 ms로 ms단위 트리밍을 지원합니다.
- 숏클립 생성 시 startTime, endTime 은 스냅샷의 상대 재생 시간으로 입력합니다. (ex. startTime: 0, endTime 1500 을 요청 할 경우 스냅샷중 1.5초 분량 (00:00:000 ~ 00:00:015) 숏클립 생성)
- 생성된 숏클립은 숏클립 정보/숏클립 목록 조회를 통해 확인할 수 있습니다.

주의

숏클립 생성 시 유의 사항
- 숏클립은 채널 상태가 READY 혹은 PUBLISHING 상태일때만 생성할 수 있습니다.
- 숏클립 종료 시간(endTime) - 숏클립 시작 시간 (startTime) 은 스냅샷 재생 시간을 초과할 수 없습니다.
- 숏클립의 종료 시간은 최소 100ms입니다.
- 유효한 스냅샷 ID는 채널 목록, 정보 조회를 통해 획득할 수 있습니다.

요청

POST https://livestation.apigw.ntruss.com/api/fin-v2/channels/{channelId}/{snapshotId}

요청 헤더

헤더명	필수 여부	설명
x-ncp-apigw-timestamp	YES	1970년 1월 1일 00:00:00 협정 세계시(UTC)부터의 경과 시간을 밀리초(Millisecond)로 나타내며 API Gateway 서버와 시간 차가 5분 이상 나는 경우 유효하지 않은 요청으로 간주 `x-ncp-apigw-timestamp:{Timestamp}`
x-ncp-iam-access-key	YES	네이버 클라우드 플랫폼 포털에서 발급받은 Access Key ID 값 `x-ncp-iam-access-key:{Sub Account Access Key}`
x-ncp-apigw-signature-v2	YES	Access Key ID 값과 Secret Key로 암호화한 서명 `x-ncp-apigw-signature-v2:{API Gateway Signature}`
Content-Type	YES	Request body content type을 application/json으로 지정 `Content-Type: application/json`
x-ncp-region_code	YES	리전 코드 (FKR)

요청 바디

필드명	필수 여부	타입	제약 사항	설명
startTime	Yes	Integer	최소 입력 시간: 0 요청 시간 포맷 : miliseconds (ex: 0)	생성할 숏클립의 시작 트리밍 지점
endTime	Yes	Integer	스냅샷 재생 시간을 초과 하는 종료 시간 입력 불가 최소 입력 시간 : 현재 요청 시점 + 100ms 최대 입력 시간 : 스냅샷 재생 시간 요청 시간 포맷 : miliseconds (ex: 100)	생성할 숏클립의 종료 트리밍 지점
shortclip	Yes	Object		숏클립 오브젝트
shortclip.output	Yes	Object		생성된 숏클립이 저장 될 Object Storage 관련 설정
shortclip.output.accessControl	Yes	String	PRIVATE, PUBLIC_READ	생성된 숏클립이 저장 될 Object Storage Bucket 공개 범위를 지정하는 옵션 Default: PRIVATE
shortclip.output.bucketName	Yes	String		생성된 숏클립이 저장 될 Object Storage 의 버킷명
shortclip.output.filePath	Yes	String		생성된 숏클립이 저장 될 Object Storage 의 filePath filePath 는 "/" 부터 시작 해야함

응답

필드명	타입	설명	비고
channelId	String	숏클립 생성에 활용한 채널 ID
snapshotId	String	숏클립 생성에 활용한 스냅샷 ID
shortclip	Object	숏클립 오브젝트
shortclip.id	Integer	숏클립 ID
shortclip.status	String	숏클립 상태	CREATING,COMPLETED,PROCESSING_FAIL,UPLOAD_FAIL
shortclip.output	Object	생성된 숏클립이 저장 될 정보
shortclip.output.accessControl	String	생성된 숏클립이 저장 될 Object Storage Bucket 공개 범위를 지정하는 옵션 Default: PRIVATE	PRIVATE,PUBLIC_READ
shortclip.output.bucketName	String	생성된 숏클립이 저장 될 Object Storage 의 버킷명
shortclip.output.filePath	String	생성된 숏클립이 저장 될 Object Storage 의 filePath filePath 는 "/" 부터 시작 해야함
shortclip.output.fileName	String	생성된 숏클립 파일명
shortclip.createdTime	String	생성된 숏클립 파일 생성 시간
shortclip.updatedTime	String	생성된 숏클립 파일 업데이트 시간

예시

응답 예시

HTTP/1.1 200 OK
Server: nginx
Date: Fri, 26 Jun 2022 09:53:32 GMT
Content-Type: application/json;charset=utf-8
Connection: keep-alive
Access-Control-Allow-Origin: *
x-ncp-trace-id: 36c9k60om4p3238cpmc9gm4cj4

{
  "content": {
    "channelId": "ls-20220623115623-fHnXy",
    "snapshotId": 1047,
    "shortclip": {
      "id": 1060,
      "status": "CREATING",
      "createdTime": 1655979377666,
      "updatedTime": 1655979377666,
      "output": {
        "accessControl": "PRIVATE",
        "bucketName": "myTestBucket",
        "filePath": "/",
        "fileName": "1024-1655290646131.mp4"
      }
    }
  }
}