Available in Classic and VPC
If you need a separate image quality other than system qualities, create a custom image quality by defining the desired image quality.
Request
This section describes the request format. The method and URI are as follows:
Method | URI |
---|---|
POST | /api/v2/qualityProfiles |
Request headers
For information about the headers common to all Live Station APIs, see Live Station request headers.
Request body
You can include the following data in the body of your request:
Field | Type | Required | Description |
---|---|---|---|
name |
String | Required | Image quality name
|
type |
String | Required | Image quality type
|
video |
Object | Conditional | Video settings information
|
video.codec |
String | Conditional | Video codec format
|
video.profile |
String | Conditional | Video codec profile
|
video.level |
Integer | Conditional | Video codec level
|
video.width |
Integer | Conditional | Output video width (pixel)
|
video.height |
Integer | Conditional | Output video height (pixel)
|
video.fps |
Float | Conditional | Number of frames per second (fps)
|
video.bitrate |
Integer | Conditional | Video stream's bitrate (bps)
|
video.videoH264ParamRefFrames |
Integer | Optional | H.264 reference frame count
|
video.rateControl |
String | Optional | Bitrate distribution method
|
video.bframes |
Integer | Optional | Number of B-frames (bidirectional prediction frames)
|
video.bypass |
Boolean | Optional | Whether to bypass the video stream
|
video.orientation |
String | Optional | Video orientation settings
|
audio |
Object | Required | Audio settings information |
audio.codec |
String | Required | Audio codec format
|
audio.profile |
String | Conditional | Audio codec profile
|
audio.samplerate |
Integer | Required | Audio sampling rate (Hz)
|
audio.channels |
Integer | Required | Number of audio channels
|
audio.bitrate |
Integer | Required | Audio stream's bitrate (Kbps)
|
audio.bypass |
Boolean | Optional | Whether to bypass the audio stream
|
Request example
The request example is as follows:
curl --location --request POST 'https://livestation.apigw.ntruss.com/api/v2/qualityProfiles' \
--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' \
--data '{
"name": "quality000",
"type": "NORMAL",
"video": {
"codec": "H264",
"profile": "HIGH",
"level": -1,
"width": 1920,
"height": 1080,
"fps": 60,
"bitrate": 204800000,
"videoH264ParamRefFrames": 1,
"rateControl": "VBR",
"bframes": 4,
"bypass": false
},
"audio": {
"codec": "AAC",
"profile": "LC",
"samplerate": 44100,
"channels": 2,
"bitrate": 320,
"bypass": false
}
}'
Response
This section describes the response format.
Response body
The response body includes the following data:
Field | Type | Required | Description |
---|---|---|---|
content |
Object | - | Response result |
content.disabled |
Boolean | - | Whether image quality is disabled
|
content.id |
Integer | - | Image quality ID |
content.status |
String | - | Image quality status
|
content.createdTime |
Integer | - | Image quality creation date and time (millisecond)
|
content.genType |
String | - | Settings type
|
content.name |
String | - | Image quality name |
content.type |
String | - | Image quality type
|
content.video |
Object | - | Video settings information
|
content.video.fps |
Float | - | Number of frames per second (fps) |
content.video.bitrate |
Integer | - | Video stream's bitrate (bps) |
content.video.bframes |
Integer | - | Number of B-frames (bidirectional prediction frames) |
content.video.level |
Integer | - | Video codec level
|
content.video.width |
Integer | - | Output video width (pixel) |
content.video.height |
Integer | - | Output video height (pixel) |
content.video.bypass |
Boolean | - | Whether to bypass the video stream
|
content.video.codec |
String | - | Video codec format
|
content.video.orientation |
String | - | Video orientation settings
|
content.video.profile |
String | - | Video codec profile
|
content.video.rateControl |
String | - | Bitrate distribution method
|
content.video.videoH264ParamRefFrames |
Integer | - | H.264 reference frame count
|
content.audio |
Object | - | Audio settings information |
content.audio.codec |
String | - | Audio codec format
|
content.audio.profile |
String | - | Audio codec profile
|
content.audio.samplerate |
Integer | - | Audio sampling rate (Hz)
|
content.audio.channels |
Integer | - | Number of audio channels |
content.audio.bitrate |
Integer | - | Audio stream's bitrate (Kbps) |
content.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": 1755134603531,
"genType": "CUSTOM",
"name": "quality000",
"type": "NORMAL",
"video": {
"fps": 60.0,
"bitrate": 204800000,
"bframes": 4,
"level": -1,
"width": 1920,
"height": 1080,
"bypass": false,
"codec": "H264",
"profile": "HIGH",
"rateControl": "VBR",
"videoH264ParamRefFrames": 1
},
"audio": {
"codec": "AAC",
"profile": "LC",
"samplerate": 44100,
"channels": 2,
"bitrate": 320,
"bypass": false
}
}
}