Change image quality set settings

English

Change image quality set settings

Article summary

Did you find this summary helpful?

Thank you for your feedback

An API to change the settings of the created image quality set. Only the segmentCount and segmentDuration properties can be edited while setting of the image quality set.

Precautions for changing the image quality set settings

You can only change the HLS image quality set, and the low latency image quality set does not support the changing of settings.

Requests

PUT https://livestation.apigw.ntruss.com/api/v2/qualitySets/{qualitySetId}

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}`
Content-Type	YES	Specify the request body content type as application/json `Content-Type: application/json`
x-ncp-region_code	YES	Region code (KR)

Request bodies

Field name	Requirement status	Type	Restrictions	Description
segmentCount	Yes	Integer	1 ~ 10
segmentDuration	Yes	Integer	1000 ~ 10,000

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[]
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 ~ 204,800,000 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, 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.channels	Integer	AAC : 0 ~ 8 MP3 : 0 ~ 2	0
qualities[].audio.bitrate	Integer	16 ~ 320 kbps
qualities[].audio.bypass	Boolean		false

Examples

Request examples

PUT /api/v2/qualitySets/68
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

{  
   "segmentCount":3,
   "segmentDuration":3000
}

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":68,
      "status":"CREATED",
      "createdTime":1585243037000,
      "upatedTime": 1935245457000,
      "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,
      "timedMetadata":{
         "interval":1000,
         "key":"utc",
         "header":"ncloud.livestation.metadata"
      }
   }
}

Was this article helpful?

What's Next

Start recording

Table of contents

Requests
Responses
Examples