Get encoding option list

Available in Classic and VPC

Get the list of encoding options.

Request

This section describes the request format. The method and URI are as follows:

Method	URI
GET	/api/v2/encoding-option

Request headers

For information about the headers common to all VOD Station APIs, see VOD Station request headers.

Request example

The request example is as follows:

curl --location --request GET 'https://vodstation.apigw.ntruss.com/api/v2/encoding-option' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'

Response

This section describes the response format.

Response body

The response body includes the following data:

Field	Type	Required	Description
`content`	Array	-	Encoding option list: content
`total`	Integer	-	Total response count

`content`

The following describes content.

Field	Type	Required	Description
`disabled`	Boolean	-	Whether Sub Account is disabled `true` \| `false` `true`: Disabled `false`: Enabled
`id`	Integer	-	Encoding option ID
`encodingOptionType`	String	-	Encoding option type `NORMAL` \| `AUDIO` `NORMAL`: Video encoding option `AUDIO`: Audio encoding option
`name`	String	-	Encoding option name
`format`	String	-	Converted media file's container format
`video`	Object	-	Video encoding option information
`video.codec`	String	-	Video codec format
`video.codecOptions`	Object	-	Video codec detailed option information
`video.codecOptions.profile`	String	-	Video codec profile
`video.codecOptions.level`	String	-	Video codec level
`video.bitrate`	Integer	-	Video stream's bitrate (Kbps)
`video.width`	Integer	-	Output video width (pixel)
`video.height`	Integer	-	Output video height (pixel)
`video.framerate`	Double	-	Number of frames per second (fps)
`video.maxFramerate`	Double	-	Maximum number of frames per second (fps)
`video.keyframeInterval`	Double	-	Interval of key frames created in video (second)
`video.rateControl`	String	-	Bitrate distribution method `AUTO` \| `ABR` \| `CRF` \| `CBR` `AUTO`: Automatic `ABR`: Average bitrate `CRF`: Constant rate factor `CBR`: Constant bitrate
`video.pass`	String	-	Encoding pass settings when converting video `1-Pass` \| `2-Pass` `1-Pass`: Proceed with 1 encoding `2-Pass`: Proceed with 2 encodings
`audio`	Object	-	Audio encoding option information
`audio.codec`	String	-	Audio codec format
`audio.bitrate`	Integer	-	Audio stream's bitrate (Kbps)
`audio.channel`	Integer	-	Channel count settings for output audio `AUTO` \| `1` \| `2` `AUTO`: Automatic `1`: Mono `2`: Stereo
`audio.samplingRate`	Double	-	Output audio sampling rate (Hz)
`defaultSet`	Boolean	-	Whether to set default encoding options `true` \| `false` `true`: System provided `false`: User created
`memberNo`	Integer	-	Member number

Response status codes

For information about the HTTP status codes common to all VOD Station APIs, see VOD Station response status codes.

Response example

The response example is as follows:

{
    "content": [
        {
            "disabled": false,
            "id": 1,
            "encodingOptionType": "NORMAL",
            "name": "AVC_SD_1Pass_30fps",
            "format": "MP4",
            "video": {
                "codec": "AVC",
                "codecOptions": {
                    "profile": "MAIN",
                    "level": "3.1"
                },
                "bitrate": 500,
                "width": 480,
                "height": 320,
                "framerate": -2.0,
                "maxFramerate": 30.0,
                "keyframeInterval": 2.0,
                "rateControl": "ABR",
                "pass": "1-Pass"
            },
            "audio": {
                "codec": "AAC",
                "bitrate": 128,
                "channel": 2,
                "samplingRate": 44100.0
            },
            "defaultSet": true,
            "memberNo": -1
        },
        ...
        {
            "disabled": false,
            "id": 20,
            "encodingOptionType": "AUDIO",
            "name": "160kbps.m4a",
            "format": "MP4",
            "audio": {
                "codec": "AAC",
                "bitrate": 160,
                "channel": 2,
                "samplingRate": 44100.0
            },
            "defaultSet": true,
            "memberNo": -1
        }
    ],
    "total": 21
}