Search information of encoding options

Article summary

Did you find this summary helpful?

Thank you for your feedback

VOD Station provides an API to search encoding option details.

Requests

GET https://vodstation.apigw.ntruss.com/api/v2/encoding-option/{encodingOptionId}

Request headers

Header name	Description
x-ncp-apigw-timestamp	This is the number of milliseconds that have elapsed since January 1, 1970 00:00:00 UTC. If the time difference compared to the API Gateway server is more than 5 minutes, then the request is considered invalid. `x-ncp-apigw-timestamp:{Timestamp}`
x-ncp-iam-access-key	Access key ID value issued by the NAVER Cloud Platform portal `x-ncp-iam-access-key:{Sub Account Access Key}`
x-ncp-apigw-signature-v2	Signature encrypted with the Access Key ID value and Secret Key `x-ncp-apigw-signature-v2:{API Gateway Signature}`

Responses

Field name	Type	Description
error	Object	Responds when a request fails Error response code and message
error.code	Integer	Error response code
error.message	String	Error response message
content	Object	VOD Station OPEN API response object
content.disabled	Boolean	Filed provided to sub accounts Resource activation status for the Sub Account
content.id	String	Encoding option ID
content.name	String	Encoding option name
content.format	String	Converted media file's container format
content.encodingOptionType	String	Encoding option type
content.audio	Object	Object for setting transcoding audio option
content.audio.codec	String	Audio codec settings
content.audio.channel	Integer	Output audio's channel settings
content.audio.bitrate	Integer	Bit transfer rate settings of the video stream subject for transcoding (unit: Kbps)
content.audio.samplingRate	Integer	Output audio sampling rate (unit: Hz)
content.video	Object	Object for setting transcoding video option
content.video.codec	String	Video codec settings
content.video.codecOptions	Object	Object for setting video codec detailed options
content.video.codecOptions.profile	String	Configured video codec profile
content.video.codecOptions.level	String	Configured video codec level
content.video.bitrate	Integer	Video stream's bit transfer rate (unit: Kbps)
content.video.width	Integer	Output video’s width
content.video.height	Integer	Output video’s height
content.video.framerate	Double	Number of frames per second
content.video.keyframeInterval	Integer	Interval at which key frames are created in the video (unit: seconds)
content.video.rateControl	String	Bitrate distribution method
content.defaultSet	Boolean	Whether there's a preset provided by system

Examples

Request examples

GET https://vodstation.apigw.ntruss.com/api/v2/encoding-option/10058

GET /api/v2/encoding-option/10058
HOST: vodstation.apigw.ntruss.com
x-ncp-apigw-timestamp:1521787414578
x-ncp-iam-access-key:6uxz1nKkcYwUjWRG5Q1V7NsW0i5jErlu2NjBXXgy
x-ncp-apigw-signature-v2:iJFK773KH0WwQ79PasqJ+ZGixtpDQ/abS57WGQdld2M=

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": {
    "disabled": false,
    "id": 10058,
    "encodingOptionType": "NORMAL",
    "name": "basic-enc-option",
    "format": "MP4",
    "video": {
      "codec": "AVC",
      "codecOptions": {
        "profile": "MAIN",
        "level": "3.1"
      },
      "bitrate": 5000,
      "width": 1920,
      "height": 1080,
      "framerate": 30,
      "maxFramerate": 30,
      "keyframeInterval": 2,
      "rateControl": "ABR",
      "pass": "1-Pass"
    },
    "audio": {
      "codec": "AAC",
      "bitrate": 192,
      "channel": 2,
      "samplingRate": 44100
    }
  }
}

Was this article helpful?

What's Next

Search list of encoding options

Table of contents

Requests
Responses
Examples