View short-clip list

Article summary

Did you find this summary helpful?

Thank you for your feedback

An API to view short-clip list of Live Station. Provides the short-clip information view API to view short-clip list to view information on short-clips.

Requests

GET https://livestation.apigw.ntruss.com/api/v2/channels/{channelId}/{snapshotId}/shortclips?shortclips?shortclipStatus={shortclipStatus}

Request parameters

Parameter name	Required	Type	Service limits	Description
shortclipStatus	No	String	CREATING,COMPLETED,PROCESSING_FAIL,UPLOAD_FAIL	Status of short-clip to be viewed

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 longer `x-ncp-apigw-timestamp:{Timestamp}`
x-ncp-iam-access-key	YES	Access key ID value issued from NAVER Cloud Platform portal `x-ncp-iam-access-key:{Sub Account Access Key}`
x-ncp-apigw-signature-v2	YES	Signature encrypted with the access key ID value and secret key `x-ncp-apigw-signature-v2:{API Gateway Signature}`
Content-Type	YES	Specifies the request body content type as application/json `Content-Type: application/json`
x-ncp-region_code	YES	Region code (KR)

Responses

Field name	Type	Description	Note
channelId	String	Channel ID used in creating short-clip
snapshotId	Integer	Snapshot ID used in creating short-clip
shortclipList	Array	List of created short-clips
shortclipList.id	Integer	Short-clip ID
shortclipList.status	String	Short-clip status	CREATING,COMPLETED,PROCESSING_FAIL,UPLOAD_FAIL
shortclipList.output	Object	Information in which the created short-clip is to be stored
shortclipList.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
shortclipList.output.bucketName	String	Bucket name of the Object Storage in which the created short-clip is to be stored
shortclipList.output.filePath	String	filePath of the Object Storage in which the created short-clip is to be stored filePaths must start with "/"
shortclipList.output.fileName	String	File name of the created short-clip
shortclipList.createdTime	Integer	Time of creation of the created short-clip file
shortclipList.updatedTime	Integer	Update time of the created short-clip file
shortclipList.fileSize	Integer	File size of the created short-clip
shortclipList.duration	Integer	Playback time of the created short-clip

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-20220610140221-hA6v8",
    "snapshotId": 1013,
    "shortClipList": [
      {
        "id": 1024,
        "status": "COMPLETED",
        "createdTime": 1655290646131,
        "updatedTime": 1655290650233,
        "fileSize": 12699676,
        "duration": 101184,
        "output": {
          "accessControl": "PRIVATE",
          "bucketName": "myTestBucket",
          "filePath": "/",
          "fileName": "1024-1655290646131.mp4"
        }
      },
      {
        "id": 1023,
        "status": "COMPLETED",
        "createdTime": 1655290258224,
        "updatedTime": 1655290262577,
        "fileSize": 62607,
        "duration": 1195,
        "output": {
          "accessControl": "PRIVATE",
          "bucketName": "myTestBucket",
          "filePath": "/",
          "fileName": "1023-1655290258224.mp4"
        }
      }
    ]
  },
  "total": 2
}

Was this article helpful?

What's Next

Create Live Curtain content

Table of contents

Requests
Responses
Examples