Start Live Curtain

Prev Next

An API to run Live Curtain in Live Station. Provides the Live Curtain content list view API to view the created Live Curtain content list.

Caution
  • Cautions 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 streamed.
      • 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 following conditions.
        • Channel: general channel (supports HLS channels only)
          • V2L channel, Re-Stream channel 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 streaming 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 the HLS url after about 7-8 seconds after requesting the Live Curtain
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 streaming video.

Requests

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

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)

Request bodies

Field name Required Type Service limits 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 Time to maintain Live Curtain function (unit: minute)
- If insertTime is not entered, it defaults to 3 minutes

Responses

Field name Type Description Note
content Object Live Curtain object
content.content Object Live Curtain content object
content.content.ids Integer Live Curtain content ID
content.content.insertTime Integer Time to maintain Live Curtain function (unit: minute)
content.content.responseTime Timestamp Response time for the Live Curtain run request
content.channelId String Channel ID for running Live Curtain
content.isLiveCurtain 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
  }
}