Create short-clip
- Print
- PDF
Create short-clip
- Print
- PDF
Article Summary
Share feedback
Thanks for sharing your feedback!
An API to create short-clips for Live Station. Provides the short-clip list view API to view the list of created short-clips and the short-clip information view API to view detailed information on short-clips.
Note
- Short-clips
- Short-clips can be created at a desired point of time through time machine settings (useDVR==true).
- Short-clips of 100 ms to 4 hours in length can be created through created snapshots.
- Short-clip creation
- Specific, desired segments can be created as short-clips using previously created snapshots.
- Created short-clips are automatically uploaded into the specified NAVER Cloud Object Storage.
- Short-clips are provided in mp4 format.
- startTime and endTime are in ms format, and ms-level trimming is supported.
- When creating short-clips, startTime and endTime are entered relative to the playback time of the snapshots. (For example, if startTime: 0, endTime 1500 is requested, short-clip is to be created for 1.5 seconds (00:00:000 - 00:00:015) of the snapshots)
- Created short-clips can be viewed through short-clip information/short-clip list.
Caution
- Cautions for short-clip creation
- Short-clips can be created only when channel status is READY or PUBLISHING.
- Short-clip end time (endTime) - short-clip start time (startTime) cannot exceed snapshot playback time.
- The minimum short-clip end time is 100 ms.
- Valid snapshot ID's can be obtained by viewing channel list information.
Requests
POST https://livestation.apigw.ntruss.com/api/v2/channels/{channelId}/{snapshotId}
Request headers
| Header name | Required | Description |
|---|---|---|
| x-ncp-apigw-timestamp | YES | Time elapsed since January 1, 1970 00:00:00 UTC in milliseconds. The request is considered invalid if the time difference compared to the API Gateway server is 5 minutes or longerx-ncp-apigw-timestamp:{Timestamp} |
| x-ncp-iam-access-key | YES | Access key ID value issued from NAVER Cloud Platform portalx-ncp-iam-access-key:{Sub Account Access Key} |
| x-ncp-apigw-signature-v2 | YES | Signature encrypted with the access key ID value and secret keyx-ncp-apigw-signature-v2:{API Gateway Signature} |
| Content-Type | YES | Specifies the request body content type as application/jsonContent-Type: application/json |
| x-ncp-region_code | YES | Region code (KR) |
Request bodies
| Field name | Required | Type | Service limits | Description |
|---|---|---|---|---|
| startTime | Yes | Integer | Minimum input time: 0 Requested time format: milliseconds (e.g., 0) | Trimming start point of the short-clip to be created |
| endTime | Yes | Integer | End time exceeding the snapshot playback time cannot be entered Minimum input time: current request time + 100 ms Maximum input time: snapshot playback time Requested time format: milliseconds (e.g., 100) | Trimming end point of the short-clip to be created |
| shortclip | Yes | Object | Short-clip object | |
| shortclip.output | Yes | Object | Settings of the Object Storage in which the created short-clip is to be stored | |
| shortclip.output.accessControl | Yes | String | PRIVATE, PUBLIC_READ | Option which specifies the scope of disclosure of the Object Storage Bucket in which the created short-clip is to be stored Default: PRIVATE |
| shortclip.output.bucketName | Yes | String | Bucket name of the Object Storage in which the created short-clip is to be stored | |
| shortclip.output.filePath | Yes | String | filePath of the Object Storage in which the created short-clip is to be stored filePaths must start with "/" |
Responses
| Field name | Type | Description | Note |
|---|---|---|---|
| channelId | String | Channel ID used in creating short-clip | |
| snapshotId | String | Snapshot ID used in creating short-clip | |
| shortclip | Object | Short-clip object | |
| shortclip.id | Integer | Short-clip ID | |
| shortclip.status | String | Short-clip status | CREATING,COMPLETED,PROCESSING_FAIL,UPLOAD_FAIL |
| shortclip.output | Object | Information in which the created short-clip is to be stored | |
| shortclip.output.accessControl | String | Option which specifies the scope of disclosure of the Object Storage Bucket in which the created short-clip is to be stored Default: PRIVATE | PRIVATE,PUBLIC_READ |
| shortclip.output.bucketName | String | Bucket name of the Object Storage in which the created short-clip is to be stored | |
| shortclip.output.filePath | String | filePath of the Object Storage in which the created short-clip is to be stored filePaths must start with "/" | |
| shortclip.output.fileName | String | File name of the created short-clip | |
| shortclip.createdTime | String | Time of creation of the created short-clip file | |
| shortclip.updatedTime | String | Update time of the created short-clip file |
Examples
Response examples
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"
}
}
}
}
Was this article helpful?