Delete encoding option

Prev Next

Available in Classic and VPC

Delete an encoding option set by the user.

Note

The default encoding options or the encoding options in use in a category cannot be deleted.

Request

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

Method URI
DELETE /api/v2/encodingOption/{encodingOptionId}

Request headers

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

Request path parameters

You can use the following path parameters with your request:

Field Type Required Description
encodingOptionId String Required Encoding option ID

Request example

The request example is as follows:

curl --location --request DELETE 'https://vodstation.apigw.ntruss.com/api/v2/encodingOption/1111' \
--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 Object - Response result
content.disabled Boolean - Whether Sub Account is disabled
  • true | false
    • true: Disabled
    • false: Enabled
content.id Integer - Encoding option ID
content.encodingOptionType String - Encoding option type
  • NORMAL | AUDIO
    • NORMAL: Video encoding option
    • AUDIO: Audio encoding option
content.name String - Encoding option name
content.format String - Converted media file's container format
content.video Object - Video encoding option information
content.video.codec String - Video codec format
content.video.codecOptions Object - Video codec detailed option information
content.video.codecOptions.profile String - Video codec profile
content.video.codecOptions.level String - Video codec level
content.video.bitrate Integer - Video stream's bitrate (Kbps)
content.video.width Integer - Output video width (pixel)
content.video.height Integer - Output video height (pixel)
content.video.framerate Double - Number of frames per second (fps)
content.video.maxFramerate Double - Maximum number of frames per second (fps)
content.video.keyframeInterval Double - Interval of key frames created in video (second)
content.video.rateControl String - Bitrate distribution method
  • AUTO | ABR | CRF | CBR
    • AUTO: Automatic
    • ABR: Average bitrate
    • CRF: Constant rate factor
    • CBR: Constant bitrate
content.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
content.audio Object - Audio encoding option information
content.audio.codec String - Audio codec format
content.audio.bitrate Integer - Audio stream's bitrate (Kbps)
content.audio.channel Integer - Channel count settings for output audio
  • AUTO | 1 | 2
    • AUTO: Automatic
    • 1: Mono
    • 2: Stereo
content.audio.samplingRate Double - Output audio sampling rate (Hz)
defaultSet Boolean - Whether to set default encoding options
  • true | false
    • true: System provided
    • false: User created
content.regionNo String - Region number
  • 1 (valid value)
    • 1: Korea Region
content.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": 1111,
        "encodingOptionType": "NORMAL",
        "name": "vodstation_uhd",
        "format": "MP4",
        "video": {
            "codec": "AVC",
            "codecOptions": {
                "profile": "HIGH",
                "level": "5.1"
            },
            "bitrate": 18000,
            "width": 3840,
            "height": 2160,
            "framerate": -2.0,
            "maxFramerate": 30.0,
            "keyframeInterval": 2.0,
            "rateControl": "ABR",
            "pass": "1-Pass"
        },
        "audio": {
            "codec": "AAC",
            "bitrate": 192,
            "channel": 2,
            "samplingRate": 48000.0
        },
        "defaultSet": false,
        "regionNo": "1",
        "memberNo": 2*****2
    }
}