Available in Classic and VPC
Get the complete list of image quality settings list (system, custom).
Request
This section describes the request format. The method and URI are as follows:
Method | URI |
---|---|
GET | /api/v2/qualitySets |
Request headers
For information about the headers common to all Live Station APIs, see Live Station request headers.
Request query parameters
You can use the following query parameters with your request:
Field | Type | Required | Description |
---|---|---|---|
genType |
String | Optional | Filter by settings classification.
|
type |
String | Optional | Filter by image quality setting type
|
Request example
The request example is as follows:
curl --location --request GET 'https://livestation.apigw.ntruss.com/api/v2/qualitySets?genType=CUSTOM&type=llhls' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
--header 'Content-Type: application/json' \
--header 'x-ncp-region_code: KR'
Response
This section describes the response format.
Response body
The response body includes the following data:
Field | Type | Required | Description |
---|---|---|---|
content |
Array | - | Image quality settings list: content |
total |
Integer | - | Total response count |
content
The following describes content
.
Field | Type | Required | Description |
---|---|---|---|
disabled |
Boolean | - | Whether image quality is disabled
|
id |
Integer | - | Image quality setting ID |
status |
String | - | Image quality setting status
|
createdTime |
Integer | - | Image quality setting creation date and time (millisecond)
|
genType |
String | - | Settings classification
|
name |
String | - | Image quality setting name |
segmentDuration |
Integer | - | Playback time per segment (millisecond)
|
segmentCount |
Integer | - | Number of segments
|
qualities |
Array | - | Image quality list: qualities |
inUseChannelNames |
Array | - | List of channels in use
|
enableHlsTimedMetadata |
Boolean | - | Whether to set time-based metadata
|
isEnabledUll |
Boolean | - | Low latency settings
|
targetLatency |
Integer | - | Low latency target latency (second)
|
timedMetadata |
Object | - | Time-based metadata settings
|
timedMetadata.key |
String | - | Key
|
timedMetadata.header |
String | - | Header (identification value) |
timedMetadata.interval |
Integer | - | Insertion interval (millisecond)
|
qualities
The following describes qualities
.
Field | Type | Required | Description |
---|---|---|---|
disabled |
Boolean | - | Whether image quality is disabled
|
id |
Integer | - | Image quality ID |
status |
String | - | Image quality status
|
createdTime |
Integer | - | Image quality creation date and time (millisecond)
|
genType |
String | - | Settings classification
|
name |
String | - | Image quality name |
type |
String | - | Image quality type
|
video |
Object | - | Video settings information
|
video.fps |
Float | - | Number of frames per second (fps) |
video.bitrate |
Integer | - | Video stream's bitrate (bps) |
video.bframes |
Integer | - | Number of B-frames (bidirectional prediction frames) |
video.level |
Integer | - | Video codec level
|
video.width |
Integer | - | Output video width (pixel) |
video.height |
Integer | - | Output video height (pixel) |
video.bypass |
Boolean | - | Whether to bypass the video stream
|
video.codec |
String | - | Video codec format
|
video.orientation |
String | - | Video orientation settings
|
video.profile |
String | - | Video codec profile
|
video.rateControl |
String | - | Bitrate distribution method
|
video.videoH264ParamRefFrames |
Integer | - | H.264 reference frame count
|
audio |
Object | - | Audio settings information |
audio.codec |
String | - | Audio codec format
|
audio.profile |
String | - | Audio codec profile
|
audio.samplerate |
Integer | - | Audio sampling rate (Hz)
|
audio.channels |
Integer | - | Number of audio channels |
audio.bitrate |
Integer | - | Audio stream's bitrate (Kbps) |
audio.bypass |
Boolean | - | Whether to bypass the audio stream
|
Response status codes
For information about the HTTP status codes common to all Live Station APIs, see Live Station response status codes.
Response example
The response example is as follows:
{
"content": [
{
"disabled": false,
"id": ****,
"status": "CREATED",
"createdTime": 1755151055000,
"genType": "CUSTOM",
"name": "setting012",
"qualities": [
{
"disabled": false,
"id": 5,
"status": "CREATED",
"createdTime": 1546300800000,
"genType": "SYSTEM",
"name": "720p-9-16",
"type": "NORMAL",
"video": {
"fps": 30.0,
"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
}
},
{
"disabled": false,
"id": ****,
"status": "CREATED",
"createdTime": 1755134604000,
"genType": "CUSTOM",
"name": "quality000",
"type": "NORMAL",
"video": {
"fps": 60.0,
"bitrate": 204800000,
"bframes": 4,
"level": -1,
"width": 1920,
"height": 1080,
"bypass": true,
"codec": "H264",
"profile": "HIGH",
"rateControl": "VBR",
"videoH264ParamRefFrames": 1
},
"audio": {
"codec": "AAC",
"profile": "LC",
"samplerate": 44100,
"channels": 2,
"bitrate": 320,
"bypass": true
}
}
],
"inUseChannelNames": [],
"enableHlsTimedMetadata": true,
"isEnabledUll": true,
"targetLatency": 3,
"timedMetadata": {
"key": "utc",
"header": "a",
"interval": 1000
}
}
],
"total": 1
}