Create image quality set

An API to create image quality sets for use in Live Station. Image quality set list search API and Image quality set information search API are provided to search the created image quality sets.

Requests

POST https://livestation.apigw.ntruss.com/api/v2/qualitySets

Request headers

Request bodies

Responses

Examples

Request examples

Create an image quality set for HLS

POST /api/v2/qualitySets
HOST: livestation.apigw.ntruss.com
Content-Type: application/json
x-ncp-apigw-timestamp:1521787414578
x-ncp-iam-access-key:6uxz1nKkcYwUjWRG5Q1V7NsW0i5jErlu2NjBXXgy
x-ncp-apigw-signature-v2:iJFK773KH0WwQ79PasqJ+ZGixtpDQ/abS57WGQdld2M=
x-ncp-region_code:KR

{  
   "enableHlsTimedMetadata":true,
   "name":"myqualityset",
   "qualityIds":[
      4,
      5
   ],
   "segmentCount":3,
   "segmentDuration":3000,
   "timedMetadata":{
      "header":"ncloud.livestation.metadata",
      "interval":1000,
      "key":"utc"
   }
}

Create an image quality set for low latency

POST /api/v2/qualitySets
HOST: livestation.apigw.ntruss.com
Content-Type: application/json
x-ncp-apigw-timestamp:1521787414578
x-ncp-iam-access-key:6uxz1nKkcYwUjWRG5Q1V7NsW0i5jErlu2NjBXXgy
x-ncp-apigw-signature-v2:iJFK773KH0WwQ79PasqJ+ZGixtpDQ/abS57WGQdld2M=
x-ncp-region_code:KR
{
  "enableHlsTimedMetadata": true,
  "isEnabledUll": true,
  "name": "myqualityset",
  "qualityIds": [
    1,2
  ],
  "timedMetadata": {
    "header": "ncloud.livestation.metadata",
    "interval": 1000,
    "key": "utc"
  }
}

Response examples

Response to create an image quality set for HLS

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

{
    "content": {
        "createdTime": 1585656720798,
        "enableHlsTimedMetadata": true,
        "genType": "CUSTOM",
        "id": 23,
        "name": "testquality-api",
        "qualities": [
            {
                "audio": {
                    "bypass": false,
                    "bitrate": 128,
                    "channels": 0,
                    "codec": "AAC",
                    "profile": "LC",
                    "samplerate": 48000
                },
                "genType": "SYSTEM",
                "id": 4,
                "name": "720p-16-9",
                "status": "CREATED",
                "type": "NORMAL",
                "video": {
                    "bypass": false,
                    "bframes": 0,
                    "bitrate": 2500000,
                    "codec": "H264",
                    "fps": 30.0,
                    "height": 720,
                    "level": -1,
                    "profile": "MAIN",
                    "rateControl": "VBR",
                    "videoH264ParamRefFrames": 1,
                    "width": 1280
                }
            },
            {
                "audio": {
                    "bypass": false,
                    "bitrate": 128,
                    "channels": 0,
                    "codec": "AAC",
                    "profile": "LC",
                    "samplerate": 48000
                },
                "genType": "SYSTEM",
                "id": 5,
                "name": "720p-9-16",
                "status": "CREATED",
                "type": "NORMAL",
                "video": {
                    "bypass": false,
                    "bframes": 0,
                    "bitrate": 2500000,
                    "codec": "H264",
                    "fps": 30.0,
                    "height": 1280,
                    "level": -1,
                    "profile": "MAIN",
                    "rateControl": "VBR",
                    "videoH264ParamRefFrames": 1,
                    "width": 720
                }
            }
        ],
        "qualityIds": [
            4,
            5
        ],
        "segmentCount": 3,
        "segmentDuration": 3000,
        "status": "CREATED",
        "timedMetadata": {
            "header": "ncloud.livestation.metadata",
            "interval": 1000,
            "key": "utc"
        }
    },
    "result": "success"
}

Response to create an image quality set for low latency

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

{
  "content": {
    "disabled": false,
    "id": 246,
    "status": "CREATED",
    "createdTime": 1666009295544,
    "genType": "CUSTOM",
    "name": "testquality-llhls",
    "qualityIds": [
      1,
      2
    ],
    "qualities": [
      {
        "disabled": false,
        "id": 1,
        "status": "CREATED",
        "createdTime": 1546300800000,
        "genType": "SYSTEM",
        "name": "bypass",
        "type": "BYPASS",
        "video": {},
        "audio": {
          "bypass": true
        }
      },
      {
        "disabled": false,
        "id": 2,
        "status": "CREATED",
        "createdTime": 1546300800000,
        "genType": "SYSTEM",
        "name": "1080p-16-9",
        "type": "NORMAL",
        "video": {
          "fps": 30,
          "bitrate": 5000000,
          "bframes": 0,
          "level": -1,
          "width": 1920,
          "height": 1080,
          "bypass": false,
          "codec": "H264",
          "profile": "HIGH",
          "rateControl": "VBR",
          "videoH264ParamRefFrames": 1
        },
        "audio": {
          "codec": "AAC",
          "profile": "LC",
          "samplerate": 48000,
          "channels": 0,
          "bitrate": 192,
          "bypass": false
        }
      }
    ],
    "enableHlsTimedMetadata": true,
    "isEnabledUll": true,
    "targetLatency": 3,
    "timedMetadata": {
      "key": "utc",
      "header": "ncloud.livestation.metadata",
      "interval": 1000
    }
  }
}