MENU
      Create image quality set

        Create image quality set


        Article summary

        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.

        Caution
        • The low latency quality set is being provided as a beta service.
        • You can play with low-latency image quality during the beta period stably using NAVER Cloud's Video Player Enhancement only.

        Requests

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

        Request headers

        Header nameRequirement statusDescription
        x-ncp-apigw-timestampYESIt indicates the time elapsed since January 1, 1970 00:00:00 UTC in milliseconds, and if the time difference compared to the server is more than 5 minutes, then the request is considered invalid
        x-ncp-apigw-timestamp:{Timestamp}
        x-ncp-iam-access-keyYESValue of access key ID issued in the NAVER Cloud Platform portal
        x-ncp-iam-access-key:{Sub Account Access Key}
        x-ncp-apigw-signature-v2YESSignature encrypted with the access key ID value and secret key
        x-ncp-apigw-signature-v2:{API Gateway Signature}
        Content-TypeYESSpecify the request body content type as application/json
        Content-Type: application/json
        x-ncp-region_codeYESRegion code (KR)

        Request bodies

        Field nameRequirement statusTypeRestrictionsDescription
        nameYesStringYou can enter 3 to 20 characters in numbers and English for the image quality name.
        Hypens (-) allowed.
        qualityIdsYesInteger[]1 to 4 for the number of image quality configuration
        segmentCountNoInteger1 ~ 10If protolType is ll-hls or dash, the option should be ignored.
        isEnabledUllYesBooleanTrue if creating an image quality set for low latency
        segmentDurationNoInteger1000 ~ 10,000Set segment duration length of HLS protocol (in milliseconds.)
        If protolType is ll-hls or dash, the option should be ignored.
        enableHlsTimedMetadataYesBoolean
        timedMetadataNoObject
        timedMetadata.headerNoString
        timedMetadata.intervalNoInteger
        timedMetadata.keyNoString

        Responses

        Field nameTypeDescriptionRemarks
        enableHlsTimedMetadataBoolean
        timedMetadataObject
        timedMetadata.intervalInteger
        timedMetadata.keyString
        timedMetadata.headerString
        idInteger
        statusString
        genTypeString
        nameString
        createdTimeInteger
        segmentDurationInteger
        segmentCountInteger
        isEnabledUllBooleanWhether it is a Low Latency image quality set
        targetLatencyIntegerTarget latency of the Low Latency image quality set
        qualityIds[]Integer[]
        qualities[]Object[]
        qualities[].idInteger
        qualities[].nameStringImage quality profile name
        qualities[].typeStringAUDIO, NORMAL
        qualities[].genTypeStringCUSTOM,SYSTEM
        qualities[].statusString
        qualities[].videoObjectif type = AUDIO, video Object doesn not need.
        qualities[].video.fpsInteger1 ~ 60 fps
        qualities[].video.birateInteger1 ~ 204,800,000 bps
        qualities[].video.bframesIntegerAn integer between 0 and 4
        qualities[].video.levelInteger-1
        qualities[].video.widthInteger16 ~ 4096
        qualities[].video.heightInteger16 ~ 4096
        qualities[].video.bypassBoolean
        qualities[].video.orientationStringFIX, FREEFIX
        qualities[].video.keepRatioBoolean
        qualities[].video.codecStringH264
        qualities[].video.profileStringBASELINE, MAIN, HIGH
        qualities[].video.rateControlIntegerVBR,CBRVBR
        qualities[].video.videoH264ParamRefFramesInteger11
        qualities[].audioObject
        qualities[].audio.codecStringAAC, MP3AAC
        qualities[].audio.profileStringLCLC
        qualities[].audio.samplerateIntegerAAC : [8000, 11,025, 12,000, 16,000, 22,050, 24,000, 32,000, 44,100, 48,000, 64,000, 88,200, 96,000]
        MP3 : [8000, 11,025, 12,000, 16,000, 22,050, 24,000, 32,000, 44,100, 48,000]
        44,100
        qualities[].audio.channelsIntegerAAC : 0 ~ 8
        MP3 : 0 ~ 2
        0
        qualities[].audio.bitrateInteger16 ~ 320 bps
        qualities[].audio.bypassBooleanfalse

        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"
           }
        }
        HTTP

        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"
          }
        }
        HTTP

        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"
        }
        HTTP

        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
            }
          }
        }
        HTTP

        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.