MENU
      Search image quality set list

        Search image quality set list


        Article summary

        An API to search the list of image quality sets created in Live Station.

        Requests

        GET https://livestation.apigw.ntruss.com/api/v2/qualitySets?genType={genType}&type={channelType}
        HTTP

        Request parameters

        Parameter nameRequirement statusTypeRestrictionsDescription
        genTypeNoStringSYSTEM, CUSTOMType of image quality set to search for
        typeNoStringall, default, llhls* all: Search a list of all created image quality sets
        * default: Search a list of created HLS image quality sets
        * llhls: Search a list of created LL-HLS image quality sets

        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}
        x-ncp-region_codeYESRegion code (KR)

        Responses

        Field nameTypeDescriptionRemarks
        enableHlsTimedMetadataBoolean
        timedMetadataObject
        timedMetadata.intervalInteger
        timedMetadata.keyString
        timedMetadata.headerString
        idInteger
        statusString
        genTypeString
        nameString
        createdTimeInteger
        updatedTimeInteger
        segmentDurationInteger
        segmentCountInteger
        inUseChannelNamesString[]
        isEnabledUllBooleanWhether it is a Low Latency image quality set
        targetLatencyIntegerTarget latency of the Low Latency image quality set
        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 ~ 204800000 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, 11025, 12000, 16000, 22050, 24000, 32000, 44100, 48000, 64000, 88200, 96000]
        MP3 : [8000, 11025, 12000, 16000, 22050, 24000, 32000, 44100, 48000]
        44100
        qualities[].audio.channelsIntegerAAC : 0 ~ 8
        MP3 : 0 ~ 2
        0
        qualities[].audio.bitrateInteger16 ~ 320 kbps
        qualities[].audio.bypassBooleanfalse

        Examples

        Request examples

        GET /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
        HTTP

        Response examples

        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":[
              {
                 "id":47,
                 "status":"CREATED",
                 "createdTime":1585243037000,
                 "updatedTime":1585243037000,
                 "genType":"CUSTOM",
                 "name":"myqualityset",
                 "segmentDuration":3000,
                 "segmentCount":3,
                 "qualities":[
                    {
                       "id":5,
                       "status":"CREATED",
                       "genType":"SYSTEM",
                       "name":"720p-9-16",
                       "type":"NORMAL",
                       "video":{
                          "fps":30,
                          "bitrate":2500000,
                          "bframes":0,
                          "level":-1,
                          "width":720,
                          "height":1280,
                          "bypass":false,
                          "codec":"H264",
                          "profile":"MAIN",
                          "rateControl":"VBR",
                          "videoH264ParamRefFrames":1
                       },
                       "audio":{
                          "codec":"AAC",
                          "profile":"LC",
                          "samplerate":48000,
                          "channels":0,
                          "bitrate":128,
                          "bypass":false
                       }
                    },
                    {
                       "id":4,
                       "status":"CREATED",
                       "genType":"SYSTEM",
                       "name":"720p-16-9",
                       "type":"NORMAL",
                       "video":{
                          "fps":30,
                          "bitrate":2500000,
                          "bframes":0,
                          "level":-1,
                          "width":1280,
                          "height":720,
                          "bypass":false,
                          "codec":"H264",
                          "profile":"MAIN",
                          "rateControl":"VBR",
                          "videoH264ParamRefFrames":1
                       },
                       "audio":{
                          "codec":"AAC",
                          "profile":"LC",
                          "samplerate":48000,
                          "channels":0,
                          "bitrate":128,
                          "bypass":false
                       }
                    }
                 ],
                 "inUseChannelNames":[  ],
                 "enableHlsTimedMetadata":true,
                 "timeMetadata":{
                    "interval":1000,
                    "key":"utc",
                    "header":"ncloud.livestation.metadata"
                 }
              }
           ],
           "total":1
        }
        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.