Search image quality set list

Article summary

Did you find this summary helpful?

Thank you for your feedback

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}

Request parameters

Parameter name	Requirement status	Type	Restrictions	Description
genType	No	String	SYSTEM, CUSTOM	Type of image quality set to search for
type	No	String	all, 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 name	Requirement status	Description
x-ncp-apigw-timestamp	YES	It 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-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}`
x-ncp-region_code	YES	Region code (KR)

Responses

Field name	Type	Description	Remarks
enableHlsTimedMetadata	Boolean
timedMetadata	Object
timedMetadata.interval	Integer
timedMetadata.key	String
timedMetadata.header	String
id	Integer
status	String
genType	String
name	String
createdTime	Integer
updatedTime	Integer
segmentDuration	Integer
segmentCount	Integer
inUseChannelNames	String[]
isEnabledUll	Boolean	Whether it is a Low Latency image quality set
targetLatency	Integer	Target latency of the Low Latency image quality set
qualities[]	Object[]
qualities[].id	Integer
qualities[].name	String		Image quality profile name
qualities[].type	String	AUDIO, NORMAL
qualities[].genType	String	CUSTOM,SYSTEM
qualities[].status	String
qualities[].video	Object		if type = AUDIO, video Object doesn not need.
qualities[].video.fps	Integer	1 ~ 60 fps
qualities[].video.birate	Integer	1 ~ 204800000 bps
qualities[].video.bframes	Integer	An integer between 0 and 4
qualities[].video.level	Integer	-1
qualities[].video.width	Integer	16 ~ 4096
qualities[].video.height	Integer	16 ~ 4096
qualities[].video.bypass	Boolean
qualities[].video.orientation	String	FIX, FREE	FIX
qualities[].video.keepRatio	Boolean
qualities[].video.codec	String	H264
qualities[].video.profile	String	BASELINE, MAIN, HIGH
qualities[].video.rateControl	Integer	VBR,CBR	VBR
qualities[].video.videoH264ParamRefFrames	Integer	1	1
qualities[].audio	Object
qualities[].audio.codec	String	AAC, MP3	AAC
qualities[].audio.profile	String	LC	LC
qualities[].audio.samplerate	Integer	AAC : [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.channels	Integer	AAC : 0 ~ 8 MP3 : 0 ~ 2	0
qualities[].audio.bitrate	Integer	16 ~ 320 kbps
qualities[].audio.bypass	Boolean		false

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

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
}

Was this article helpful?

What's Next

Change image quality set settings

Table of contents

Requests
Responses
Examples