Start Live Curtain
  • PDF

Start Live Curtain

  • PDF

The latest service changes have not yet been reflected in this content. We will update the content as soon as possible. Please refer to the Korean version for information on the latest updates.

An API for running Live Curtain in Live Station. Provides the Live Curtain content list search API for searching the created Live Curtain content list.

Note
  • Live Curtain
    • You can utilize the Live Curtain feature at any time with the Live Curtain content you create.
    • It switches to the requested Live Curtain as soon as the Live Curtain starts.
    • The input time (Live Curtain hold time) allows you to set the time to hold the Live Curtain.
      • If you do not enter the Live Curtain hold time, the Live Curtain feature is maintained for 3 minutes by default.
    • Depending on the input time, after the Live Curtain hold time has elapsed, it switches to the existing transmission video.
Caution
  • Precautions for requesting Live Curtain
    • To use Live Curtain, you must create Live Curtain content.
      • The Live Curtain feature can only be used on channels that are being transmitted.
      • When utilizing multiple Live Curtain content mp4s, you can only request mp4s with the same resolution.
      • You can use the Live Curtain feature only on channels that satisfy the conditions below.
        • Channel: general channel (supports HLS channels only)
          • V2L channels, Re-Stream channels, and LL-HLS channels are not supported
        • Set image quality: Set image quality without bypass (passthrough), audio only image quality
      • When requesting to end recording while Live Curtain is running, the running Live Curtain will be stopped. (Switch to the existing transmission video)
      • The HLS url exposure reflection time of the Live Curtain content after the Live Curtain request is proportional to the ts duration X ts count time.
        • <Example> If ts duration is 2 seconds and ts count is 3, you can check it through HLS url after about 7-8 seconds after requesting the Live Curtain

Requests

POST https://livestation.apigw.ntruss.com/api/v2/channels/{channelId}/curtain/insert

Request headers

Header name Requirement status Description
x-ncp-apigw-timestamp YES - This is the number of milliseconds that have elapsed since January 1, 1970 00:00:00.
- 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 YES Value of access key ID issued in the 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 Specify the request body content type as application/json
Content-Type: application/json
x-ncp-region_code YES Region code (KR)

Request bodies

Field name Requirement status Type Restrictions Description
contentId Yes Array The Live Curtain content ID of the Live Curtain that will be running
insertTime No Integer 1,2,3,4,5,6,7,8,9,10 How long to keep the Live Curtain feature (unit: minute(s))
If insertTime is not entered, it defaults to 3 minutes

Responses

Field name Requirement status Type Restrictions Description
content Yes Object Live Curtain object
content.content Yes Object Live Curtain content object
content.content.ids Yes Integer Live Curtain content ID
content.content.insertTime Yes Integer How long to keep the Live Curtain feature (unit: minute(s))
content.content.responseTime Yes Timestamp Response time for the Live Curtain run request
content.channelId Yes String Channel ID for running Live Curtain
content.isLiveCurtain Yes Boolean Whether Live Curtain is running

Examples

Response examples

HTTP/1.1 200 OK
Server: nginx
Date: Fri, 19 Jul 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": {
    "content": {
      "ids": [
        1162
      ],
      "insertTime": 10,
      "responseTime": 1658229073776
    },
    "channelId": "ls-20220623115623-fHnXy",
    "isLiveCurtain": true
  }
}


Was this article helpful?

Changing your password will log you out immediately. Use the new password to log back in.
First name must have atleast 2 characters. Numbers and special characters are not allowed.
Last name must have atleast 1 characters. Numbers and special characters are not allowed.
Enter a valid email
Enter a valid password
Your profile has been successfully updated.